man.doxy Source File

- Main Page
- Modules
- Namespaces
- Classes
- Files

- File List

# man.doxy

    00001 # Doxyfile 1.7.3
    00002
    00003 # This file describes the settings to be used by the documentation system
    00004 # doxygen (www.doxygen.org) for a project
    00005 #
    00006 # All text after a hash (#) is considered a comment and will be ignored
    00007 # The format is:
    00008 #       TAG = value [value, ...]
    00009 # For lists items can also be appended using:
    00010 #       TAG += value [value, ...]
    00011 # Values that contain spaces should be placed between quotes (" ")
    00012
    00013 #---------------------------------------------------------------------------
    00014 # Project related configuration options
    00015 #---------------------------------------------------------------------------
    00016
    00017 # This tag specifies the encoding used for all characters in the config file
    00018 # that follow. The default is UTF-8 which is also the encoding used for all
    00019 # text before the first occurrence of this tag. Doxygen uses libiconv (or the
    00020 # iconv built into libc) for the transcoding. See
    00021 # http://www.gnu.org/software/libiconv for the list of possible encodings.
    00022
    00023 DOXYFILE_ENCODING      = UTF-8
    00024
    00025 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
    00026 # by quotes) that should identify the project.
    00027
    00028 PROJECT_NAME           =
    00029
    00030 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
    00031 # This could be handy for archiving the generated documentation or
    00032 # if some version control system is used.
    00033
    00034 PROJECT_NUMBER         = 0.9.1
    00035
    00036 # Using the PROJECT_BRIEF tag one can provide an optional one line description
    00037 # for a project that appears at the top of each page and should give viewer
    00038 # a quick idea about the purpose of the project. Keep the description short.
    00039
    00040 PROJECT_BRIEF          =
    00041
    00042 # With the PROJECT_LOGO tag one can specify an logo or icon that is
    00043 # included in the documentation. The maximum height of the logo should not
    00044 # exceed 55 pixels and the maximum width should not exceed 200 pixels.
    00045 # Doxygen will copy the logo to the output directory.
    00046
    00047 PROJECT_LOGO           = ./image/logo-mini.png
    00048
    00049 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
    00050 # base path where the generated documentation will be put.
    00051 # If a relative path is entered, it will be relative to the location
    00052 # where doxygen was started. If left blank the current directory will be used.
    00053
    00054 OUTPUT_DIRECTORY       = .
    00055
    00056 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
    00057 # 4096 sub-directories (in 2 levels) under the output directory of each output
    00058 # format and will distribute the generated files over these directories.
    00059 # Enabling this option can be useful when feeding doxygen a huge amount of
    00060 # source files, where putting all generated files in the same directory would
    00061 # otherwise cause performance problems for the file system.
    00062
    00063 CREATE_SUBDIRS         = NO
    00064
    00065 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
    00066 # documentation generated by doxygen is written. Doxygen will use this
    00067 # information to generate all constant output in the proper language.
    00068 # The default language is English, other supported languages are:
    00069 # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
    00070 # Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
    00071 # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
    00072 # messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
    00073 # Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak,
    00074 # Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
    00075
    00076 OUTPUT_LANGUAGE        = English
    00077
    00078 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
    00079 # include brief member descriptions after the members that are listed in
    00080 # the file and class documentation (similar to JavaDoc).
    00081 # Set to NO to disable this.
    00082
    00083 BRIEF_MEMBER_DESC      = NO
    00084
    00085 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
    00086 # the brief description of a member or function before the detailed description.
    00087 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
    00088 # brief descriptions will be completely suppressed.
    00089
    00090 REPEAT_BRIEF           = YES
    00091
    00092 # This tag implements a quasi-intelligent brief description abbreviator
    00093 # that is used to form the text in various listings. Each string
    00094 # in this list, if found as the leading text of the brief description, will be
    00095 # stripped from the text and the result after processing the whole list, is
    00096 # used as the annotated text. Otherwise, the brief description is used as-is.
    00097 # If left blank, the following values are used ("$name" is automatically
    00098 # replaced with the name of the entity): "The $name class" "The $name widget"
    00099 # "The $name file" "is" "provides" "specifies" "contains"
    00100 # "represents" "a" "an" "the"
    00101
    00102 ABBREVIATE_BRIEF       = "The $name class       " \
    00103                          "The $name widget       " \
    00104                          "The $name file       " \
    00105                          is \
    00106                          provides \
    00107                          specifies \
    00108                          contains \
    00109                          represents \
    00110                          a \
    00111                          an \
    00112                          the
    00113
    00114 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
    00115 # Doxygen will generate a detailed section even if there is only a brief
    00116 # description.
    00117
    00118 ALWAYS_DETAILED_SEC    = NO
    00119
    00120 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
    00121 # inherited members of a class in the documentation of that class as if those
    00122 # members were ordinary class members. Constructors, destructors and assignment
    00123 # operators of the base classes will not be shown.
    00124
    00125 INLINE_INHERITED_MEMB  = NO
    00126
    00127 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
    00128 # path before files name in the file list and in the header files. If set
    00129 # to NO the shortest path that makes the file name unique will be used.
    00130
    00131 FULL_PATH_NAMES        = NO
    00132
    00133 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
    00134 # can be used to strip a user-defined part of the path. Stripping is
    00135 # only done if one of the specified strings matches the left-hand part of
    00136 # the path. The tag can be used to show relative paths in the file list.
    00137 # If left blank the directory from which doxygen is run is used as the
    00138 # path to strip.
    00139
    00140 STRIP_FROM_PATH        = "C:/Documents and Settings/Groove/       "
    00141
    00142 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
    00143 # the path mentioned in the documentation of a class, which tells
    00144 # the reader which header file to include in order to use a class.
    00145 # If left blank only the name of the header file containing the class
    00146 # definition is used. Otherwise one should specify the include paths that
    00147 # are normally passed to the compiler using the -I flag.
    00148
    00149 STRIP_FROM_INC_PATH    =
    00150
    00151 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
    00152 # (but less readable) file names. This can be useful if your file system
    00153 # doesn't support long names like on DOS, Mac, or CD-ROM.
    00154
    00155 SHORT_NAMES            = YES
    00156
    00157 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
    00158 # will interpret the first line (until the first dot) of a JavaDoc-style
    00159 # comment as the brief description. If set to NO, the JavaDoc
    00160 # comments will behave just like regular Qt-style comments
    00161 # (thus requiring an explicit @brief command for a brief description.)
    00162
    00163 JAVADOC_AUTOBRIEF      = YES
    00164
    00165 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
    00166 # interpret the first line (until the first dot) of a Qt-style
    00167 # comment as the brief description. If set to NO, the comments
    00168 # will behave just like regular Qt-style comments (thus requiring
    00169 # an explicit \brief command for a brief description.)
    00170
    00171 QT_AUTOBRIEF           = NO
    00172
    00173 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
    00174 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
    00175 # comments) as a brief description. This used to be the default behaviour.
    00176 # The new default is to treat a multi-line C++ comment block as a detailed
    00177 # description. Set this tag to YES if you prefer the old behaviour instead.
    00178
    00179 MULTILINE_CPP_IS_BRIEF = NO
    00180
    00181 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
    00182 # member inherits the documentation from any documented member that it
    00183 # re-implements.
    00184
    00185 INHERIT_DOCS           = YES
    00186
    00187 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
    00188 # a new page for each member. If set to NO, the documentation of a member will
    00189 # be part of the file/class/namespace that contains it.
    00190
    00191 SEPARATE_MEMBER_PAGES  = NO
    00192
    00193 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
    00194 # Doxygen uses this value to replace tabs by spaces in code fragments.
    00195
    00196 TAB_SIZE               = 8
    00197
    00198 # This tag can be used to specify a number of aliases that acts
    00199 # as commands in the documentation. An alias has the form "name=value".
    00200 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
    00201 # put the command \sideeffect (or @sideeffect) in the documentation, which
    00202 # will result in a user-defined paragraph with heading "Side Effects:".
    00203 # You can put \n's in the value part of an alias to insert newlines.
    00204
    00205 ALIASES                =
    00206
    00207 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
    00208 # sources only. Doxygen will then generate output that is more tailored for C.
    00209 # For instance, some of the names that are used will be different. The list
    00210 # of all members will be omitted, etc.
    00211
    00212 OPTIMIZE_OUTPUT_FOR_C  = NO
    00213
    00214 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
    00215 # sources only. Doxygen will then generate output that is more tailored for
    00216 # Java. For instance, namespaces will be presented as packages, qualified
    00217 # scopes will look different, etc.
    00218
    00219 OPTIMIZE_OUTPUT_JAVA   = NO
    00220
    00221 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
    00222 # sources only. Doxygen will then generate output that is more tailored for
    00223 # Fortran.
    00224
    00225 OPTIMIZE_FOR_FORTRAN   = NO
    00226
    00227 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
    00228 # sources. Doxygen will then generate output that is tailored for
    00229 # VHDL.
    00230
    00231 OPTIMIZE_OUTPUT_VHDL   = NO
    00232
    00233 # Doxygen selects the parser to use depending on the extension of the files it
    00234 # parses. With this tag you can assign which parser to use for a given extension.
    00235 # Doxygen has a built-in mapping, but you can override or extend it using this
    00236 # tag. The format is ext=language, where ext is a file extension, and language
    00237 # is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C,
    00238 # C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make
    00239 # doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
    00240 # (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions
    00241 # you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
    00242
    00243 EXTENSION_MAPPING      =
    00244
    00245 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
    00246 # to include (a tag file for) the STL sources as input, then you should
    00247 # set this tag to YES in order to let doxygen match functions declarations and
    00248 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
    00249 # func(std::string) {}). This also makes the inheritance and collaboration
    00250 # diagrams that involve STL classes more complete and accurate.
    00251
    00252 BUILTIN_STL_SUPPORT    = NO
    00253
    00254 # If you use Microsoft's C++/CLI language, you should set this option to YES to
    00255 # enable parsing support.
    00256
    00257 CPP_CLI_SUPPORT        = NO
    00258
    00259 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
    00260 # Doxygen will parse them like normal C++ but will assume all classes use public
    00261 # instead of private inheritance when no explicit protection keyword is present.
    00262
    00263 SIP_SUPPORT            = NO
    00264
    00265 # For Microsoft's IDL there are propget and propput attributes to indicate getter
    00266 # and setter methods for a property. Setting this option to YES (the default)
    00267 # will make doxygen replace the get and set methods by a property in the
    00268 # documentation. This will only work if the methods are indeed getting or
    00269 # setting a simple type. If this is not the case, or you want to show the
    00270 # methods anyway, you should set this option to NO.
    00271
    00272 IDL_PROPERTY_SUPPORT   = YES
    00273
    00274 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
    00275 # tag is set to YES, then doxygen will reuse the documentation of the first
    00276 # member in the group (if any) for the other members of the group. By default
    00277 # all members of a group must be documented explicitly.
    00278
    00279 DISTRIBUTE_GROUP_DOC   = NO
    00280
    00281 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
    00282 # the same type (for instance a group of public functions) to be put as a
    00283 # subgroup of that type (e.g. under the Public Functions section). Set it to
    00284 # NO to prevent subgrouping. Alternatively, this can be done per class using
    00285 # the \nosubgrouping command.
    00286
    00287 SUBGROUPING            = NO
    00288
    00289 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
    00290 # is documented as struct, union, or enum with the name of the typedef. So
    00291 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
    00292 # with name TypeT. When disabled the typedef will appear as a member of a file,
    00293 # namespace, or class. And the struct will be named TypeS. This can typically
    00294 # be useful for C code in case the coding convention dictates that all compound
    00295 # types are typedef'ed and only the typedef is referenced, never the tag name.
    00296
    00297 TYPEDEF_HIDES_STRUCT   = NO
    00298
    00299 # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
    00300 # determine which symbols to keep in memory and which to flush to disk.
    00301 # When the cache is full, less often used symbols will be written to disk.
    00302 # For small to medium size projects (<1000 input files) the default value is
    00303 # probably good enough. For larger projects a too small cache size can cause
    00304 # doxygen to be busy swapping symbols to and from disk most of the time
    00305 # causing a significant performance penalty.
    00306 # If the system has enough physical memory increasing the cache will improve the
    00307 # performance by keeping more symbols in memory. Note that the value works on
    00308 # a logarithmic scale so increasing the size by one will roughly double the
    00309 # memory usage. The cache size is given by this formula:
    00310 # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
    00311 # corresponding to a cache size of 2^16 = 65536 symbols
    00312
    00313 SYMBOL_CACHE_SIZE      = 0
    00314
    00315 #---------------------------------------------------------------------------
    00316 # Build related configuration options
    00317 #---------------------------------------------------------------------------
    00318
    00319 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
    00320 # documentation are documented, even if no documentation was available.
    00321 # Private class members and static file members will be hidden unless
    00322 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
    00323
    00324 EXTRACT_ALL            = NO
    00325
    00326 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
    00327 # will be included in the documentation.
    00328
    00329 EXTRACT_PRIVATE        = NO
    00330
    00331 # If the EXTRACT_STATIC tag is set to YES all static members of a file
    00332 # will be included in the documentation.
    00333
    00334 EXTRACT_STATIC         = YES
    00335
    00336 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
    00337 # defined locally in source files will be included in the documentation.
    00338 # If set to NO only classes defined in header files are included.
    00339
    00340 EXTRACT_LOCAL_CLASSES  = NO
    00341
    00342 # This flag is only useful for Objective-C code. When set to YES local
    00343 # methods, which are defined in the implementation section but not in
    00344 # the interface are included in the documentation.
    00345 # If set to NO (the default) only methods in the interface are included.
    00346
    00347 EXTRACT_LOCAL_METHODS  = NO
    00348
    00349 # If this flag is set to YES, the members of anonymous namespaces will be
    00350 # extracted and appear in the documentation as a namespace called
    00351 # 'anonymous_namespace{file}', where file will be replaced with the base
    00352 # name of the file that contains the anonymous namespace. By default
    00353 # anonymous namespaces are hidden.
    00354
    00355 EXTRACT_ANON_NSPACES   = NO
    00356
    00357 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
    00358 # undocumented members of documented classes, files or namespaces.
    00359 # If set to NO (the default) these members will be included in the
    00360 # various overviews, but no documentation section is generated.
    00361 # This option has no effect if EXTRACT_ALL is enabled.
    00362
    00363 HIDE_UNDOC_MEMBERS     = YES
    00364
    00365 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
    00366 # undocumented classes that are normally visible in the class hierarchy.
    00367 # If set to NO (the default) these classes will be included in the various
    00368 # overviews. This option has no effect if EXTRACT_ALL is enabled.
    00369
    00370 HIDE_UNDOC_CLASSES     = YES
    00371
    00372 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
    00373 # friend (class|struct|union) declarations.
    00374 # If set to NO (the default) these declarations will be included in the
    00375 # documentation.
    00376
    00377 HIDE_FRIEND_COMPOUNDS  = YES
    00378
    00379 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
    00380 # documentation blocks found inside the body of a function.
    00381 # If set to NO (the default) these blocks will be appended to the
    00382 # function's detailed documentation block.
    00383
    00384 HIDE_IN_BODY_DOCS      = YES
    00385
    00386 # The INTERNAL_DOCS tag determines if documentation
    00387 # that is typed after a \internal command is included. If the tag is set
    00388 # to NO (the default) then the documentation will be excluded.
    00389 # Set it to YES to include the internal documentation.
    00390
    00391 INTERNAL_DOCS          = NO
    00392
    00393 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
    00394 # file names in lower-case letters. If set to YES upper-case letters are also
    00395 # allowed. This is useful if you have classes or files whose names only differ
    00396 # in case and if your file system supports case sensitive file names. Windows
    00397 # and Mac users are advised to set this option to NO.
    00398
    00399 CASE_SENSE_NAMES       = YES
    00400
    00401 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
    00402 # will show members with their full class and namespace scopes in the
    00403 # documentation. If set to YES the scope will be hidden.
    00404
    00405 HIDE_SCOPE_NAMES       = YES
    00406
    00407 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
    00408 # will put a list of the files that are included by a file in the documentation
    00409 # of that file.
    00410
    00411 SHOW_INCLUDE_FILES     = NO
    00412
    00413 # If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
    00414 # will list include files with double quotes in the documentation
    00415 # rather than with sharp brackets.
    00416
    00417 FORCE_LOCAL_INCLUDES   = NO
    00418
    00419 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
    00420 # is inserted in the documentation for inline members.
    00421
    00422 INLINE_INFO            = NO
    00423
    00424 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
    00425 # will sort the (detailed) documentation of file and class members
    00426 # alphabetically by member name. If set to NO the members will appear in
    00427 # declaration order.
    00428
    00429 SORT_MEMBER_DOCS       = YES
    00430
    00431 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
    00432 # brief documentation of file, namespace and class members alphabetically
    00433 # by member name. If set to NO (the default) the members will appear in
    00434 # declaration order.
    00435
    00436 SORT_BRIEF_DOCS        = YES
    00437
    00438 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
    00439 # will sort the (brief and detailed) documentation of class members so that
    00440 # constructors and destructors are listed first. If set to NO (the default)
    00441 # the constructors will appear in the respective orders defined by
    00442 # SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
    00443 # This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
    00444 # and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
    00445
    00446 SORT_MEMBERS_CTORS_1ST = NO
    00447
    00448 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
    00449 # hierarchy of group names into alphabetical order. If set to NO (the default)
    00450 # the group names will appear in their defined order.
    00451
    00452 SORT_GROUP_NAMES       = NO
    00453
    00454 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
    00455 # sorted by fully-qualified names, including namespaces. If set to
    00456 # NO (the default), the class list will be sorted only by class name,
    00457 # not including the namespace part.
    00458 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
    00459 # Note: This option applies only to the class list, not to the
    00460 # alphabetical list.
    00461
    00462 SORT_BY_SCOPE_NAME     = YES
    00463
    00464 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to
    00465 # do proper type resolution of all parameters of a function it will reject a
    00466 # match between the prototype and the implementation of a member function even
    00467 # if there is only one candidate or it is obvious which candidate to choose
    00468 # by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen
    00469 # will still accept a match between prototype and implementation in such cases.
    00470
    00471 STRICT_PROTO_MATCHING  = NO
    00472
    00473 # The GENERATE_TODOLIST tag can be used to enable (YES) or
    00474 # disable (NO) the todo list. This list is created by putting \todo
    00475 # commands in the documentation.
    00476
    00477 GENERATE_TODOLIST      = YES
    00478
    00479 # The GENERATE_TESTLIST tag can be used to enable (YES) or
    00480 # disable (NO) the test list. This list is created by putting \test
    00481 # commands in the documentation.
    00482
    00483 GENERATE_TESTLIST      = YES
    00484
    00485 # The GENERATE_BUGLIST tag can be used to enable (YES) or
    00486 # disable (NO) the bug list. This list is created by putting \bug
    00487 # commands in the documentation.
    00488
    00489 GENERATE_BUGLIST       = YES
    00490
    00491 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
    00492 # disable (NO) the deprecated list. This list is created by putting
    00493 # \deprecated commands in the documentation.
    00494
    00495 GENERATE_DEPRECATEDLIST= YES
    00496
    00497 # The ENABLED_SECTIONS tag can be used to enable conditional
    00498 # documentation sections, marked by \if sectionname ... \endif.
    00499
    00500 ENABLED_SECTIONS       =
    00501
    00502 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
    00503 # the initial value of a variable or macro consists of for it to appear in
    00504 # the documentation. If the initializer consists of more lines than specified
    00505 # here it will be hidden. Use a value of 0 to hide initializers completely.
    00506 # The appearance of the initializer of individual variables and macros in the
    00507 # documentation can be controlled using \showinitializer or \hideinitializer
    00508 # command in the documentation regardless of this setting.
    00509
    00510 MAX_INITIALIZER_LINES  = 30
    00511
    00512 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
    00513 # at the bottom of the documentation of classes and structs. If set to YES the
    00514 # list will mention the files that were used to generate the documentation.
    00515
    00516 SHOW_USED_FILES        = NO
    00517
    00518 # If the sources in your project are distributed over multiple directories
    00519 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
    00520 # in the documentation. The default is NO.
    00521
    00522 SHOW_DIRECTORIES       = NO
    00523
    00524 # Set the SHOW_FILES tag to NO to disable the generation of the Files page.
    00525 # This will remove the Files entry from the Quick Index and from the
    00526 # Folder Tree View (if specified). The default is YES.
    00527
    00528 SHOW_FILES             = YES
    00529
    00530 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the
    00531 # Namespaces page.  This will remove the Namespaces entry from the Quick Index
    00532 # and from the Folder Tree View (if specified). The default is YES.
    00533
    00534 SHOW_NAMESPACES        = YES
    00535
    00536 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
    00537 # doxygen should invoke to get the current version for each file (typically from
    00538 # the version control system). Doxygen will invoke the program by executing (via
    00539 # popen()) the command <command> <input-file>, where <command> is the value of
    00540 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
    00541 # provided by doxygen. Whatever the program writes to standard output
    00542 # is used as the file version. See the manual for examples.
    00543
    00544 FILE_VERSION_FILTER    =
    00545
    00546 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
    00547 # by doxygen. The layout file controls the global structure of the generated
    00548 # output files in an output format independent way. The create the layout file
    00549 # that represents doxygen's defaults, run doxygen with the -l option.
    00550 # You can optionally specify a file name after the option, if omitted
    00551 # DoxygenLayout.xml will be used as the name of the layout file.
    00552
    00553 LAYOUT_FILE            =
    00554
    00555 #---------------------------------------------------------------------------
    00556 # configuration options related to warning and progress messages
    00557 #---------------------------------------------------------------------------
    00558
    00559 # The QUIET tag can be used to turn on/off the messages that are generated
    00560 # by doxygen. Possible values are YES and NO. If left blank NO is used.
    00561
    00562 QUIET                  = NO
    00563
    00564 # The WARNINGS tag can be used to turn on/off the warning messages that are
    00565 # generated by doxygen. Possible values are YES and NO. If left blank
    00566 # NO is used.
    00567
    00568 WARNINGS               = YES
    00569
    00570 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
    00571 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
    00572 # automatically be disabled.
    00573
    00574 WARN_IF_UNDOCUMENTED   = YES
    00575
    00576 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
    00577 # potential errors in the documentation, such as not documenting some
    00578 # parameters in a documented function, or documenting parameters that
    00579 # don't exist or using markup commands wrongly.
    00580
    00581 WARN_IF_DOC_ERROR      = YES
    00582
    00583 # The WARN_NO_PARAMDOC option can be enabled to get warnings for
    00584 # functions that are documented, but have no documentation for their parameters
    00585 # or return value. If set to NO (the default) doxygen will only warn about
    00586 # wrong or incomplete parameter documentation, but not about the absence of
    00587 # documentation.
    00588
    00589 WARN_NO_PARAMDOC       = NO
    00590
    00591 # The WARN_FORMAT tag determines the format of the warning messages that
    00592 # doxygen can produce. The string should contain the $file, $line, and $text
    00593 # tags, which will be replaced by the file and line number from which the
    00594 # warning originated and the warning text. Optionally the format may contain
    00595 # $version, which will be replaced by the version of the file (if it could
    00596 # be obtained via FILE_VERSION_FILTER)
    00597
    00598 WARN_FORMAT            = "$file:$line: $text"
    00599
    00600 # The WARN_LOGFILE tag can be used to specify a file to which warning
    00601 # and error messages should be written. If left blank the output is written
    00602 # to stderr.
    00603
    00604 WARN_LOGFILE           =
    00605
    00606 #---------------------------------------------------------------------------
    00607 # configuration options related to the input files
    00608 #---------------------------------------------------------------------------
    00609
    00610 # The INPUT tag can be used to specify the files and/or directories that contain
    00611 # documented source files. You may enter file names like "myfile.cpp" or
    00612 # directories like "/usr/src/myproject". Separate the files or directories
    00613 # with spaces.
    00614
    00615 INPUT                  = ../glm \
    00616                          .
    00617
    00618 # This tag can be used to specify the character encoding of the source files
    00619 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
    00620 # also the default input encoding. Doxygen uses libiconv (or the iconv built
    00621 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
    00622 # the list of possible encodings.
    00623
    00624 INPUT_ENCODING         = UTF-8
    00625
    00626 # If the value of the INPUT tag contains directories, you can use the
    00627 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
    00628 # and *.h) to filter out the source-files in the directories. If left
    00629 # blank the following patterns are tested:
    00630 # *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh
    00631 # *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
    00632 # *.f90 *.f *.for *.vhd *.vhdl
    00633
    00634 FILE_PATTERNS          = *.hpp \
    00635                          *.doxy
    00636
    00637 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
    00638 # should be searched for input files as well. Possible values are YES and NO.
    00639 # If left blank NO is used.
    00640
    00641 RECURSIVE              = YES
    00642
    00643 # The EXCLUDE tag can be used to specify files and/or directories that should
    00644 # excluded from the INPUT source files. This way you can easily exclude a
    00645 # subdirectory from a directory tree whose root is specified with the INPUT tag.
    00646
    00647 EXCLUDE                =
    00648
    00649 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
    00650 # directories that are symbolic links (a Unix file system feature) are excluded
    00651 # from the input.
    00652
    00653 EXCLUDE_SYMLINKS       = NO
    00654
    00655 # If the value of the INPUT tag contains directories, you can use the
    00656 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
    00657 # certain files from those directories. Note that the wildcards are matched
    00658 # against the file with absolute path, so to exclude all test directories
    00659 # for example use the pattern */test/*
    00660
    00661 EXCLUDE_PATTERNS       =
    00662
    00663 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
    00664 # (namespaces, classes, functions, etc.) that should be excluded from the
    00665 # output. The symbol name can be a fully qualified name, a word, or if the
    00666 # wildcard * is used, a substring. Examples: ANamespace, AClass,
    00667 # AClass::ANamespace, ANamespace::*Test
    00668
    00669 EXCLUDE_SYMBOLS        =
    00670
    00671 # The EXAMPLE_PATH tag can be used to specify one or more files or
    00672 # directories that contain example code fragments that are included (see
    00673 # the \include command).
    00674
    00675 EXAMPLE_PATH           =
    00676
    00677 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
    00678 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
    00679 # and *.h) to filter out the source-files in the directories. If left
    00680 # blank all files are included.
    00681
    00682 EXAMPLE_PATTERNS       = *
    00683
    00684 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
    00685 # searched for input files to be used with the \include or \dontinclude
    00686 # commands irrespective of the value of the RECURSIVE tag.
    00687 # Possible values are YES and NO. If left blank NO is used.
    00688
    00689 EXAMPLE_RECURSIVE      = NO
    00690
    00691 # The IMAGE_PATH tag can be used to specify one or more files or
    00692 # directories that contain image that are included in the documentation (see
    00693 # the \image command).
    00694
    00695 IMAGE_PATH             =
    00696
    00697 # The INPUT_FILTER tag can be used to specify a program that doxygen should
    00698 # invoke to filter for each input file. Doxygen will invoke the filter program
    00699 # by executing (via popen()) the command <filter> <input-file>, where <filter>
    00700 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
    00701 # input file. Doxygen will then use the output that the filter program writes
    00702 # to standard output.  If FILTER_PATTERNS is specified, this tag will be
    00703 # ignored.
    00704
    00705 INPUT_FILTER           =
    00706
    00707 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
    00708 # basis.  Doxygen will compare the file name with each pattern and apply the
    00709 # filter if there is a match.  The filters are a list of the form:
    00710 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
    00711 # info on how filters are used. If FILTER_PATTERNS is empty or if
    00712 # non of the patterns match the file name, INPUT_FILTER is applied.
    00713
    00714 FILTER_PATTERNS        =
    00715
    00716 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
    00717 # INPUT_FILTER) will be used to filter the input files when producing source
    00718 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
    00719
    00720 FILTER_SOURCE_FILES    = NO
    00721
    00722 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
    00723 # pattern. A pattern will override the setting for FILTER_PATTERN (if any)
    00724 # and it is also possible to disable source filtering for a specific pattern
    00725 # using *.ext= (so without naming a filter). This option only has effect when
    00726 # FILTER_SOURCE_FILES is enabled.
    00727
    00728 FILTER_SOURCE_PATTERNS =
    00729
    00730 #---------------------------------------------------------------------------
    00731 # configuration options related to source browsing
    00732 #---------------------------------------------------------------------------
    00733
    00734 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
    00735 # be generated. Documented entities will be cross-referenced with these sources.
    00736 # Note: To get rid of all source code in the generated output, make sure also
    00737 # VERBATIM_HEADERS is set to NO.
    00738
    00739 SOURCE_BROWSER         = YES
    00740
    00741 # Setting the INLINE_SOURCES tag to YES will include the body
    00742 # of functions and classes directly in the documentation.
    00743
    00744 INLINE_SOURCES         = NO
    00745
    00746 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
    00747 # doxygen to hide any special comment blocks from generated source code
    00748 # fragments. Normal C and C++ comments will always remain visible.
    00749
    00750 STRIP_CODE_COMMENTS    = YES
    00751
    00752 # If the REFERENCED_BY_RELATION tag is set to YES
    00753 # then for each documented function all documented
    00754 # functions referencing it will be listed.
    00755
    00756 REFERENCED_BY_RELATION = YES
    00757
    00758 # If the REFERENCES_RELATION tag is set to YES
    00759 # then for each documented function all documented entities
    00760 # called/used by that function will be listed.
    00761
    00762 REFERENCES_RELATION    = YES
    00763
    00764 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
    00765 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
    00766 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
    00767 # link to the source code.  Otherwise they will link to the documentation.
    00768
    00769 REFERENCES_LINK_SOURCE = YES
    00770
    00771 # If the USE_HTAGS tag is set to YES then the references to source code
    00772 # will point to the HTML generated by the htags(1) tool instead of doxygen
    00773 # built-in source browser. The htags tool is part of GNU's global source
    00774 # tagging system (see http://www.gnu.org/software/global/global.html). You
    00775 # will need version 4.8.6 or higher.
    00776
    00777 USE_HTAGS              = NO
    00778
    00779 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
    00780 # will generate a verbatim copy of the header file for each class for
    00781 # which an include is specified. Set to NO to disable this.
    00782
    00783 VERBATIM_HEADERS       = YES
    00784
    00785 #---------------------------------------------------------------------------
    00786 # configuration options related to the alphabetical class index
    00787 #---------------------------------------------------------------------------
    00788
    00789 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
    00790 # of all compounds will be generated. Enable this if the project
    00791 # contains a lot of classes, structs, unions or interfaces.
    00792
    00793 ALPHABETICAL_INDEX     = NO
    00794
    00795 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
    00796 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
    00797 # in which this list will be split (can be a number in the range [1..20])
    00798
    00799 COLS_IN_ALPHA_INDEX    = 5
    00800
    00801 # In case all classes in a project start with a common prefix, all
    00802 # classes will be put under the same header in the alphabetical index.
    00803 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
    00804 # should be ignored while generating the index headers.
    00805
    00806 IGNORE_PREFIX          =
    00807
    00808 #---------------------------------------------------------------------------
    00809 # configuration options related to the HTML output
    00810 #---------------------------------------------------------------------------
    00811
    00812 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
    00813 # generate HTML output.
    00814
    00815 GENERATE_HTML          = YES
    00816
    00817 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
    00818 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
    00819 # put in front of it. If left blank `html' will be used as the default path.
    00820
    00821 HTML_OUTPUT            = html
    00822
    00823 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
    00824 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
    00825 # doxygen will generate files with .html extension.
    00826
    00827 HTML_FILE_EXTENSION    = .html
    00828
    00829 # The HTML_HEADER tag can be used to specify a personal HTML header for
    00830 # each generated HTML page. If it is left blank doxygen will generate a
    00831 # standard header.
    00832
    00833 HTML_HEADER            =
    00834
    00835 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
    00836 # each generated HTML page. If it is left blank doxygen will generate a
    00837 # standard footer.
    00838
    00839 HTML_FOOTER            =
    00840
    00841 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
    00842 # style sheet that is used by each HTML page. It can be used to
    00843 # fine-tune the look of the HTML output. If the tag is left blank doxygen
    00844 # will generate a default style sheet. Note that doxygen will try to copy
    00845 # the style sheet file to the HTML output directory, so don't put your own
    00846 # stylesheet in the HTML output directory as well, or it will be erased!
    00847
    00848 HTML_STYLESHEET        =
    00849
    00850 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
    00851 # Doxygen will adjust the colors in the stylesheet and background images
    00852 # according to this color. Hue is specified as an angle on a colorwheel,
    00853 # see http://en.wikipedia.org/wiki/Hue for more information.
    00854 # For instance the value 0 represents red, 60 is yellow, 120 is green,
    00855 # 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
    00856 # The allowed range is 0 to 359.
    00857
    00858 HTML_COLORSTYLE_HUE    = 220
    00859
    00860 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
    00861 # the colors in the HTML output. For a value of 0 the output will use
    00862 # grayscales only. A value of 255 will produce the most vivid colors.
    00863
    00864 HTML_COLORSTYLE_SAT    = 100
    00865
    00866 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
    00867 # the luminance component of the colors in the HTML output. Values below
    00868 # 100 gradually make the output lighter, whereas values above 100 make
    00869 # the output darker. The value divided by 100 is the actual gamma applied,
    00870 # so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
    00871 # and 100 does not change the gamma.
    00872
    00873 HTML_COLORSTYLE_GAMMA  = 80
    00874
    00875 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
    00876 # page will contain the date and time when the page was generated. Setting
    00877 # this to NO can help when comparing the output of multiple runs.
    00878
    00879 HTML_TIMESTAMP         = NO
    00880
    00881 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
    00882 # files or namespaces will be aligned in HTML using tables. If set to
    00883 # NO a bullet list will be used.
    00884
    00885 HTML_ALIGN_MEMBERS     = YES
    00886
    00887 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
    00888 # documentation will contain sections that can be hidden and shown after the
    00889 # page has loaded. For this to work a browser that supports
    00890 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
    00891 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
    00892
    00893 HTML_DYNAMIC_SECTIONS  = NO
    00894
    00895 # If the GENERATE_DOCSET tag is set to YES, additional index files
    00896 # will be generated that can be used as input for Apple's Xcode 3
    00897 # integrated development environment, introduced with OSX 10.5 (Leopard).
    00898 # To create a documentation set, doxygen will generate a Makefile in the
    00899 # HTML output directory. Running make will produce the docset in that
    00900 # directory and running "make install" will install the docset in
    00901 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
    00902 # it at startup.
    00903 # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
    00904 # for more information.
    00905
    00906 GENERATE_DOCSET        = NO
    00907
    00908 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
    00909 # feed. A documentation feed provides an umbrella under which multiple
    00910 # documentation sets from a single provider (such as a company or product suite)
    00911 # can be grouped.
    00912
    00913 DOCSET_FEEDNAME        = "Doxygen generated docs"
    00914
    00915 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
    00916 # should uniquely identify the documentation set bundle. This should be a
    00917 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
    00918 # will append .docset to the name.
    00919
    00920 DOCSET_BUNDLE_ID       = org.doxygen.Project
    00921
    00922 # When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify
    00923 # the documentation publisher. This should be a reverse domain-name style
    00924 # string, e.g. com.mycompany.MyDocSet.documentation.
    00925
    00926 DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
    00927
    00928 # The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
    00929
    00930 DOCSET_PUBLISHER_NAME  = Publisher
    00931
    00932 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
    00933 # will be generated that can be used as input for tools like the
    00934 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
    00935 # of the generated HTML documentation.
    00936
    00937 GENERATE_HTMLHELP      = NO
    00938
    00939 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
    00940 # be used to specify the file name of the resulting .chm file. You
    00941 # can add a path in front of the file if the result should not be
    00942 # written to the html output directory.
    00943
    00944 CHM_FILE               =
    00945
    00946 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
    00947 # be used to specify the location (absolute path including file name) of
    00948 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
    00949 # the HTML help compiler on the generated index.hhp.
    00950
    00951 HHC_LOCATION           =
    00952
    00953 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
    00954 # controls if a separate .chi index file is generated (YES) or that
    00955 # it should be included in the master .chm file (NO).
    00956
    00957 GENERATE_CHI           = NO
    00958
    00959 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
    00960 # is used to encode HtmlHelp index (hhk), content (hhc) and project file
    00961 # content.
    00962
    00963 CHM_INDEX_ENCODING     =
    00964
    00965 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
    00966 # controls whether a binary table of contents is generated (YES) or a
    00967 # normal table of contents (NO) in the .chm file.
    00968
    00969 BINARY_TOC             = NO
    00970
    00971 # The TOC_EXPAND flag can be set to YES to add extra items for group members
    00972 # to the contents of the HTML help documentation and to the tree view.
    00973
    00974 TOC_EXPAND             = NO
    00975
    00976 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
    00977 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
    00978 # that can be used as input for Qt's qhelpgenerator to generate a
    00979 # Qt Compressed Help (.qch) of the generated HTML documentation.
    00980
    00981 GENERATE_QHP           = NO
    00982
    00983 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can
    00984 # be used to specify the file name of the resulting .qch file.
    00985 # The path specified is relative to the HTML output folder.
    00986
    00987 QCH_FILE               =
    00988
    00989 # The QHP_NAMESPACE tag specifies the namespace to use when generating
    00990 # Qt Help Project output. For more information please see
    00991 # http://doc.trolltech.com/qthelpproject.html#namespace
    00992
    00993 QHP_NAMESPACE          = org.doxygen.Project
    00994
    00995 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
    00996 # Qt Help Project output. For more information please see
    00997 # http://doc.trolltech.com/qthelpproject.html#virtual-folders
    00998
    00999 QHP_VIRTUAL_FOLDER     = doc
    01000
    01001 # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
    01002 # add. For more information please see
    01003 # http://doc.trolltech.com/qthelpproject.html#custom-filters
    01004
    01005 QHP_CUST_FILTER_NAME   =
    01006
    01007 # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
    01008 # custom filter to add. For more information please see
    01009 # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
    01010 # Qt Help Project / Custom Filters</a>.
    01011
    01012 QHP_CUST_FILTER_ATTRS  =
    01013
    01014 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
    01015 # project's
    01016 # filter section matches.
    01017 # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
    01018 # Qt Help Project / Filter Attributes</a>.
    01019
    01020 QHP_SECT_FILTER_ATTRS  =
    01021
    01022 # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
    01023 # be used to specify the location of Qt's qhelpgenerator.
    01024 # If non-empty doxygen will try to run qhelpgenerator on the generated
    01025 # .qhp file.
    01026
    01027 QHG_LOCATION           =
    01028
    01029 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
    01030 # will be generated, which together with the HTML files, form an Eclipse help
    01031 # plugin. To install this plugin and make it available under the help contents
    01032 # menu in Eclipse, the contents of the directory containing the HTML and XML
    01033 # files needs to be copied into the plugins directory of eclipse. The name of
    01034 # the directory within the plugins directory should be the same as
    01035 # the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
    01036 # the help appears.
    01037
    01038 GENERATE_ECLIPSEHELP   = NO
    01039
    01040 # A unique identifier for the eclipse help plugin. When installing the plugin
    01041 # the directory name containing the HTML and XML files should also have
    01042 # this name.
    01043
    01044 ECLIPSE_DOC_ID         = org.doxygen.Project
    01045
    01046 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
    01047 # top of each HTML page. The value NO (the default) enables the index and
    01048 # the value YES disables it.
    01049
    01050 DISABLE_INDEX          = NO
    01051
    01052 # This tag can be used to set the number of enum values (range [0,1..20])
    01053 # that doxygen will group on one line in the generated HTML documentation.
    01054 # Note that a value of 0 will completely suppress the enum values from
    01055 # appearing in the overview section.
    01056
    01057 ENUM_VALUES_PER_LINE   = 4
    01058
    01059 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
    01060 # structure should be generated to display hierarchical information.
    01061 # If the tag value is set to YES, a side panel will be generated
    01062 # containing a tree-like index structure (just like the one that
    01063 # is generated for HTML Help). For this to work a browser that supports
    01064 # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
    01065 # Windows users are probably better off using the HTML help feature.
    01066
    01067 GENERATE_TREEVIEW      = NO
    01068
    01069 # By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
    01070 # and Class Hierarchy pages using a tree view instead of an ordered list.
    01071
    01072 USE_INLINE_TREES       = NO
    01073
    01074 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
    01075 # used to set the initial width (in pixels) of the frame in which the tree
    01076 # is shown.
    01077
    01078 TREEVIEW_WIDTH         = 250
    01079
    01080 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
    01081 # links to external symbols imported via tag files in a separate window.
    01082
    01083 EXT_LINKS_IN_WINDOW    = NO
    01084
    01085 # Use this tag to change the font size of Latex formulas included
    01086 # as images in the HTML documentation. The default is 10. Note that
    01087 # when you change the font size after a successful doxygen run you need
    01088 # to manually remove any form_*.png images from the HTML output directory
    01089 # to force them to be regenerated.
    01090
    01091 FORMULA_FONTSIZE       = 10
    01092
    01093 # Use the FORMULA_TRANPARENT tag to determine whether or not the images
    01094 # generated for formulas are transparent PNGs. Transparent PNGs are
    01095 # not supported properly for IE 6.0, but are supported on all modern browsers.
    01096 # Note that when changing this option you need to delete any form_*.png files
    01097 # in the HTML output before the changes have effect.
    01098
    01099 FORMULA_TRANSPARENT    = YES
    01100
    01101 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax
    01102 # (see http://www.mathjax.org) which uses client side Javascript for the
    01103 # rendering instead of using prerendered bitmaps. Use this if you do not
    01104 # have LaTeX installed or if you want to formulas look prettier in the HTML
    01105 # output. When enabled you also need to install MathJax separately and
    01106 # configure the path to it using the MATHJAX_RELPATH option.
    01107
    01108 USE_MATHJAX            = NO
    01109
    01110 # When MathJax is enabled you need to specify the location relative to the
    01111 # HTML output directory using the MATHJAX_RELPATH option. The destination
    01112 # directory should contain the MathJax.js script. For instance, if the mathjax
    01113 # directory is located at the same level as the HTML output directory, then
    01114 # MATHJAX_RELPATH should be ../mathjax. The default value points to the
    01115 # mathjax.org site, so you can quickly see the result without installing
    01116 # MathJax, but it is strongly recommended to install a local copy of MathJax
    01117 # before deployment.
    01118
    01119 MATHJAX_RELPATH        = http://www.mathjax.org/mathjax
    01120
    01121 # When the SEARCHENGINE tag is enabled doxygen will generate a search box
    01122 # for the HTML output. The underlying search engine uses javascript
    01123 # and DHTML and should work on any modern browser. Note that when using
    01124 # HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
    01125 # (GENERATE_DOCSET) there is already a search function so this one should
    01126 # typically be disabled. For large projects the javascript based search engine
    01127 # can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
    01128
    01129 SEARCHENGINE           = NO
    01130
    01131 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
    01132 # implemented using a PHP enabled web server instead of at the web client
    01133 # using Javascript. Doxygen will generate the search PHP script and index
    01134 # file to put on the web server. The advantage of the server
    01135 # based approach is that it scales better to large projects and allows
    01136 # full text search. The disadvantages are that it is more difficult to setup
    01137 # and does not have live searching capabilities.
    01138
    01139 SERVER_BASED_SEARCH    = NO
    01140
    01141 #---------------------------------------------------------------------------
    01142 # configuration options related to the LaTeX output
    01143 #---------------------------------------------------------------------------
    01144
    01145 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
    01146 # generate Latex output.
    01147
    01148 GENERATE_LATEX         = NO
    01149
    01150 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
    01151 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
    01152 # put in front of it. If left blank `latex' will be used as the default path.
    01153
    01154 LATEX_OUTPUT           = latex
    01155
    01156 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
    01157 # invoked. If left blank `latex' will be used as the default command name.
    01158 # Note that when enabling USE_PDFLATEX this option is only used for
    01159 # generating bitmaps for formulas in the HTML output, but not in the
    01160 # Makefile that is written to the output directory.
    01161
    01162 LATEX_CMD_NAME         = latex
    01163
    01164 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
    01165 # generate index for LaTeX. If left blank `makeindex' will be used as the
    01166 # default command name.
    01167
    01168 MAKEINDEX_CMD_NAME     = makeindex
    01169
    01170 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
    01171 # LaTeX documents. This may be useful for small projects and may help to
    01172 # save some trees in general.
    01173
    01174 COMPACT_LATEX          = NO
    01175
    01176 # The PAPER_TYPE tag can be used to set the paper type that is used
    01177 # by the printer. Possible values are: a4, letter, legal and
    01178 # executive. If left blank a4wide will be used.
    01179
    01180 PAPER_TYPE             = a4wide
    01181
    01182 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
    01183 # packages that should be included in the LaTeX output.
    01184
    01185 EXTRA_PACKAGES         =
    01186
    01187 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
    01188 # the generated latex document. The header should contain everything until
    01189 # the first chapter. If it is left blank doxygen will generate a
    01190 # standard header. Notice: only use this tag if you know what you are doing!
    01191
    01192 LATEX_HEADER           =
    01193
    01194 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
    01195 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
    01196 # contain links (just like the HTML output) instead of page references
    01197 # This makes the output suitable for online browsing using a pdf viewer.
    01198
    01199 PDF_HYPERLINKS         = NO
    01200
    01201 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
    01202 # plain latex in the generated Makefile. Set this option to YES to get a
    01203 # higher quality PDF documentation.
    01204
    01205 USE_PDFLATEX           = YES
    01206
    01207 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
    01208 # command to the generated LaTeX files. This will instruct LaTeX to keep
    01209 # running if errors occur, instead of asking the user for help.
    01210 # This option is also used when generating formulas in HTML.
    01211
    01212 LATEX_BATCHMODE        = NO
    01213
    01214 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
    01215 # include the index chapters (such as File Index, Compound Index, etc.)
    01216 # in the output.
    01217
    01218 LATEX_HIDE_INDICES     = NO
    01219
    01220 # If LATEX_SOURCE_CODE is set to YES then doxygen will include
    01221 # source code with syntax highlighting in the LaTeX output.
    01222 # Note that which sources are shown also depends on other settings
    01223 # such as SOURCE_BROWSER.
    01224
    01225 LATEX_SOURCE_CODE      = NO
    01226
    01227 #---------------------------------------------------------------------------
    01228 # configuration options related to the RTF output
    01229 #---------------------------------------------------------------------------
    01230
    01231 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
    01232 # The RTF output is optimized for Word 97 and may not look very pretty with
    01233 # other RTF readers or editors.
    01234
    01235 GENERATE_RTF           = NO
    01236
    01237 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
    01238 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
    01239 # put in front of it. If left blank `rtf' will be used as the default path.
    01240
    01241 RTF_OUTPUT             = glm.rtf
    01242
    01243 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
    01244 # RTF documents. This may be useful for small projects and may help to
    01245 # save some trees in general.
    01246
    01247 COMPACT_RTF            = NO
    01248
    01249 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
    01250 # will contain hyperlink fields. The RTF file will
    01251 # contain links (just like the HTML output) instead of page references.
    01252 # This makes the output suitable for online browsing using WORD or other
    01253 # programs which support those fields.
    01254 # Note: wordpad (write) and others do not support links.
    01255
    01256 RTF_HYPERLINKS         = YES
    01257
    01258 # Load stylesheet definitions from file. Syntax is similar to doxygen's
    01259 # config file, i.e. a series of assignments. You only have to provide
    01260 # replacements, missing definitions are set to their default value.
    01261
    01262 RTF_STYLESHEET_FILE    =
    01263
    01264 # Set optional variables used in the generation of an rtf document.
    01265 # Syntax is similar to doxygen's config file.
    01266
    01267 RTF_EXTENSIONS_FILE    =
    01268
    01269 #---------------------------------------------------------------------------
    01270 # configuration options related to the man page output
    01271 #---------------------------------------------------------------------------
    01272
    01273 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
    01274 # generate man pages
    01275
    01276 GENERATE_MAN           = NO
    01277
    01278 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
    01279 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
    01280 # put in front of it. If left blank `man' will be used as the default path.
    01281
    01282 MAN_OUTPUT             = man
    01283
    01284 # The MAN_EXTENSION tag determines the extension that is added to
    01285 # the generated man pages (default is the subroutine's section .3)
    01286
    01287 MAN_EXTENSION          = .3
    01288
    01289 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
    01290 # then it will generate one additional man file for each entity
    01291 # documented in the real man page(s). These additional files
    01292 # only source the real man page, but without them the man command
    01293 # would be unable to find the correct page. The default is NO.
    01294
    01295 MAN_LINKS              = NO
    01296
    01297 #---------------------------------------------------------------------------
    01298 # configuration options related to the XML output
    01299 #---------------------------------------------------------------------------
    01300
    01301 # If the GENERATE_XML tag is set to YES Doxygen will
    01302 # generate an XML file that captures the structure of
    01303 # the code including all documentation.
    01304
    01305 GENERATE_XML           = NO
    01306
    01307 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
    01308 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
    01309 # put in front of it. If left blank `xml' will be used as the default path.
    01310
    01311 XML_OUTPUT             = xml
    01312
    01313 # The XML_SCHEMA tag can be used to specify an XML schema,
    01314 # which can be used by a validating XML parser to check the
    01315 # syntax of the XML files.
    01316
    01317 XML_SCHEMA             =
    01318
    01319 # The XML_DTD tag can be used to specify an XML DTD,
    01320 # which can be used by a validating XML parser to check the
    01321 # syntax of the XML files.
    01322
    01323 XML_DTD                =
    01324
    01325 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
    01326 # dump the program listings (including syntax highlighting
    01327 # and cross-referencing information) to the XML output. Note that
    01328 # enabling this will significantly increase the size of the XML output.
    01329
    01330 XML_PROGRAMLISTING     = YES
    01331
    01332 #---------------------------------------------------------------------------
    01333 # configuration options for the AutoGen Definitions output
    01334 #---------------------------------------------------------------------------
    01335
    01336 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
    01337 # generate an AutoGen Definitions (see autogen.sf.net) file
    01338 # that captures the structure of the code including all
    01339 # documentation. Note that this feature is still experimental
    01340 # and incomplete at the moment.
    01341
    01342 GENERATE_AUTOGEN_DEF   = NO
    01343
    01344 #---------------------------------------------------------------------------
    01345 # configuration options related to the Perl module output
    01346 #---------------------------------------------------------------------------
    01347
    01348 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
    01349 # generate a Perl module file that captures the structure of
    01350 # the code including all documentation. Note that this
    01351 # feature is still experimental and incomplete at the
    01352 # moment.
    01353
    01354 GENERATE_PERLMOD       = NO
    01355
    01356 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
    01357 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
    01358 # to generate PDF and DVI output from the Perl module output.
    01359
    01360 PERLMOD_LATEX          = NO
    01361
    01362 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
    01363 # nicely formatted so it can be parsed by a human reader.  This is useful
    01364 # if you want to understand what is going on.  On the other hand, if this
    01365 # tag is set to NO the size of the Perl module output will be much smaller
    01366 # and Perl will parse it just the same.
    01367
    01368 PERLMOD_PRETTY         = YES
    01369
    01370 # The names of the make variables in the generated doxyrules.make file
    01371 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
    01372 # This is useful so different doxyrules.make files included by the same
    01373 # Makefile don't overwrite each other's variables.
    01374
    01375 PERLMOD_MAKEVAR_PREFIX =
    01376
    01377 #---------------------------------------------------------------------------
    01378 # Configuration options related to the preprocessor
    01379 #---------------------------------------------------------------------------
    01380
    01381 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
    01382 # evaluate all C-preprocessor directives found in the sources and include
    01383 # files.
    01384
    01385 ENABLE_PREPROCESSING   = YES
    01386
    01387 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
    01388 # names in the source code. If set to NO (the default) only conditional
    01389 # compilation will be performed. Macro expansion can be done in a controlled
    01390 # way by setting EXPAND_ONLY_PREDEF to YES.
    01391
    01392 MACRO_EXPANSION        = NO
    01393
    01394 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
    01395 # then the macro expansion is limited to the macros specified with the
    01396 # PREDEFINED and EXPAND_AS_DEFINED tags.
    01397
    01398 EXPAND_ONLY_PREDEF     = NO
    01399
    01400 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
    01401 # in the INCLUDE_PATH (see below) will be search if a #include is found.
    01402
    01403 SEARCH_INCLUDES        = YES
    01404
    01405 # The INCLUDE_PATH tag can be used to specify one or more directories that
    01406 # contain include files that are not input files but should be processed by
    01407 # the preprocessor.
    01408
    01409 INCLUDE_PATH           =
    01410
    01411 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
    01412 # patterns (like *.h and *.hpp) to filter out the header-files in the
    01413 # directories. If left blank, the patterns specified with FILE_PATTERNS will
    01414 # be used.
    01415
    01416 INCLUDE_FILE_PATTERNS  =
    01417
    01418 # The PREDEFINED tag can be used to specify one or more macro names that
    01419 # are defined before the preprocessor is started (similar to the -D option of
    01420 # gcc). The argument of the tag is a list of macros of the form: name
    01421 # or name=definition (no spaces). If the definition and the = are
    01422 # omitted =1 is assumed. To prevent a macro definition from being
    01423 # undefined via #undef or recursively expanded use the := operator
    01424 # instead of the = operator.
    01425
    01426 PREDEFINED             =
    01427
    01428 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
    01429 # this tag can be used to specify a list of macro names that should be expanded.
    01430 # The macro definition that is found in the sources will be used.
    01431 # Use the PREDEFINED tag if you want to use a different macro definition that
    01432 # overrules the definition found in the source code.
    01433
    01434 EXPAND_AS_DEFINED      =
    01435
    01436 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
    01437 # doxygen's preprocessor will remove all references to function-like macros
    01438 # that are alone on a line, have an all uppercase name, and do not end with a
    01439 # semicolon, because these will confuse the parser if not removed.
    01440
    01441 SKIP_FUNCTION_MACROS   = YES
    01442
    01443 #---------------------------------------------------------------------------
    01444 # Configuration::additions related to external references
    01445 #---------------------------------------------------------------------------
    01446
    01447 # The TAGFILES option can be used to specify one or more tagfiles.
    01448 # Optionally an initial location of the external documentation
    01449 # can be added for each tagfile. The format of a tag file without
    01450 # this location is as follows:
    01451 #   TAGFILES = file1 file2 ...
    01452 # Adding location for the tag files is done as follows:
    01453 #   TAGFILES = file1=loc1 "file2 = loc2" ...
    01454 # where "loc1" and "loc2" can be relative or absolute paths or
    01455 # URLs. If a location is present for each tag, the installdox tool
    01456 # does not have to be run to correct the links.
    01457 # Note that each tag file must have a unique name
    01458 # (where the name does NOT include the path)
    01459 # If a tag file is not located in the directory in which doxygen
    01460 # is run, you must also specify the path to the tagfile here.
    01461
    01462 TAGFILES               =
    01463
    01464 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
    01465 # a tag file that is based on the input files it reads.
    01466
    01467 GENERATE_TAGFILE       =
    01468
    01469 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
    01470 # in the class index. If set to NO only the inherited external classes
    01471 # will be listed.
    01472
    01473 ALLEXTERNALS           = NO
    01474
    01475 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
    01476 # in the modules index. If set to NO, only the current project's groups will
    01477 # be listed.
    01478
    01479 EXTERNAL_GROUPS        = YES
    01480
    01481 # The PERL_PATH should be the absolute path and name of the perl script
    01482 # interpreter (i.e. the result of `which perl').
    01483
    01484 PERL_PATH              = /usr/bin/perl
    01485
    01486 #---------------------------------------------------------------------------
    01487 # Configuration options related to the dot tool
    01488 #---------------------------------------------------------------------------
    01489
    01490 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
    01491 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
    01492 # or super classes. Setting the tag to NO turns the diagrams off. Note that
    01493 # this option also works with HAVE_DOT disabled, but it is recommended to
    01494 # install and use dot, since it yields more powerful graphs.
    01495
    01496 CLASS_DIAGRAMS         = YES
    01497
    01498 # You can define message sequence charts within doxygen comments using the \msc
    01499 # command. Doxygen will then run the mscgen tool (see
    01500 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
    01501 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
    01502 # the mscgen tool resides. If left empty the tool is assumed to be found in the
    01503 # default search path.
    01504
    01505 MSCGEN_PATH            =
    01506
    01507 # If set to YES, the inheritance and collaboration graphs will hide
    01508 # inheritance and usage relations if the target is undocumented
    01509 # or is not a class.
    01510
    01511 HIDE_UNDOC_RELATIONS   = YES
    01512
    01513 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
    01514 # available from the path. This tool is part of Graphviz, a graph visualization
    01515 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
    01516 # have no effect if this option is set to NO (the default)
    01517
    01518 HAVE_DOT               = NO
    01519
    01520 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
    01521 # allowed to run in parallel. When set to 0 (the default) doxygen will
    01522 # base this on the number of processors available in the system. You can set it
    01523 # explicitly to a value larger than 0 to get control over the balance
    01524 # between CPU load and processing speed.
    01525
    01526 DOT_NUM_THREADS        = 0
    01527
    01528 # By default doxygen will write a font called Helvetica to the output
    01529 # directory and reference it in all dot files that doxygen generates.
    01530 # When you want a differently looking font you can specify the font name
    01531 # using DOT_FONTNAME. You need to make sure dot is able to find the font,
    01532 # which can be done by putting it in a standard location or by setting the
    01533 # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
    01534 # containing the font.
    01535
    01536 DOT_FONTNAME           = FreeSans
    01537
    01538 # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
    01539 # The default size is 10pt.
    01540
    01541 DOT_FONTSIZE           = 10
    01542
    01543 # By default doxygen will tell dot to use the output directory to look for the
    01544 # FreeSans.ttf font (which doxygen will put there itself). If you specify a
    01545 # different font using DOT_FONTNAME you can set the path where dot
    01546 # can find it using this tag.
    01547
    01548 DOT_FONTPATH           =
    01549
    01550 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
    01551 # will generate a graph for each documented class showing the direct and
    01552 # indirect inheritance relations. Setting this tag to YES will force the
    01553 # the CLASS_DIAGRAMS tag to NO.
    01554
    01555 CLASS_GRAPH            = YES
    01556
    01557 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
    01558 # will generate a graph for each documented class showing the direct and
    01559 # indirect implementation dependencies (inheritance, containment, and
    01560 # class references variables) of the class with other documented classes.
    01561
    01562 COLLABORATION_GRAPH    = YES
    01563
    01564 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
    01565 # will generate a graph for groups, showing the direct groups dependencies
    01566
    01567 GROUP_GRAPHS           = YES
    01568
    01569 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
    01570 # collaboration diagrams in a style similar to the OMG's Unified Modeling
    01571 # Language.
    01572
    01573 UML_LOOK               = NO
    01574
    01575 # If set to YES, the inheritance and collaboration graphs will show the
    01576 # relations between templates and their instances.
    01577
    01578 TEMPLATE_RELATIONS     = NO
    01579
    01580 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
    01581 # tags are set to YES then doxygen will generate a graph for each documented
    01582 # file showing the direct and indirect include dependencies of the file with
    01583 # other documented files.
    01584
    01585 INCLUDE_GRAPH          = YES
    01586
    01587 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
    01588 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
    01589 # documented header file showing the documented files that directly or
    01590 # indirectly include this file.
    01591
    01592 INCLUDED_BY_GRAPH      = YES
    01593
    01594 # If the CALL_GRAPH and HAVE_DOT options are set to YES then
    01595 # doxygen will generate a call dependency graph for every global function
    01596 # or class method. Note that enabling this option will significantly increase
    01597 # the time of a run. So in most cases it will be better to enable call graphs
    01598 # for selected functions only using the \callgraph command.
    01599
    01600 CALL_GRAPH             = YES
    01601
    01602 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
    01603 # doxygen will generate a caller dependency graph for every global function
    01604 # or class method. Note that enabling this option will significantly increase
    01605 # the time of a run. So in most cases it will be better to enable caller
    01606 # graphs for selected functions only using the \callergraph command.
    01607
    01608 CALLER_GRAPH           = YES
    01609
    01610 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
    01611 # will generate a graphical hierarchy of all classes instead of a textual one.
    01612
    01613 GRAPHICAL_HIERARCHY    = YES
    01614
    01615 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
    01616 # then doxygen will show the dependencies a directory has on other directories
    01617 # in a graphical way. The dependency relations are determined by the #include
    01618 # relations between the files in the directories.
    01619
    01620 DIRECTORY_GRAPH        = YES
    01621
    01622 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
    01623 # generated by dot. Possible values are png, svg, gif or svg.
    01624 # If left blank png will be used.
    01625
    01626 DOT_IMAGE_FORMAT       = png
    01627
    01628 # The tag DOT_PATH can be used to specify the path where the dot tool can be
    01629 # found. If left blank, it is assumed the dot tool can be found in the path.
    01630
    01631 DOT_PATH               =
    01632
    01633 # The DOTFILE_DIRS tag can be used to specify one or more directories that
    01634 # contain dot files that are included in the documentation (see the
    01635 # \dotfile command).
    01636
    01637 DOTFILE_DIRS           =
    01638
    01639 # The MSCFILE_DIRS tag can be used to specify one or more directories that
    01640 # contain msc files that are included in the documentation (see the
    01641 # \mscfile command).
    01642
    01643 MSCFILE_DIRS           =
    01644
    01645 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
    01646 # nodes that will be shown in the graph. If the number of nodes in a graph
    01647 # becomes larger than this value, doxygen will truncate the graph, which is
    01648 # visualized by representing a node as a red box. Note that doxygen if the
    01649 # number of direct children of the root node in a graph is already larger than
    01650 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
    01651 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
    01652
    01653 DOT_GRAPH_MAX_NODES    = 50
    01654
    01655 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
    01656 # graphs generated by dot. A depth value of 3 means that only nodes reachable
    01657 # from the root by following a path via at most 3 edges will be shown. Nodes
    01658 # that lay further from the root node will be omitted. Note that setting this
    01659 # option to 1 or 2 may greatly reduce the computation time needed for large
    01660 # code bases. Also note that the size of a graph can be further restricted by
    01661 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
    01662
    01663 MAX_DOT_GRAPH_DEPTH    = 1000
    01664
    01665 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
    01666 # background. This is disabled by default, because dot on Windows does not
    01667 # seem to support this out of the box. Warning: Depending on the platform used,
    01668 # enabling this option may lead to badly anti-aliased labels on the edges of
    01669 # a graph (i.e. they become hard to read).
    01670
    01671 DOT_TRANSPARENT        = NO
    01672
    01673 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
    01674 # files in one run (i.e. multiple -o and -T options on the command line). This
    01675 # makes dot run faster, but since only newer versions of dot (>1.8.10)
    01676 # support this, this feature is disabled by default.
    01677
    01678 DOT_MULTI_TARGETS      = NO
    01679
    01680 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
    01681 # generate a legend page explaining the meaning of the various boxes and
    01682 # arrows in the dot generated graphs.
    01683
    01684 GENERATE_LEGEND        = YES
    01685
    01686 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
    01687 # remove the intermediate dot files that are used to generate
    01688 # the various graphs.
    01689
    01690 DOT_CLEANUP            = YES