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 = Panda3D
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 = $(PANDA3D_VERSION)
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 =
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 = reference-cxx
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 = YES
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 = YES
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 = YES
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 =
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 = NO
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 = YES
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 = 2
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 = I=C++
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 = YES
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 = YES
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 = NO
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 = YES
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 = NO
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 = NO
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 = NO
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 = NO
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 = YES
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 = YES
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 = YES
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 = YES
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 = NO
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 = NO
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 = NO
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 = NO
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= NO
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 = YES
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 = YES
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 = NO
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 = dtool \
00616 panda \
00617 direct \
00618 pandatool \
00619 contrib
00620
00621 # This tag can be used to specify the character encoding of the source files
00622 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
00623 # also the default input encoding. Doxygen uses libiconv (or the iconv built
00624 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
00625 # the list of possible encodings.
00626
00627 INPUT_ENCODING = UTF-8
00628
00629 # If the value of the INPUT tag contains directories, you can use the
00630 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
00631 # and *.h) to filter out the source-files in the directories. If left
00632 # blank the following patterns are tested:
00633 # *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh
00634 # *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
00635 # *.f90 *.f *.for *.vhd *.vhdl
00636
00637 FILE_PATTERNS = *.cxx \
00638 *.h \
00639 *.c \
00640 *.I \
00641 *.cpp
00642
00643 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
00644 # should be searched for input files as well. Possible values are YES and NO.
00645 # If left blank NO is used.
00646
00647 RECURSIVE = YES
00648
00649 # The EXCLUDE tag can be used to specify files and/or directories that should
00650 # excluded from the INPUT source files. This way you can easily exclude a
00651 # subdirectory from a directory tree whose root is specified with the INPUT tag.
00652
00653 EXCLUDE = dtool/src/parser-inc \
00654 dtool/src/cppparser \
00655 dtool/src/interrogate \
00656 direct/src/plugin \
00657 direct/src/plugin_standalone \
00658 direct/src/plugin_npapi \
00659 direct/src/plugin_activex \
00660 dtool/src/test_interrogate \
00661 panda/src/linmath/fltnames.h \
panda/src/linmath/dblnames.h \
panda/src/linmath/dbl2fltnames.h \
panda/src/linmath/flt2dblnames.h
00662
00663 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
00664 # directories that are symbolic links (a Unix file system feature) are excluded
00665 # from the input.
00666
00667 EXCLUDE_SYMLINKS = NO
00668
00669 # If the value of the INPUT tag contains directories, you can use the
00670 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
00671 # certain files from those directories. Note that the wildcards are matched
00672 # against the file with absolute path, so to exclude all test directories
00673 # for example use the pattern */test
00674
00675 Opt*-*
00676 CVS
00677
00678
00679 test
00680 test_* \
00681 *_src.* \
00682 *_src_ext.* \
00683 *_ext_src.*
00684
00685 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
00686 # (namespaces, classes, functions, etc.) that should be excluded from the
00687 # output. The symbol name can be a fully qualified name, a word, or if the
00688 # wildcard * is used, a substring. Examples: ANamespace, AClass,
00689 # AClass::ANamespace, ANamespace::*Test
00690
00691 EXCLUDE_SYMBOLS =
00692
00693 # The EXAMPLE_PATH tag can be used to specify one or more files or
00694 # directories that contain example code fragments that are included (see
00695 # the \include command).
00696
00697 EXAMPLE_PATH =
00698
00699 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
00700 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
00701 # and *.h) to filter out the source-files in the directories. If left
00702 # blank all files are included.
00703
00704 EXAMPLE_PATTERNS = *
00705
00706 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
00707 # searched for input files to be used with the \include or \dontinclude
00708 # commands irrespective of the value of the RECURSIVE tag.
00709 # Possible values are YES and NO. If left blank NO is used.
00710
00711 EXAMPLE_RECURSIVE = NO
00712
00713 # The IMAGE_PATH tag can be used to specify one or more files or
00714 # directories that contain image that are included in the documentation (see
00715 # the \image command).
00716
00717 IMAGE_PATH =
00718
00719 # The INPUT_FILTER tag can be used to specify a program that doxygen should
00720 # invoke to filter for each input file. Doxygen will invoke the filter program
00721 # by executing (via popen()) the command <filter> <input-file>, where <filter>
00722 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
00723 # input file. Doxygen will then use the output that the filter program writes
00724 # to standard output. If FILTER_PATTERNS is specified, this tag will be
00725 # ignored.
00726
00727 INPUT_FILTER = "python direct/src/directscripts/doxygen_filter.py"
00728
00729 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
00730 # basis. Doxygen will compare the file name with each pattern and apply the
00731 # filter if there is a match. The filters are a list of the form:
00732 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
00733 # info on how filters are used. If FILTER_PATTERNS is empty or if
00734 # non of the patterns match the file name, INPUT_FILTER is applied.
00735
00736 FILTER_PATTERNS =
00737
00738 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
00739 # INPUT_FILTER) will be used to filter the input files when producing source
00740 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
00741
00742 FILTER_SOURCE_FILES = NO
00743
00744 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
00745 # pattern. A pattern will override the setting for FILTER_PATTERN (if any)
00746 # and it is also possible to disable source filtering for a specific pattern
00747 # using *.ext= (so without naming a filter). This option only has effect when
00748 # FILTER_SOURCE_FILES is enabled.
00749
00750 FILTER_SOURCE_PATTERNS =
00751
00752 #---------------------------------------------------------------------------
00753 # configuration options related to source browsing
00754 #---------------------------------------------------------------------------
00755
00756 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
00757 # be generated. Documented entities will be cross-referenced with these sources.
00758 # Note: To get rid of all source code in the generated output, make sure also
00759 # VERBATIM_HEADERS is set to NO.
00760
00761 SOURCE_BROWSER = YES
00762
00763 # Setting the INLINE_SOURCES tag to YES will include the body
00764 # of functions and classes directly in the documentation.
00765
00766 INLINE_SOURCES = NO
00767
00768 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
00769 # doxygen to hide any special comment blocks from generated source code
00770 # fragments. Normal C and C++ comments will always remain visible.
00771
00772 STRIP_CODE_COMMENTS = NO
00773
00774 # If the REFERENCED_BY_RELATION tag is set to YES
00775 # then for each documented function all documented
00776 # functions referencing it will be listed.
00777
00778 REFERENCED_BY_RELATION = YES
00779
00780 # If the REFERENCES_RELATION tag is set to YES
00781 # then for each documented function all documented entities
00782 # called/used by that function will be listed.
00783
00784 REFERENCES_RELATION = YES
00785
00786 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
00787 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
00788 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
00789 # link to the source code. Otherwise they will link to the documentation.
00790
00791 REFERENCES_LINK_SOURCE = YES
00792
00793 # If the USE_HTAGS tag is set to YES then the references to source code
00794 # will point to the HTML generated by the htags(1) tool instead of doxygen
00795 # built-in source browser. The htags tool is part of GNU's global source
00796 # tagging system (see http://www.gnu.org/software/global/global.html). You
00797 # will need version 4.8.6 or higher.
00798
00799 USE_HTAGS = NO
00800
00801 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
00802 # will generate a verbatim copy of the header file for each class for
00803 # which an include is specified. Set to NO to disable this.
00804
00805 VERBATIM_HEADERS = YES
00806
00807 #---------------------------------------------------------------------------
00808 # configuration options related to the alphabetical class index
00809 #---------------------------------------------------------------------------
00810
00811 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
00812 # of all compounds will be generated. Enable this if the project
00813 # contains a lot of classes, structs, unions or interfaces.
00814
00815 ALPHABETICAL_INDEX = YES
00816
00817 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
00818 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
00819 # in which this list will be split (can be a number in the range [1..20])
00820
00821 COLS_IN_ALPHA_INDEX = 5
00822
00823 # In case all classes in a project start with a common prefix, all
00824 # classes will be put under the same header in the alphabetical index.
00825 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
00826 # should be ignored while generating the index headers.
00827
00828 IGNORE_PREFIX =
00829
00830 #---------------------------------------------------------------------------
00831 # configuration options related to the HTML output
00832 #---------------------------------------------------------------------------
00833
00834 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
00835 # generate HTML output.
00836
00837 GENERATE_HTML = YES
00838
00839 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
00840 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
00841 # put in front of it. If left blank `html' will be used as the default path.
00842
00843 HTML_OUTPUT = html
00844
00845 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
00846 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
00847 # doxygen will generate files with .html extension.
00848
00849 HTML_FILE_EXTENSION = $(DOXYGEN_HTML_FILE_EXTENSION)
00850
00851 # The HTML_HEADER tag can be used to specify a personal HTML header for
00852 # each generated HTML page. If it is left blank doxygen will generate a
00853 # standard header.
00854
00855 HTML_HEADER = $(DOXYGEN_HTML_HEADER)
00856
00857 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
00858 # each generated HTML page. If it is left blank doxygen will generate a
00859 # standard footer.
00860
00861 HTML_FOOTER = $(DOXYGEN_HTML_FOOTER)
00862
00863 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
00864 # style sheet that is used by each HTML page. It can be used to
00865 # fine-tune the look of the HTML output. If the tag is left blank doxygen
00866 # will generate a default style sheet. Note that doxygen will try to copy
00867 # the style sheet file to the HTML output directory, so don't put your own
00868 # stylesheet in the HTML output directory as well, or it will be erased!
00869
00870 HTML_STYLESHEET = $(DOXYGEN_HTML_STYLESHEET)
00871
00872 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
00873 # Doxygen will adjust the colors in the stylesheet and background images
00874 # according to this color. Hue is specified as an angle on a colorwheel,
00875 # see http://en.wikipedia.org/wiki/Hue for more information.
00876 # For instance the value 0 represents red, 60 is yellow, 120 is green,
00877 # 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
00878 # The allowed range is 0 to 359.
00879
00880 HTML_COLORSTYLE_HUE = 220
00881
00882 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
00883 # the colors in the HTML output. For a value of 0 the output will use
00884 # grayscales only. A value of 255 will produce the most vivid colors.
00885
00886 HTML_COLORSTYLE_SAT = 100
00887
00888 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
00889 # the luminance component of the colors in the HTML output. Values below
00890 # 100 gradually make the output lighter, whereas values above 100 make
00891 # the output darker. The value divided by 100 is the actual gamma applied,
00892 # so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
00893 # and 100 does not change the gamma.
00894
00895 HTML_COLORSTYLE_GAMMA = 80
00896
00897 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
00898 # page will contain the date and time when the page was generated. Setting
00899 # this to NO can help when comparing the output of multiple runs.
00900
00901 HTML_TIMESTAMP = YES
00902
00903 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
00904 # files or namespaces will be aligned in HTML using tables. If set to
00905 # NO a bullet list will be used.
00906
00907 HTML_ALIGN_MEMBERS = YES
00908
00909 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
00910 # documentation will contain sections that can be hidden and shown after the
00911 # page has loaded. For this to work a browser that supports
00912 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
00913 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
00914
00915 HTML_DYNAMIC_SECTIONS = NO
00916
00917 # If the GENERATE_DOCSET tag is set to YES, additional index files
00918 # will be generated that can be used as input for Apple's Xcode 3
00919 # integrated development environment, introduced with OSX 10.5 (Leopard).
00920 # To create a documentation set, doxygen will generate a Makefile in the
00921 # HTML output directory. Running make will produce the docset in that
00922 # directory and running "make install" will install the docset in
00923 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
00924 # it at startup.
00925 # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
00926 # for more information.
00927
00928 GENERATE_DOCSET = NO
00929
00930 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
00931 # feed. A documentation feed provides an umbrella under which multiple
00932 # documentation sets from a single provider (such as a company or product suite)
00933 # can be grouped.
00934
00935 DOCSET_FEEDNAME = "Doxygen generated docs"
00936
00937 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
00938 # should uniquely identify the documentation set bundle. This should be a
00939 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
00940 # will append .docset to the name.
00941
00942 DOCSET_BUNDLE_ID = org.doxygen.Project
00943
00944 # When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify
00945 # the documentation publisher. This should be a reverse domain-name style
00946 # string, e.g. com.mycompany.MyDocSet.documentation.
00947
00948 DOCSET_PUBLISHER_ID = org.doxygen.Publisher
00949
00950 # The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
00951
00952 DOCSET_PUBLISHER_NAME = Publisher
00953
00954 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
00955 # will be generated that can be used as input for tools like the
00956 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
00957 # of the generated HTML documentation.
00958
00959 GENERATE_HTMLHELP = NO
00960
00961 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
00962 # be used to specify the file name of the resulting .chm file. You
00963 # can add a path in front of the file if the result should not be
00964 # written to the html output directory.
00965
00966 CHM_FILE =
00967
00968 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
00969 # be used to specify the location (absolute path including file name) of
00970 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
00971 # the HTML help compiler on the generated index.hhp.
00972
00973 HHC_LOCATION =
00974
00975 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
00976 # controls if a separate .chi index file is generated (YES) or that
00977 # it should be included in the master .chm file (NO).
00978
00979 GENERATE_CHI = NO
00980
00981 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
00982 # is used to encode HtmlHelp index (hhk), content (hhc) and project file
00983 # content.
00984
00985 CHM_INDEX_ENCODING =
00986
00987 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
00988 # controls whether a binary table of contents is generated (YES) or a
00989 # normal table of contents (NO) in the .chm file.
00990
00991 BINARY_TOC = NO
00992
00993 # The TOC_EXPAND flag can be set to YES to add extra items for group members
00994 # to the contents of the HTML help documentation and to the tree view.
00995
00996 TOC_EXPAND = NO
00997
00998 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
00999 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
01000 # that can be used as input for Qt's qhelpgenerator to generate a
01001 # Qt Compressed Help (.qch) of the generated HTML documentation.
01002
01003 GENERATE_QHP = NO
01004
01005 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can
01006 # be used to specify the file name of the resulting .qch file.
01007 # The path specified is relative to the HTML output folder.
01008
01009 QCH_FILE =
01010
01011 # The QHP_NAMESPACE tag specifies the namespace to use when generating
01012 # Qt Help Project output. For more information please see
01013 # http://doc.trolltech.com/qthelpproject.html#namespace
01014
01015 QHP_NAMESPACE = org.doxygen.Project
01016
01017 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
01018 # Qt Help Project output. For more information please see
01019 # http://doc.trolltech.com/qthelpproject.html#virtual-folders
01020
01021 QHP_VIRTUAL_FOLDER = doc
01022
01023 # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
01024 # add. For more information please see
01025 # http://doc.trolltech.com/qthelpproject.html#custom-filters
01026
01027 QHP_CUST_FILTER_NAME =
01028
01029 # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
01030 # custom filter to add. For more information please see
01031 # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
01032 # Qt Help Project / Custom Filters</a>.
01033
01034 QHP_CUST_FILTER_ATTRS =
01035
01036 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
01037 # project's
01038 # filter section matches.
01039 # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
01040 # Qt Help Project / Filter Attributes</a>.
01041
01042 QHP_SECT_FILTER_ATTRS =
01043
01044 # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
01045 # be used to specify the location of Qt's qhelpgenerator.
01046 # If non-empty doxygen will try to run qhelpgenerator on the generated
01047 # .qhp file.
01048
01049 QHG_LOCATION =
01050
01051 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
01052 # will be generated, which together with the HTML files, form an Eclipse help
01053 # plugin. To install this plugin and make it available under the help contents
01054 # menu in Eclipse, the contents of the directory containing the HTML and XML
01055 # files needs to be copied into the plugins directory of eclipse. The name of
01056 # the directory within the plugins directory should be the same as
01057 # the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
01058 # the help appears.
01059
01060 GENERATE_ECLIPSEHELP = NO
01061
01062 # A unique identifier for the eclipse help plugin. When installing the plugin
01063 # the directory name containing the HTML and XML files should also have
01064 # this name.
01065
01066 ECLIPSE_DOC_ID = org.doxygen.Project
01067
01068 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
01069 # top of each HTML page. The value NO (the default) enables the index and
01070 # the value YES disables it.
01071
01072 DISABLE_INDEX = NO
01073
01074 # This tag can be used to set the number of enum values (range [0,1..20])
01075 # that doxygen will group on one line in the generated HTML documentation.
01076 # Note that a value of 0 will completely suppress the enum values from
01077 # appearing in the overview section.
01078
01079 ENUM_VALUES_PER_LINE = 4
01080
01081 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
01082 # structure should be generated to display hierarchical information.
01083 # If the tag value is set to YES, a side panel will be generated
01084 # containing a tree-like index structure (just like the one that
01085 # is generated for HTML Help). For this to work a browser that supports
01086 # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
01087 # Windows users are probably better off using the HTML help feature.
01088
01089 GENERATE_TREEVIEW = NO
01090
01091 # By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
01092 # and Class Hierarchy pages using a tree view instead of an ordered list.
01093
01094 USE_INLINE_TREES = NO
01095
01096 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
01097 # used to set the initial width (in pixels) of the frame in which the tree
01098 # is shown.
01099
01100 TREEVIEW_WIDTH = 250
01101
01102 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
01103 # links to external symbols imported via tag files in a separate window.
01104
01105 EXT_LINKS_IN_WINDOW = NO
01106
01107 # Use this tag to change the font size of Latex formulas included
01108 # as images in the HTML documentation. The default is 10. Note that
01109 # when you change the font size after a successful doxygen run you need
01110 # to manually remove any form_*.png images from the HTML output directory
01111 # to force them to be regenerated.
01112
01113 FORMULA_FONTSIZE = 10
01114
01115 # Use the FORMULA_TRANPARENT tag to determine whether or not the images
01116 # generated for formulas are transparent PNGs. Transparent PNGs are
01117 # not supported properly for IE 6.0, but are supported on all modern browsers.
01118 # Note that when changing this option you need to delete any form_*.png files
01119 # in the HTML output before the changes have effect.
01120
01121 FORMULA_TRANSPARENT = YES
01122
01123 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax
01124 # (see http://www.mathjax.org) which uses client side Javascript for the
01125 # rendering instead of using prerendered bitmaps. Use this if you do not
01126 # have LaTeX installed or if you want to formulas look prettier in the HTML
01127 # output. When enabled you also need to install MathJax separately and
01128 # configure the path to it using the MATHJAX_RELPATH option.
01129
01130 USE_MATHJAX = NO
01131
01132 # When MathJax is enabled you need to specify the location relative to the
01133 # HTML output directory using the MATHJAX_RELPATH option. The destination
01134 # directory should contain the MathJax.js script. For instance, if the mathjax
01135 # directory is located at the same level as the HTML output directory, then
01136 # MATHJAX_RELPATH should be ../mathjax. The default value points to the
01137 # mathjax.org site, so you can quickly see the result without installing
01138 # MathJax, but it is strongly recommended to install a local copy of MathJax
01139 # before deployment.
01140
01141 MATHJAX_RELPATH = http:
01142
01143 # When the SEARCHENGINE tag is enabled doxygen will generate a search box
01144 # for the HTML output. The underlying search engine uses javascript
01145 # and DHTML and should work on any modern browser. Note that when using
01146 # HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
01147 # (GENERATE_DOCSET) there is already a search function so this one should
01148 # typically be disabled. For large projects the javascript based search engine
01149 # can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
01150
01151 SEARCHENGINE = YES
01152
01153 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
01154 # implemented using a PHP enabled web server instead of at the web client
01155 # using Javascript. Doxygen will generate the search PHP script and index
01156 # file to put on the web server. The advantage of the server
01157 # based approach is that it scales better to large projects and allows
01158 # full text search. The disadvantages are that it is more difficult to setup
01159 # and does not have live searching capabilities.
01160
01161 SERVER_BASED_SEARCH = NO
01162
01163 #---------------------------------------------------------------------------
01164 # configuration options related to the LaTeX output
01165 #---------------------------------------------------------------------------
01166
01167 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
01168 # generate Latex output.
01169
01170 GENERATE_LATEX = NO
01171
01172 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
01173 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
01174 # put in front of it. If left blank `latex' will be used as the default path.
01175
01176 LATEX_OUTPUT = latex
01177
01178 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
01179 # invoked. If left blank `latex' will be used as the default command name.
01180 # Note that when enabling USE_PDFLATEX this option is only used for
01181 # generating bitmaps for formulas in the HTML output, but not in the
01182 # Makefile that is written to the output directory.
01183
01184 LATEX_CMD_NAME = latex
01185
01186 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
01187 # generate index for LaTeX. If left blank `makeindex' will be used as the
01188 # default command name.
01189
01190 MAKEINDEX_CMD_NAME = makeindex
01191
01192 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
01193 # LaTeX documents. This may be useful for small projects and may help to
01194 # save some trees in general.
01195
01196 COMPACT_LATEX = NO
01197
01198 # The PAPER_TYPE tag can be used to set the paper type that is used
01199 # by the printer. Possible values are: a4, letter, legal and
01200 # executive. If left blank a4wide will be used.
01201
01202 PAPER_TYPE = a4wide
01203
01204 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
01205 # packages that should be included in the LaTeX output.
01206
01207 EXTRA_PACKAGES =
01208
01209 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
01210 # the generated latex document. The header should contain everything until
01211 # the first chapter. If it is left blank doxygen will generate a
01212 # standard header. Notice: only use this tag if you know what you are doing!
01213
01214 LATEX_HEADER =
01215
01216 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
01217 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
01218 # contain links (just like the HTML output) instead of page references
01219 # This makes the output suitable for online browsing using a pdf viewer.
01220
01221 PDF_HYPERLINKS = YES
01222
01223 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
01224 # plain latex in the generated Makefile. Set this option to YES to get a
01225 # higher quality PDF documentation.
01226
01227 USE_PDFLATEX = YES
01228
01229 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
01230 # command to the generated LaTeX files. This will instruct LaTeX to keep
01231 # running if errors occur, instead of asking the user for help.
01232 # This option is also used when generating formulas in HTML.
01233
01234 LATEX_BATCHMODE = NO
01235
01236 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
01237 # include the index chapters (such as File Index, Compound Index, etc.)
01238 # in the output.
01239
01240 LATEX_HIDE_INDICES = NO
01241
01242 # If LATEX_SOURCE_CODE is set to YES then doxygen will include
01243 # source code with syntax highlighting in the LaTeX output.
01244 # Note that which sources are shown also depends on other settings
01245 # such as SOURCE_BROWSER.
01246
01247 LATEX_SOURCE_CODE = NO
01248
01249 #---------------------------------------------------------------------------
01250 # configuration options related to the RTF output
01251 #---------------------------------------------------------------------------
01252
01253 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
01254 # The RTF output is optimized for Word 97 and may not look very pretty with
01255 # other RTF readers or editors.
01256
01257 GENERATE_RTF = NO
01258
01259 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
01260 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
01261 # put in front of it. If left blank `rtf' will be used as the default path.
01262
01263 RTF_OUTPUT = rtf
01264
01265 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
01266 # RTF documents. This may be useful for small projects and may help to
01267 # save some trees in general.
01268
01269 COMPACT_RTF = NO
01270
01271 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
01272 # will contain hyperlink fields. The RTF file will
01273 # contain links (just like the HTML output) instead of page references.
01274 # This makes the output suitable for online browsing using WORD or other
01275 # programs which support those fields.
01276 # Note: wordpad (write) and others do not support links.
01277
01278 RTF_HYPERLINKS = NO
01279
01280 # Load stylesheet definitions from file. Syntax is similar to doxygen's
01281 # config file, i.e. a series of assignments. You only have to provide
01282 # replacements, missing definitions are set to their default value.
01283
01284 RTF_STYLESHEET_FILE =
01285
01286 # Set optional variables used in the generation of an rtf document.
01287 # Syntax is similar to doxygen's config file.
01288
01289 RTF_EXTENSIONS_FILE =
01290
01291 #---------------------------------------------------------------------------
01292 # configuration options related to the man page output
01293 #---------------------------------------------------------------------------
01294
01295 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
01296 # generate man pages
01297
01298 GENERATE_MAN = NO
01299
01300 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
01301 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
01302 # put in front of it. If left blank `man' will be used as the default path.
01303
01304 MAN_OUTPUT = man
01305
01306 # The MAN_EXTENSION tag determines the extension that is added to
01307 # the generated man pages (default is the subroutine's section .3)
01308
01309 MAN_EXTENSION = .3
01310
01311 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
01312 # then it will generate one additional man file for each entity
01313 # documented in the real man page(s). These additional files
01314 # only source the real man page, but without them the man command
01315 # would be unable to find the correct page. The default is NO.
01316
01317 MAN_LINKS = NO
01318
01319 #---------------------------------------------------------------------------
01320 # configuration options related to the XML output
01321 #---------------------------------------------------------------------------
01322
01323 # If the GENERATE_XML tag is set to YES Doxygen will
01324 # generate an XML file that captures the structure of
01325 # the code including all documentation.
01326
01327 GENERATE_XML = NO
01328
01329 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
01330 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
01331 # put in front of it. If left blank `xml' will be used as the default path.
01332
01333 XML_OUTPUT = xml
01334
01335 # The XML_SCHEMA tag can be used to specify an XML schema,
01336 # which can be used by a validating XML parser to check the
01337 # syntax of the XML files.
01338
01339 XML_SCHEMA =
01340
01341 # The XML_DTD tag can be used to specify an XML DTD,
01342 # which can be used by a validating XML parser to check the
01343 # syntax of the XML files.
01344
01345 XML_DTD =
01346
01347 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
01348 # dump the program listings (including syntax highlighting
01349 # and cross-referencing information) to the XML output. Note that
01350 # enabling this will significantly increase the size of the XML output.
01351
01352 XML_PROGRAMLISTING = YES
01353
01354 #---------------------------------------------------------------------------
01355 # configuration options for the AutoGen Definitions output
01356 #---------------------------------------------------------------------------
01357
01358 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
01359 # generate an AutoGen Definitions (see autogen.sf.net) file
01360 # that captures the structure of the code including all
01361 # documentation. Note that this feature is still experimental
01362 # and incomplete at the moment.
01363
01364 GENERATE_AUTOGEN_DEF = NO
01365
01366 #---------------------------------------------------------------------------
01367 # configuration options related to the Perl module output
01368 #---------------------------------------------------------------------------
01369
01370 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
01371 # generate a Perl module file that captures the structure of
01372 # the code including all documentation. Note that this
01373 # feature is still experimental and incomplete at the
01374 # moment.
01375
01376 GENERATE_PERLMOD = NO
01377
01378 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
01379 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
01380 # to generate PDF and DVI output from the Perl module output.
01381
01382 PERLMOD_LATEX = NO
01383
01384 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
01385 # nicely formatted so it can be parsed by a human reader. This is useful
01386 # if you want to understand what is going on. On the other hand, if this
01387 # tag is set to NO the size of the Perl module output will be much smaller
01388 # and Perl will parse it just the same.
01389
01390 PERLMOD_PRETTY = YES
01391
01392 # The names of the make variables in the generated doxyrules.make file
01393 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
01394 # This is useful so different doxyrules.make files included by the same
01395 # Makefile don't overwrite each other's variables.
01396
01397 PERLMOD_MAKEVAR_PREFIX =
01398
01399 #---------------------------------------------------------------------------
01400 # Configuration options related to the preprocessor
01401 #---------------------------------------------------------------------------
01402
01403 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
01404 # evaluate all C-preprocessor directives found in the sources and include
01405 # files.
01406
01407 ENABLE_PREPROCESSING = YES
01408
01409 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
01410 # names in the source code. If set to NO (the default) only conditional
01411 # compilation will be performed. Macro expansion can be done in a controlled
01412 # way by setting EXPAND_ONLY_PREDEF to YES.
01413
01414 MACRO_EXPANSION = YES
01415
01416 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
01417 # then the macro expansion is limited to the macros specified with the
01418 # PREDEFINED and EXPAND_AS_DEFINED tags.
01419
01420 EXPAND_ONLY_PREDEF = NO
01421
01422 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
01423 # in the INCLUDE_PATH (see below) will be search if a #include is found.
01424
01425 SEARCH_INCLUDES = NO
01426
01427 # The INCLUDE_PATH tag can be used to specify one or more directories that
01428 # contain include files that are not input files but should be processed by
01429 # the preprocessor.
01430
01431 INCLUDE_PATH =
01432
01433 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
01434 # patterns (like *.h and *.hpp) to filter out the header-files in the
01435 # directories. If left blank, the patterns specified with FILE_PATTERNS will
01436 # be used.
01437
01438 INCLUDE_FILE_PATTERNS =
01439
01440 # The PREDEFINED tag can be used to specify one or more macro names that
01441 # are defined before the preprocessor is started (similar to the -D option of
01442 # gcc). The argument of the tag is a list of macros of the form: name
01443 # or name=definition (no spaces). If the definition and the = are
01444 # omitted =1 is assumed. To prevent a macro definition from being
01445 # undefined via #undef or recursively expanded use the := operator
01446 # instead of the = operator.
01447
01448 PREDEFINED = TVOLATILE= \
01449 INLINE=inline \
01450 PUBLISHED=public \
01451 INLINE_LINMATH=inline \
01452 INLINE_MATHUTIL=inline \
01453 EXTENSION(x)= \
01454 EXTEND= \
01455 ALLOC_DELETED_CHAIN(x)= \
01456 BLOCKING= \
01457 TYPENAME=typename
01458
01459 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
01460 # this tag can be used to specify a list of macro names that should be expanded.
01461 # The macro definition that is found in the sources will be used.
01462 # Use the PREDEFINED tag if you want to use a different macro definition that
01463 # overrules the definition found in the source code.
01464
01465 EXPAND_AS_DEFINED = FLOATNAME \
01466 FLOATTYPE \
01467 FLOATTOKEN \
01468 FLOATCONST \
01469 FLOATTYPE2 \
01470 FLOATNAME2 \
01471 FLOATTOKEN2
01472
01473 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
01474 # doxygen's preprocessor will remove all references to function-like macros
01475 # that are alone on a line, have an all uppercase name, and do not end with a
01476 # semicolon, because these will confuse the parser if not removed.
01477
01478 SKIP_FUNCTION_MACROS = NO
01479
01480 #---------------------------------------------------------------------------
01481 # Configuration::additions related to external references
01482 #---------------------------------------------------------------------------
01483
01484 # The TAGFILES option can be used to specify one or more tagfiles.
01485 # Optionally an initial location of the external documentation
01486 # can be added for each tagfile. The format of a tag file without
01487 # this location is as follows:
01488 # TAGFILES = file1 file2 ...
01489 # Adding location for the tag files is done as follows:
01490 # TAGFILES = file1=loc1 "file2 = loc2" ...
01491 # where "loc1" and "loc2" can be relative or absolute paths or
01492 # URLs. If a location is present for each tag, the installdox tool
01493 # does not have to be run to correct the links.
01494 # Note that each tag file must have a unique name
01495 # (where the name does NOT include the path)
01496 # If a tag file is not located in the directory in which doxygen
01497 # is run, you must also specify the path to the tagfile here.
01498
01499 TAGFILES =
01500
01501 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
01502 # a tag file that is based on the input files it reads.
01503
01504 GENERATE_TAGFILE =
01505
01506 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
01507 # in the class index. If set to NO only the inherited external classes
01508 # will be listed.
01509
01510 ALLEXTERNALS = NO
01511
01512 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
01513 # in the modules index. If set to NO, only the current project's groups will
01514 # be listed.
01515
01516 EXTERNAL_GROUPS = YES
01517
01518 # The PERL_PATH should be the absolute path and name of the perl script
01519 # interpreter (i.e. the result of `which perl').
01520
01521 PERL_PATH = /usr/bin/perl
01522
01523 #---------------------------------------------------------------------------
01524 # Configuration options related to the dot tool
01525 #---------------------------------------------------------------------------
01526
01527 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
01528 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
01529 # or super classes. Setting the tag to NO turns the diagrams off. Note that
01530 # this option also works with HAVE_DOT disabled, but it is recommended to
01531 # install and use dot, since it yields more powerful graphs.
01532
01533 CLASS_DIAGRAMS = YES
01534
01535 # You can define message sequence charts within doxygen comments using the \msc
01536 # command. Doxygen will then run the mscgen tool (see
01537 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
01538 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
01539 # the mscgen tool resides. If left empty the tool is assumed to be found in the
01540 # default search path.
01541
01542 MSCGEN_PATH =
01543
01544 # If set to YES, the inheritance and collaboration graphs will hide
01545 # inheritance and usage relations if the target is undocumented
01546 # or is not a class.
01547
01548 HIDE_UNDOC_RELATIONS = YES
01549
01550 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
01551 # available from the path. This tool is part of Graphviz, a graph visualization
01552 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
01553 # have no effect if this option is set to NO (the default)
01554
01555 HAVE_DOT = NO
01556
01557 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
01558 # allowed to run in parallel. When set to 0 (the default) doxygen will
01559 # base this on the number of processors available in the system. You can set it
01560 # explicitly to a value larger than 0 to get control over the balance
01561 # between CPU load and processing speed.
01562
01563 DOT_NUM_THREADS = 0
01564
01565 # By default doxygen will write a font called Helvetica to the output
01566 # directory and reference it in all dot files that doxygen generates.
01567 # When you want a differently looking font you can specify the font name
01568 # using DOT_FONTNAME. You need to make sure dot is able to find the font,
01569 # which can be done by putting it in a standard location or by setting the
01570 # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
01571 # containing the font.
01572
01573 DOT_FONTNAME = FreeSans.ttf
01574
01575 # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
01576 # The default size is 10pt.
01577
01578 DOT_FONTSIZE = 10
01579
01580 # By default doxygen will tell dot to use the output directory to look for the
01581 # FreeSans.ttf font (which doxygen will put there itself). If you specify a
01582 # different font using DOT_FONTNAME you can set the path where dot
01583 # can find it using this tag.
01584
01585 DOT_FONTPATH =
01586
01587 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
01588 # will generate a graph for each documented class showing the direct and
01589 # indirect inheritance relations. Setting this tag to YES will force the
01590 # the CLASS_DIAGRAMS tag to NO.
01591
01592 CLASS_GRAPH = YES
01593
01594 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
01595 # will generate a graph for each documented class showing the direct and
01596 # indirect implementation dependencies (inheritance, containment, and
01597 # class references variables) of the class with other documented classes.
01598
01599 COLLABORATION_GRAPH = YES
01600
01601 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
01602 # will generate a graph for groups, showing the direct groups dependencies
01603
01604 GROUP_GRAPHS = YES
01605
01606 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
01607 # collaboration diagrams in a style similar to the OMG's Unified Modeling
01608 # Language.
01609
01610 UML_LOOK = NO
01611
01612 # If set to YES, the inheritance and collaboration graphs will show the
01613 # relations between templates and their instances.
01614
01615 TEMPLATE_RELATIONS = NO
01616
01617 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
01618 # tags are set to YES then doxygen will generate a graph for each documented
01619 # file showing the direct and indirect include dependencies of the file with
01620 # other documented files.
01621
01622 INCLUDE_GRAPH = YES
01623
01624 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
01625 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
01626 # documented header file showing the documented files that directly or
01627 # indirectly include this file.
01628
01629 INCLUDED_BY_GRAPH = YES
01630
01631 # If the CALL_GRAPH and HAVE_DOT options are set to YES then
01632 # doxygen will generate a call dependency graph for every global function
01633 # or class method. Note that enabling this option will significantly increase
01634 # the time of a run. So in most cases it will be better to enable call graphs
01635 # for selected functions only using the \callgraph command.
01636
01637 CALL_GRAPH = NO
01638
01639 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
01640 # doxygen will generate a caller dependency graph for every global function
01641 # or class method. Note that enabling this option will significantly increase
01642 # the time of a run. So in most cases it will be better to enable caller
01643 # graphs for selected functions only using the \callergraph command.
01644
01645 CALLER_GRAPH = NO
01646
01647 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
01648 # will generate a graphical hierarchy of all classes instead of a textual one.
01649
01650 GRAPHICAL_HIERARCHY = YES
01651
01652 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
01653 # then doxygen will show the dependencies a directory has on other directories
01654 # in a graphical way. The dependency relations are determined by the #include
01655 # relations between the files in the directories.
01656
01657 DIRECTORY_GRAPH = YES
01658
01659 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
01660 # generated by dot. Possible values are png, svg, gif or svg.
01661 # If left blank png will be used.
01662
01663 DOT_IMAGE_FORMAT = png
01664
01665 # The tag DOT_PATH can be used to specify the path where the dot tool can be
01666 # found. If left blank, it is assumed the dot tool can be found in the path.
01667
01668 DOT_PATH =
01669
01670 # The DOTFILE_DIRS tag can be used to specify one or more directories that
01671 # contain dot files that are included in the documentation (see the
01672 # \dotfile command).
01673
01674 DOTFILE_DIRS =
01675
01676 # The MSCFILE_DIRS tag can be used to specify one or more directories that
01677 # contain msc files that are included in the documentation (see the
01678 # \mscfile command).
01679
01680 MSCFILE_DIRS =
01681
01682 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
01683 # nodes that will be shown in the graph. If the number of nodes in a graph
01684 # becomes larger than this value, doxygen will truncate the graph, which is
01685 # visualized by representing a node as a red box. Note that doxygen if the
01686 # number of direct children of the root node in a graph is already larger than
01687 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
01688 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
01689
01690 DOT_GRAPH_MAX_NODES = 50
01691
01692 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
01693 # graphs generated by dot. A depth value of 3 means that only nodes reachable
01694 # from the root by following a path via at most 3 edges will be shown. Nodes
01695 # that lay further from the root node will be omitted. Note that setting this
01696 # option to 1 or 2 may greatly reduce the computation time needed for large
01697 # code bases. Also note that the size of a graph can be further restricted by
01698 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
01699
01700 MAX_DOT_GRAPH_DEPTH = 0
01701
01702 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
01703 # background. This is disabled by default, because dot on Windows does not
01704 # seem to support this out of the box. Warning: Depending on the platform used,
01705 # enabling this option may lead to badly anti-aliased labels on the edges of
01706 # a graph (i.e. they become hard to read).
01707
01708 DOT_TRANSPARENT = NO
01709
01710 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
01711 # files in one run (i.e. multiple -o and -T options on the command line). This
01712 # makes dot run faster, but since only newer versions of dot (>1.8.10)
01713 # support this, this feature is disabled by default.
01714
01715 DOT_MULTI_TARGETS = NO
01716
01717 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
01718 # generate a legend page explaining the meaning of the various boxes and
01719 # arrows in the dot generated graphs.
01720
01721 GENERATE_LEGEND = YES
01722
01723 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
01724 # remove the intermediate dot files that are used to generate
01725 # the various graphs.
01726
01727 DOT_CLEANUP = YES
01728