/[escript]/trunk/esys2/doc/doxygen_esys

Diff of /trunk/esys2/doc/doxygen_esys

Parent Directory | Revision Log | View Patch Patch

-revision 82 by jgs,
Tue Oct 26 06:53:54 2004 UTC
+revision 121 by jgs,
Fri May  6 04:26:16 2005 UTC
 Line 1
- # Doxyfile 1.2.8.1
+ # Doxyfile 1.3.5
  # This file describes the settings to be used by the documentation system
  # doxygen (www.doxygen.org) for a project
 Line 11
  # Values that contain spaces should be placed between quotes (" ")
  #---------------------------------------------------------------------------
- # General configuration options
+ # Project related configuration options
  #---------------------------------------------------------------------------
  # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
 Line 23 
 PROJECT_NAME           = ESYS
  # This could be handy for archiving the generated documentation or
  # if some version control system is used.
- PROJECT_NUMBER         =
+ PROJECT_NUMBER         = dev_01
  # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
  # base path where the generated documentation will be put.
  # If a relative path is entered, it will be relative to the location
  # where doxygen was started. If left blank the current directory will be used.
- OUTPUT_DIRECTORY       =
+ OUTPUT_DIRECTORY       = esys_doc
  # The OUTPUT_LANGUAGE tag is used to specify the language in which all
  # documentation generated by doxygen is written. Doxygen will use this
  # information to generate all constant output in the proper language.
  # The default language is English, other supported languages are:
- # Brazilian, Chinese, Croatian, Czech, Danish, Dutch, Finnish, French,
+ # Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch,
- # German, Hungarian, Italian, Japanese, Korean, Norwegian, Polish,
+ # Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en
- # Portuguese, Romanian, Russian, Slovak, Slovene, Spanish and Swedish.
+ # (Japanese with English messages), Korean, Norwegian, Polish, Portuguese,
+ # Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
  OUTPUT_LANGUAGE        = English
- # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
+ # This tag can be used to specify the encoding used in the generated output.
- # documentation are documented, even if no documentation was available.
+ # The encoding is not always determined by the language that is chosen,
- # Private class members and static file members will be hidden unless
+ # but also whether or not the output is meant for Windows or non-Windows users.
- # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
+ # In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES
+ # forces the Windows encoding (this is the default for the Windows binary),
- EXTRACT_ALL            = YES
+ # whereas setting the tag to NO uses a Unix-style encoding (the default for
+ # all platforms other than Windows).
- # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
- # will be included in the documentation.
- EXTRACT_PRIVATE        = YES
- # If the EXTRACT_STATIC tag is set to YES all static members of a file
- # will be included in the documentation.
- EXTRACT_STATIC         = YES
- # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
- # undocumented members of documented classes, files or namespaces.
- # If set to NO (the default) these members will be included in the
- # various overviews, but no documentation section is generated.
- # This option has no effect if EXTRACT_ALL is enabled.
- HIDE_UNDOC_MEMBERS     = NO
- # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
+ USE_WINDOWS_ENCODING   = NO
- # 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
  # 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
-Line 88 
 BRIEF_MEMBER_DESC      = YES
+Line 67 
 BRIEF_MEMBER_DESC      = YES
  REPEAT_BRIEF           = YES
+ # This tag implements a quasi-intelligent brief description abbreviator
+ # that is used to form the text in various listings. Each string
+ # in this list, if found as the leading text of the brief description, will be
+ # stripped from the text and the result after processing the whole list, is used
+ # as the annotated text. Otherwise, the brief description is used as-is. If left
+ # blank, the following values are used ("$name" is automatically replaced with the
+ # name of the entity): "The $name class" "The $name widget" "The $name file"
+ # "is" "provides" "specifies" "contains" "represents" "a" "an" "the"
+ ABBREVIATE_BRIEF       =
  # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
  # Doxygen will generate a detailed section even if there is only a brief
  # description.
- ALWAYS_DETAILED_SEC    = NO
+ ALWAYS_DETAILED_SEC    = YES
+ # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited
+ # members of a class in the documentation of that class as if those members were
+ # ordinary class members. Constructors, destructors and assignment operators of
+ # the base classes will not be shown.
+ INLINE_INHERITED_MEMB  = NO
  # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
  # path before files name in the file list and in the header files. If set
-Line 101 
 ALWAYS_DETAILED_SEC    = NO
+Line 98 
 ALWAYS_DETAILED_SEC    = NO
  FULL_PATH_NAMES        = NO
  # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
- # can be used to strip a user defined part of the path. Stripping is
+ # can be used to strip a user-defined part of the path. Stripping is
  # only done if one of the specified strings matches the left-hand part of
  # the path. It is allowed to use relative paths in the argument list.
  STRIP_FROM_PATH        =
- # The INTERNAL_DOCS tag determines if documentation
+ # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
- # that is typed after a \internal command is included. If the tag is set
+ # (but less readable) file names. This can be useful is your file systems
- # to NO (the default) then the documentation will be excluded.
+ # doesn't support long names like on DOS, Mac, or CD-ROM.
- # Set it to YES to include the internal documentation.
- INTERNAL_DOCS          = NO
+ SHORT_NAMES            = NO
- # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
+ # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
- # generate a class diagram (in Html and LaTeX) for classes with base or
+ # will interpret the first line (until the first dot) of a JavaDoc-style
- # super classes. Setting the tag to NO turns the diagrams off.
+ # comment as the brief description. If set to NO, the JavaDoc
+ # comments will behave just like the Qt-style comments (thus requiring an
+ # explicit @brief command for a brief description.
- CLASS_DIAGRAMS         = YES
+ JAVADOC_AUTOBRIEF      = NO
- # If the SOURCE_BROWSER tag is set to YES then a list of source files will
+ # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
- # be generated. Documented entities will be cross-referenced with these sources.
+ # treat a multi-line C++ special comment block (i.e. a block of //! or ///
+ # comments) as a brief description. This used to be the default behaviour.
+ # The new default is to treat a multi-line C++ comment block as a detailed
+ # description. Set this tag to YES if you prefer the old behaviour instead.
+ MULTILINE_CPP_IS_BRIEF = NO
+ # If the DETAILS_AT_TOP tag is set to YES then Doxygen
+ # will output the detailed description near the top, like JavaDoc.
+ # If set to NO, the detailed description appears after the member
+ # documentation.
- SOURCE_BROWSER         = NO
+ DETAILS_AT_TOP         = NO
- # Setting the INLINE_SOURCES tag to YES will include the body
+ # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
- # of functions and classes directly in the documentation.
+ # member inherits the documentation from any documented member that it
+ # re-implements.
- INLINE_SOURCES         = NO
+ INHERIT_DOCS           = YES
- # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
+ # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
- # doxygen to hide any special comment blocks from generated source code
+ # tag is set to YES, then doxygen will reuse the documentation of the first
- # fragments. Normal C and C++ comments will always remain visible.
+ # member in the group (if any) for the other members of the group. By default
+ # all members of a group must be documented explicitly.
- STRIP_CODE_COMMENTS    = YES
+ DISTRIBUTE_GROUP_DOC   = NO
+ # The TAB_SIZE tag can be used to set the number of spaces in a tab.
+ # Doxygen uses this value to replace tabs by spaces in code fragments.
+ TAB_SIZE               = 4
+ # This tag can be used to specify a number of aliases that acts
+ # as commands in the documentation. An alias has the form "name=value".
+ # For example adding "sideeffect=\par Side Effects:\n" will allow you to
+ # put the command \sideeffect (or @sideeffect) in the documentation, which
+ # will result in a user-defined paragraph with heading "Side Effects:".
+ # You can put \n's in the value part of an alias to insert newlines.
+ ALIASES                =
+ # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
+ # only. Doxygen will then generate output that is more tailored for C.
+ # For instance, some of the names that are used will be different. The list
+ # of all members will be omitted, etc.
+ OPTIMIZE_OUTPUT_FOR_C  = NO
+ # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
+ # only. Doxygen will then generate output that is more tailored for Java.
+ # For instance, namespaces will be presented as packages, qualified scopes
+ # will look different, etc.
+ OPTIMIZE_OUTPUT_JAVA   = NO
+ # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
+ # the same type (for instance a group of public functions) to be put as a
+ # subgroup of that type (e.g. under the Public Functions section). Set it to
+ # NO to prevent subgrouping. Alternatively, this can be done per class using
+ # the \nosubgrouping command.
+ SUBGROUPING            = YES
+ #---------------------------------------------------------------------------
+ # Build related configuration options
+ #---------------------------------------------------------------------------
+ # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
+ # documentation are documented, even if no documentation was available.
+ # Private class members and static file members will be hidden unless
+ # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
+ EXTRACT_ALL            = YES
+ # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
+ # will be included in the documentation.
+ EXTRACT_PRIVATE        = YES
+ # If the EXTRACT_STATIC tag is set to YES all static members of a file
+ # will be included in the documentation.
+ EXTRACT_STATIC         = YES
+ # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
+ # defined locally in source files will be included in the documentation.
+ # If set to NO only classes defined in header files are included.
+ EXTRACT_LOCAL_CLASSES  = YES
+ # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
+ # undocumented members of documented classes, files or namespaces.
+ # If set to NO (the default) these members will be included in the
+ # various overviews, but no documentation section is generated.
+ # This option has no effect if EXTRACT_ALL is enabled.
+ HIDE_UNDOC_MEMBERS     = NO
+ # 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 classes will be included in the various
+ # overviews. This option has no effect if EXTRACT_ALL is enabled.
+ HIDE_UNDOC_CLASSES     = NO
+ # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
+ # friend (class|struct|union) declarations.
+ # If set to NO (the default) these declarations will be included in the
+ # documentation.
+ HIDE_FRIEND_COMPOUNDS  = NO
+ # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
+ # documentation blocks found inside the body of a function.
+ # If set to NO (the default) these blocks will be appended to the
+ # function's detailed documentation block.
+ HIDE_IN_BODY_DOCS      = NO
+ # The INTERNAL_DOCS tag determines if documentation
+ # that is typed after a \internal command is included. If the tag is set
+ # to NO (the default) then the documentation will be excluded.
+ # Set it to YES to include the internal documentation.
+ INTERNAL_DOCS          = NO
  # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
- # file names in lower case letters. If set to YES upper case letters are also
+ # file names in lower-case letters. If set to YES upper-case letters are also
  # allowed. This is useful if you have classes or files whose names only differ
  # in case and if your file system supports case sensitive file names. Windows
- # users are adviced to set this option to NO.
+ # users are advised to set this option to NO.
  CASE_SENSE_NAMES       = YES
- # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
- # (but less readable) file names. This can be useful is your file systems
- # doesn't support long names like on DOS, Mac, or CD-ROM.
- SHORT_NAMES            = NO
  # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
  # will show members with their full class and namespace scopes in the
  # documentation. If set to YES the scope will be hidden.
  HIDE_SCOPE_NAMES       = NO
- # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
- # will generate a verbatim copy of the header file for each class for
- # which an include is specified. Set to NO to disable this.
- VERBATIM_HEADERS       = YES
  # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
- # will put list of the files that are included by a file in the documentation
+ # will put a list of the files that are included by a file in the documentation
  # of that file.
  SHOW_INCLUDE_FILES     = YES
- # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
- # will interpret the first line (until the first dot) of a JavaDoc-style
- # comment as the brief description. If set to NO, the JavaDoc
- # comments  will behave just like the Qt-style comments (thus requiring an
- # explict @brief command for a brief description.
- JAVADOC_AUTOBRIEF      = NO
- # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
- # member inherits the documentation from any documented member that it
- # reimplements.
- INHERIT_DOCS           = YES
  # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
  # is inserted in the documentation for inline members.
-Line 194 
 INLINE_INFO            = YES
+Line 277 
 INLINE_INFO            = YES
  SORT_MEMBER_DOCS       = YES
- # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
- # tag is set to YES, then doxygen will reuse the documentation of the first
- # member in the group (if any) for the other members of the group. By default
- # all members of a group must be documented explicitly.
- DISTRIBUTE_GROUP_DOC   = NO
- # The TAB_SIZE tag can be used to set the number of spaces in a tab.
- # Doxygen uses this value to replace tabs by spaces in code fragments.
- TAB_SIZE               = 8
- # The ENABLED_SECTIONS tag can be used to enable conditional
- # documentation sections, marked by \if sectionname ... \endif.
- ENABLED_SECTIONS       =
  # The GENERATE_TODOLIST tag can be used to enable (YES) or
  # disable (NO) the todo list. This list is created by putting \todo
  # commands in the documentation.
-Line 229 
 GENERATE_TESTLIST      = YES
+Line 295 
 GENERATE_TESTLIST      = YES
  GENERATE_BUGLIST       = YES
- # This tag can be used to specify a number of aliases that acts
+ # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
- # as commands in the documentation. An alias has the form "name=value".
+ # disable (NO) the deprecated list. This list is created by putting
- # For example adding "sideeffect=\par Side Effects:\n" will allow you to
+ # \deprecated commands in the documentation.
- # put the command \sideeffect (or @sideeffect) in the documentation, which
- # will result in a user defined paragraph with heading "Side Effects:".
- # You can put \n's in the value part of an alias to insert newlines.
- ALIASES                =
+ GENERATE_DEPRECATEDLIST= YES
+ # The ENABLED_SECTIONS tag can be used to enable conditional
+ # documentation sections, marked by \if sectionname ... \endif.
+ ENABLED_SECTIONS       =
  # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
- # the initial value of a variable or define consist of for it to appear in
+ # the initial value of a variable or define consists of for it to appear in
  # the documentation. If the initializer consists of more lines than specified
  # here it will be hidden. Use a value of 0 to hide initializers completely.
  # The appearance of the initializer of individual variables and defines in the
-Line 248 
 ALIASES                =
+Line 316 
 ALIASES                =
  MAX_INITIALIZER_LINES  = 30
- # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
- # only. Doxygen will then generate output that is more tailored for C.
- # For instance some of the names that are used will be different. The list
- # of all members will be omitted, etc.
- OPTIMIZE_OUTPUT_FOR_C  = NO
  # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
  # at the bottom of the documentation of classes and structs. If set to YES the
  # list will mention the files that were used to generate the documentation.
-Line 282 
 WARNINGS               = YES
+Line 343 
 WARNINGS               = YES
  WARN_IF_UNDOCUMENTED   = YES
+ # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
+ # potential errors in the documentation, such as not documenting some
+ # parameters in a documented function, or documenting parameters that
+ # don't exist or using markup commands wrongly.
+ WARN_IF_DOC_ERROR      = YES
  # The WARN_FORMAT tag determines the format of the warning messages that
  # doxygen can produce. The string should contain the $file, $line, and $text
  # tags, which will be replaced by the file and line number from which the
-Line 304 
 WARN_LOGFILE           =
+Line 372 
 WARN_LOGFILE           =
  # directories like "/usr/src/myproject". Separate the files or directories
  # with spaces.
- INPUT                  = /home/johng/esys/escript/src /home/johng/esys/finley/src /home/johng/esys/esysUtils/src
+ INPUT                  = ../escript/src \
+                          ../finley/src \
+                          ../esysUtils/src
  # If the value of the INPUT tag contains directories, you can use the
  # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
  # and *.h) to filter out the source-files in the directories. If left
- # blank all files are included.
+ # blank the following patterns are tested:
+ # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp
+ # *.h++ *.idl *.odl *.cs *.php *.php3 *.inc
- FILE_PATTERNS          = *.cpp *.h
+ FILE_PATTERNS          = *.c *.cpp \
+                          *.h
  # The RECURSIVE tag can be used to turn specify whether or not subdirectories
  # should be searched for input files as well. Possible values are YES and NO.
-Line 325 
 RECURSIVE              = YES
+Line 398 
 RECURSIVE              = YES
  EXCLUDE                = test
+ # The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories
+ # that are symbolic links (a Unix filesystem feature) are excluded from the input.
+ EXCLUDE_SYMLINKS       = NO
  # 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
  # certain files from those directories.
-Line 344 
 EXAMPLE_PATH           =
+Line 422 
 EXAMPLE_PATH           =
  EXAMPLE_PATTERNS       =
+ # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
+ # searched for input files to be used with the \include or \dontinclude
+ # commands irrespective of the value of the RECURSIVE tag.
+ # Possible values are YES and NO. If left blank NO is used.
+ EXAMPLE_RECURSIVE      = NO
  # The IMAGE_PATH tag can be used to specify one or more files or
  # directories that contain image that are included in the documentation (see
  # the \image command).
-Line 361 
 INPUT_FILTER           =
+Line 446 
 INPUT_FILTER           =
  # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
  # INPUT_FILTER) will be used to filter the input files when producing source
- # files to browse.
+ # files to browse (i.e. when SOURCE_BROWSER is set to YES).
  FILTER_SOURCE_FILES    = NO
  #---------------------------------------------------------------------------
+ # configuration options related to source browsing
+ #---------------------------------------------------------------------------
+ # If the SOURCE_BROWSER tag is set to YES then a list of source files will
+ # be generated. Documented entities will be cross-referenced with these sources.
+ # Note: To get rid of all source code in the generated output, make sure also
+ # VERBATIM_HEADERS is set to NO.
+ SOURCE_BROWSER         = NO
+ # Setting the INLINE_SOURCES tag to YES will include the body
+ # of functions and classes directly in the documentation.
+ INLINE_SOURCES         = NO
+ # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
+ # doxygen to hide any special comment blocks from generated source code
+ # fragments. Normal C and C++ comments will always remain visible.
+ STRIP_CODE_COMMENTS    = YES
+ # If the REFERENCED_BY_RELATION tag is set to YES (the default)
+ # then for each documented function all documented
+ # functions referencing it will be listed.
+ REFERENCED_BY_RELATION = YES
+ # If the REFERENCES_RELATION tag is set to YES (the default)
+ # then for each documented function all documented entities
+ # called/used by that function will be listed.
+ REFERENCES_RELATION    = YES
+ # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
+ # will generate a verbatim copy of the header file for each class for
+ # which an include is specified. Set to NO to disable this.
+ VERBATIM_HEADERS       = YES
+ #---------------------------------------------------------------------------
  # configuration options related to the alphabetical class index
  #---------------------------------------------------------------------------
-Line 403 
 GENERATE_HTML          = YES
+Line 528 
 GENERATE_HTML          = YES
  HTML_OUTPUT            =
+ # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
+ # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
+ # doxygen will generate files with .html extension.
+ HTML_FILE_EXTENSION    = .html
  # The HTML_HEADER tag can be used to specify a personal HTML header for
  # each generated HTML page. If it is left blank doxygen will generate a
  # standard header.
  HTML_HEADER            =
  # The HTML_FOOTER tag can be used to specify a personal HTML footer for
  # each generated HTML page. If it is left blank doxygen will generate a
-Line 415 
 HTML_HEADER            =
+Line 546 
 HTML_HEADER            =
  HTML_FOOTER            =
- # The HTML_STYLESHEET tag can be used to specify a user defined cascading
+ # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
  # style sheet that is used by each HTML page. It can be used to
  # fine-tune the look of the HTML output. If the tag is left blank doxygen
- # will generate a default style sheet
+ # will generate a default style sheet. Note that doxygen will try to copy
+ # the style sheet file to the HTML output directory, so don't put your own
+ # stylesheet in the HTML output directory as well, or it will be erased!
  HTML_STYLESHEET        =
-Line 435 
 HTML_ALIGN_MEMBERS     = YES
+Line 568 
 HTML_ALIGN_MEMBERS     = YES
  GENERATE_HTMLHELP      = NO
+ # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
+ # be used to specify the file name of the resulting .chm file. You
+ # can add a path in front of the file if the result should not be
+ # written to the html output directory.
+ CHM_FILE               =
+ # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
+ # be used to specify the location (absolute path including file name) of
+ # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
+ # the HTML help compiler on the generated index.hhp.
+ HHC_LOCATION           =
  # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
  # controls if a separate .chi index file is generated (YES) or that
  # it should be included in the master .chm file (NO).
-Line 448 
 GENERATE_CHI           = NO
+Line 595 
 GENERATE_CHI           = NO
  BINARY_TOC             = NO
  # The TOC_EXPAND flag can be set to YES to add extra items for group members
- # to the contents of the Html help documentation and to the tree view.
+ # to the contents of the HTML help documentation and to the tree view.
  TOC_EXPAND             = NO
-Line 466 
 ENUM_VALUES_PER_LINE   = 4
+Line 613 
 ENUM_VALUES_PER_LINE   = 4
  # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
  # generated containing a tree-like index structure (just like the one that
  # is generated for HTML Help). For this to work a browser that supports
- # JavaScript and frames is required (for instance Netscape 4.0+
+ # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
- # or Internet explorer 4.0+).
+ # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
+ # probably better off using the HTML help feature.
  GENERATE_TREEVIEW      = NO
-Line 492 
 GENERATE_LATEX         = NO
+Line 640 
 GENERATE_LATEX         = NO
  LATEX_OUTPUT           =
+ # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
+ # invoked. If left blank `latex' will be used as the default command name.
+ LATEX_CMD_NAME         = latex
+ # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
+ # generate index for LaTeX. If left blank `makeindex' will be used as the
+ # default command name.
+ MAKEINDEX_CMD_NAME     = makeindex
  # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
  # LaTeX documents. This may be useful for small projects and may help to
  # save some trees in general.
-Line 536 
 USE_PDFLATEX           = NO
+Line 695 
 USE_PDFLATEX           = NO
  LATEX_BATCHMODE        = NO
+ # If LATEX_HIDE_INDICES is set to YES then doxygen will not
+ # include the index chapters (such as File Index, Compound Index, etc.)
+ # in the output.
+ LATEX_HIDE_INDICES     = NO
  #---------------------------------------------------------------------------
  # configuration options related to the RTF output
  #---------------------------------------------------------------------------
  # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
- # The RTF output is optimised for Word 97 and may not look very pretty with
+ # The RTF output is optimized for Word 97 and may not look very pretty with
  # other RTF readers or editors.
  GENERATE_RTF           = NO
-Line 568 
 COMPACT_RTF            = NO
+Line 733 
 COMPACT_RTF            = NO
  RTF_HYPERLINKS         = NO
  # Load stylesheet definitions from file. Syntax is similar to doxygen's
- # config file, i.e. a series of assigments. You only have to provide
+ # config file, i.e. a series of assignments. You only have to provide
  # replacements, missing definitions are set to their default value.
  RTF_STYLESHEET_FILE    =
-Line 598 
 MAN_OUTPUT             =
+Line 763 
 MAN_OUTPUT             =
  MAN_EXTENSION          =
  # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
  # then it will generate one additional man file for each entity
  # documented in the real man page(s). These additional files
  # only source the real man page, but without them the man command
  # would be unable to find the correct page. The default is NO.
  MAN_LINKS              = NO
  #---------------------------------------------------------------------------
+ # configuration options related to the XML output
+ #---------------------------------------------------------------------------
+ # If the GENERATE_XML tag is set to YES Doxygen will
+ # generate an XML file that captures the structure of
+ # the code including all documentation.
+ GENERATE_XML           = NO
+ # The XML_OUTPUT tag is used to specify where the XML pages will be put.
+ # If a relative path is entered the value of OUTPUT_DIRECTORY will be
+ # put in front of it. If left blank `xml' will be used as the default path.
+ XML_OUTPUT             = xml
+ # The XML_SCHEMA tag can be used to specify an XML schema,
+ # which can be used by a validating XML parser to check the
+ # syntax of the XML files.
+ XML_SCHEMA             =
+ # The XML_DTD tag can be used to specify an XML DTD,
+ # which can be used by a validating XML parser to check the
+ # syntax of the XML files.
+ XML_DTD                =
+ # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
+ # dump the program listings (including syntax highlighting
+ # and cross-referencing information) to the XML output. Note that
+ # enabling this will significantly increase the size of the XML output.
+ XML_PROGRAMLISTING     = YES
+ #---------------------------------------------------------------------------
+ # configuration options for the AutoGen Definitions output
+ #---------------------------------------------------------------------------
+ # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
+ # generate an AutoGen Definitions (see autogen.sf.net) file
+ # that captures the structure of the code including all
+ # documentation. Note that this feature is still experimental
+ # and incomplete at the moment.
+ GENERATE_AUTOGEN_DEF   = NO
+ #---------------------------------------------------------------------------
+ # configuration options related to the Perl module output
+ #---------------------------------------------------------------------------
+ # If the GENERATE_PERLMOD tag is set to YES Doxygen will
+ # generate a Perl module file that captures the structure of
+ # the code including all documentation. Note that this
+ # feature is still experimental and incomplete at the
+ # moment.
+ GENERATE_PERLMOD       = NO
+ # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
+ # the necessary Makefile rules, Perl scripts and LaTeX code to be able
+ # to generate PDF and DVI output from the Perl module output.
+ PERLMOD_LATEX          = NO
+ # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
+ # nicely formatted so it can be parsed by a human reader.  This is useful
+ # if you want to understand what is going on.  On the other hand, if this
+ # tag is set to NO the size of the Perl module output will be much smaller
+ # and Perl will parse it just the same.
+ PERLMOD_PRETTY         = YES
+ # The names of the make variables in the generated doxyrules.make file
+ # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
+ # This is useful so different doxyrules.make files included by the same
+ # Makefile don't overwrite each other's variables.
+ PERLMOD_MAKEVAR_PREFIX =
+ #---------------------------------------------------------------------------
  # Configuration options related to the preprocessor
  #---------------------------------------------------------------------------
-Line 655 
 INCLUDE_FILE_PATTERNS  =
+Line 900 
 INCLUDE_FILE_PATTERNS  =
  PREDEFINED             =
- # If the MACRO_EXPANSION and EXPAND_PREDEF_ONLY tags are set to YES then
+ # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
  # this tag can be used to specify a list of macro names that should be expanded.
  # The macro definition that is found in the sources will be used.
  # Use the PREDEFINED tag if you want to use a different macro definition.
  EXPAND_AS_DEFINED      =
+ # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
+ # doxygen's preprocessor will remove all function-like macros that are alone
+ # on a line, have an all uppercase name, and do not end with a semicolon. Such
+ # function macros are typically used for boiler-plate code, and will confuse the
+ # parser if not removed.
+ SKIP_FUNCTION_MACROS   = YES
  #---------------------------------------------------------------------------
  # Configuration::addtions related to external references
  #---------------------------------------------------------------------------
- # The TAGFILES tag can be used to specify one or more tagfiles.
+ # The TAGFILES option can be used to specify one or more tagfiles.
+ # Optionally an initial location of the external documentation
+ # can be added for each tagfile. The format of a tag file without
+ # this location is as follows:
+ #   TAGFILES = file1 file2 ...
+ # Adding location for the tag files is done as follows:
+ #   TAGFILES = file1=loc1 "file2 = loc2" ...
+ # where "loc1" and "loc2" can be relative or absolute paths or
+ # URLs. If a location is present for each tag, the installdox tool
+ # does not have to be run to correct the links.
+ # Note that each tag file must have a unique name
+ # (where the name does NOT include the path)
+ # If a tag file is not located in the directory in which doxygen
+ # is run, you must also specify the path to the tagfile here.
  TAGFILES               =
-Line 681 
 GENERATE_TAGFILE       =
+Line 947 
 GENERATE_TAGFILE       =
  ALLEXTERNALS           = NO
+ # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
+ # in the modules index. If set to NO, only the current project's groups will
+ # be listed.
+ EXTERNAL_GROUPS        = YES
  # The PERL_PATH should be the absolute path and name of the perl script
  # interpreter (i.e. the result of `which perl').
-Line 690 
 PERL_PATH              =
+Line 962 
 PERL_PATH              =
  # Configuration options related to the dot tool
  #---------------------------------------------------------------------------
+ # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
+ # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or
+ # super classes. Setting the tag to NO turns the diagrams off. Note that this
+ # option is superseded by the HAVE_DOT option below. This is only a fallback. It is
+ # recommended to install and use dot, since it yields more powerful graphs.
+ CLASS_DIAGRAMS         = YES
+ # If set to YES, the inheritance and collaboration graphs will hide
+ # inheritance and usage relations if the target is undocumented
+ # or is not a class.
+ HIDE_UNDOC_RELATIONS   = YES
  # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
  # available from the path. This tool is part of Graphviz, a graph visualization
  # toolkit from AT&T and Lucent Bell Labs. The other options in this section
-Line 711 
 CLASS_GRAPH            = YES
+Line 997 
 CLASS_GRAPH            = YES
  COLLABORATION_GRAPH    = YES
+ # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
+ # collaboration diagrams in a style similar to the OMG's Unified Modeling
+ # Language.
+ UML_LOOK               = NO
+ # If set to YES, the inheritance and collaboration graphs will show the
+ # relations between templates and their instances.
+ TEMPLATE_RELATIONS     = NO
  # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
  # tags are set to YES then doxygen will generate a graph for each documented
  # file showing the direct and indirect include dependencies of the file with
-Line 725 
 INCLUDE_GRAPH          = YES
+Line 1022 
 INCLUDE_GRAPH          = YES
  INCLUDED_BY_GRAPH      = YES
+ # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
+ # generate a call dependency graph for every global function or class method.
+ # Note that enabling this option will significantly increase the time of a run.
+ # So in most cases it will be better to enable call graphs for selected
+ # functions only using the \callgraph command.
+ CALL_GRAPH             = NO
  # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
  # will graphical hierarchy of all classes instead of a textual one.
  GRAPHICAL_HIERARCHY    = YES
+ # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
+ # generated by dot. Possible values are png, jpg, or gif
+ # If left blank png will be used.
+ DOT_IMAGE_FORMAT       = png
  # The tag DOT_PATH can be used to specify the path where the dot tool can be
  # found. If left blank, it is assumed the dot tool can be found on the path.
  DOT_PATH               =
+ # The DOTFILE_DIRS tag can be used to specify one or more directories that
+ # contain dot files that are included in the documentation (see the
+ # \dotfile command).
+ DOTFILE_DIRS           =
  # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
  # (in pixels) of the graphs generated by dot. If a graph becomes larger than
  # this value, doxygen will try to truncate the graph, so that it fits within
-Line 751 
 MAX_DOT_GRAPH_WIDTH    = 1024
+Line 1068 
 MAX_DOT_GRAPH_WIDTH    = 1024
  MAX_DOT_GRAPH_HEIGHT   = 1024
+ # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
+ # graphs generated by dot. A depth value of 3 means that only nodes reachable
+ # from the root by following a path via at most 3 edges will be shown. Nodes that
+ # lay further from the root node will be omitted. Note that setting this option to
+ # 1 or 2 may greatly reduce the computation time needed for large code bases. Also
+ # note that a graph may be further truncated if the graph's image dimensions are
+ # not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT).
+ # If 0 is used for the depth value (the default), the graph is not depth-constrained.
+ MAX_DOT_GRAPH_DEPTH    = 0
  # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
  # generate a legend page explaining the meaning of the various boxes and
  # arrows in the dot generated graphs.
-Line 758 
 MAX_DOT_GRAPH_HEIGHT   = 1024
+Line 1086 
 MAX_DOT_GRAPH_HEIGHT   = 1024
  GENERATE_LEGEND        = YES
  # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
- # remove the intermedate dot files that are used to generate
+ # remove the intermediate dot files that are used to generate
  # the various graphs.
  DOT_CLEANUP            = YES
-Line 771 
 DOT_CLEANUP            = YES
+Line 1099 
 DOT_CLEANUP            = YES
  # used. If set to NO the values of all tags below this one will be ignored.
  SEARCHENGINE           = NO
- # The CGI_NAME tag should be the name of the CGI script that
- # starts the search engine (doxysearch) with the correct parameters.
- # A script with this name will be generated by doxygen.
- CGI_NAME               =
- # The CGI_URL tag should be the absolute URL to the directory where the
- # cgi binaries are located. See the documentation of your http daemon for
- # details.
- CGI_URL                =
- # The DOC_URL tag should be the absolute URL to the directory where the
- # documentation is located. If left blank the absolute path to the
- # documentation, with file:// prepended to it, will be used.
- DOC_URL                =
- # The DOC_ABSPATH tag should be the absolute path to the directory where the
- # documentation is located. If left blank the directory on the local machine
- # will be used.
- DOC_ABSPATH            =
- # The BIN_ABSPATH tag must point to the directory where the doxysearch binary
- # is installed.
- BIN_ABSPATH            =
- # The EXT_DOC_PATHS tag can be used to specify one or more paths to
- # documentation generated for other projects. This allows doxysearch to search
- # the documentation for these projects as well.
- EXT_DOC_PATHS          =

 Legend:



Removed from v.82
 


changed lines


 
Added in v.121
 Legend:



Removed from v.82
 


changed lines


 
Added in v.121
-Removed from v.82
+Added in v.121

	ViewVC Help
Powered by ViewVC 1.1.26