From df677ff8aa0041e9992fab49afd064c18db8fdf0 Mon Sep 17 00:00:00 2001 From: curt Date: Fri, 30 May 2003 16:41:36 +0000 Subject: [PATCH] Working on adding a top leve Doxygen docs introduction. --- Doxyfile | 11 +++---- DoxygenMain.cxx | 78 +++++++++++++++++++++++++++++++++++++++++++++++++ Makefile.am | 1 + 3 files changed, 85 insertions(+), 5 deletions(-) create mode 100644 DoxygenMain.cxx diff --git a/Doxyfile b/Doxyfile index 38c50741..2e2154bc 100644 --- a/Doxyfile +++ b/Doxyfile @@ -64,14 +64,14 @@ EXTRACT_STATIC = NO # various overviews, but no documentation section is generated. # This option has no effect if EXTRACT_ALL is enabled. -HIDE_UNDOC_MEMBERS = NO +HIDE_UNDOC_MEMBERS = YES # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all # undocumented classes that are normally visible in the class hierarchy. # If set to NO (the default) these class will be included in the various # overviews. This option has no effect if EXTRACT_ALL is enabled. -HIDE_UNDOC_CLASSES = NO +HIDE_UNDOC_CLASSES = YES # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will # include brief member descriptions after the members that are listed in @@ -298,6 +298,7 @@ WARN_LOGFILE = # with spaces. INPUT = \ + DoxygenMain.cxx \ simgear/bucket \ simgear/compiler.h \ simgear/constants.h \ @@ -308,11 +309,11 @@ INPUT = \ simgear/math \ simgear/misc \ simgear/route \ + simgear/scene \ simgear/screen \ simgear/serial \ simgear/sg_inlines.h \ simgear/sg_traits.hxx \ - simgear/sky \ simgear/threads \ simgear/timing \ simgear/xml @@ -334,7 +335,7 @@ RECURSIVE = YES # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. -EXCLUDE = simgear/metakit simgear/zlib +EXCLUDE = simgear/scene/sky/clouds3d # If the value of the INPUT tag contains directories, you can use the # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude @@ -480,7 +481,7 @@ ENUM_VALUES_PER_LINE = 4 # JavaScript and frames is required (for instance Netscape 4.0+ # or Internet explorer 4.0+). -GENERATE_TREEVIEW = YES +GENERATE_TREEVIEW = NO # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be # used to set the initial width (in pixels) of the frame in which the tree diff --git a/DoxygenMain.cxx b/DoxygenMain.cxx new file mode 100644 index 00000000..37540088 --- /dev/null +++ b/DoxygenMain.cxx @@ -0,0 +1,78 @@ +/* This is a dummy code file that only contains doxygen main page + documentation. It has a .cxx extension so that emacs will happily + autoindent correctly. */ + +/** \mainpage SimGear + * Simulation, Visualization, and Game development libraries. + + * \section intro Introduction + * + * SimGear is a collection of libraries which provide a variety of + * functionality useful for building simulations, visualizations, and + * even games. All the SimGear code is designed to be portable across + * a wide variety of platforms and compilers. It has primarily been + * developed in support of the FlightGear project, but as development + * moves forward, we are generalizing the code to make more of it + * useful for other types of applications. + * + * Some of the functionality provide includes + * + * - Compiler and platform abstractions for many tricky differences. + * - A whole earth tiling/indexing scheme. + * - A console debugging output scheme that tracks severity and + * category that can be completely compiled out for a final build release. + * - Code to manage "real" time and time zones. + * - Code to calculate accurate positions of sun, moon, stars, and + * planets for a given time, date, season, earth location, etc. + * - Simple serial, file, and network I/O abstractions + * - Code to calculate magnetic variation. + * - A variety of coordinate conversion, vector, matrix type math routines. + * - An abstraction to hide platform dependent path naming schemes. + * - A C++ streams wrapper to handle compress input/output streams. + * - An optimized "property manager" which associates ascii property + * names with their corresponding value. This can be a great way to build + * loose linkages between modules, or build linkages/connections that can + * be determined from config files or at runtime. + * - Scene management and drawing routines: + * - material property management + * - object management + * - terrain tile management and paging + * - sky dome rendering (with ephemeral objects) + * - Code to handle screen dumps (and ultra-hires tile rendered screen dumps) + * - A sound effects manager. + * - A threading abstraction. + * - A simple but highly functional XML parser that interfaces nicely + * with the property manager. + + * \section supports Supported Platforms + * SimGear has been built on the following platforms: + * + * - Linux (x86) + * - Windows (MSVC, Cygwin, Mingwin) + * - SGI (native compilers) + * - Mac OS X + * - FreeBSD + + * \section depends Dependencies + * + * SimGear depends on several other open source packages. These must + * be installed before SimGear can be installed: + * + * - glut and opengl + * - plib (http://plib.sf.net) + * - metakit + * - zlib + * - libjpeg (optional) + * - pthread (optional) + + * \section license Licensing + * + * SimGear is licensed under the terms of the LGPL + + * \section install Installation + * + * \subsection step1 Step 1: Opening the box + * + * etc... + */ + diff --git a/Makefile.am b/Makefile.am index 06e61ceb..ae7eb9c6 100644 --- a/Makefile.am +++ b/Makefile.am @@ -1,6 +1,7 @@ EXTRA_DIST = \ acinclude.m4 \ autogen.sh \ + DoxygenMain.cxx README.MSVC \ README.metakit \ README.zlib \ -- 2.39.5