3 # This file describes the settings to be used by the documentation system 4 # doxygen (www.doxygen.org) for a project. 6 # All text after a double hash (##) is considered a comment and is placed in 7 # front of the TAG it is preceding. 9 # All text after a single hash (#) is considered a comment and will be ignored. 11 # TAG = value [value, ...] 12 # For lists, items can also be appended using: 13 # TAG += value [value, ...] 14 # Values that contain spaces should be placed between quotes (\" \"). 16 #--------------------------------------------------------------------------- 17 # Project related configuration options 18 #--------------------------------------------------------------------------- 20 # This tag specifies the encoding used for all characters in the config file 21 # that follow. The default is UTF-8 which is also the encoding used for all text 22 # before the first occurrence of this tag. Doxygen uses libiconv (or the iconv 23 # built into libc) for the transcoding. See http://www.gnu.org/software/libiconv 24 # for the list of possible encodings. 25 # The default value is: UTF-8. 27 DOXYFILE_ENCODING = UTF-8
29 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by 30 # double-quotes, unless you are using Doxywizard) that should identify the 31 # project for which the documentation is generated. This name is used in the 32 # title of most generated pages and in a few other places. 33 # The default value is: My Project. 35 PROJECT_NAME = Panda3D
37 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This 38 # could be handy for archiving the generated documentation or if some version 39 # control system is used. 41 PROJECT_NUMBER = $(PANDA3D_VERSION)
43 # Using the PROJECT_BRIEF tag one can provide an optional one line description
44 #
for a project that appears at the top of each page and should give viewer a
45 # quick idea about the purpose of the project. Keep the description
short.
49 # With the PROJECT_LOGO tag one can specify an logo or icon that is included in
50 # the documentation. The maximum height of the logo should not exceed 55 pixels
51 # and the maximum width should not exceed 200 pixels. Doxygen will copy the logo
52 # to the output directory.
56 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
57 # into which the generated documentation will be written. If a relative path is 58 # entered, it will be relative to the location where doxygen was started. If 59 # left blank the current directory will be used. 61 OUTPUT_DIRECTORY = reference-cxx
63 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub- 64 # directories (in 2 levels) under the output directory of each output format and 65 # will distribute the generated files over these directories. Enabling this 66 # option can be useful when feeding doxygen a huge amount of source files, where 67 # putting all generated files in the same directory would otherwise causes 68 # performance problems for the file system. 69 # The default value is: NO. 73 # The OUTPUT_LANGUAGE tag is used to specify the language in which all 74 # documentation generated by doxygen is written. Doxygen will use this 75 # information to generate all constant output in the proper language. 76 # Possible values are: Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese- 77 # Traditional, Croatian, Czech, Danish, Dutch, English, Esperanto, Farsi, 78 # Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en, 79 # Korean, Korean-en, Latvian, Norwegian, Macedonian, Persian, Polish, 80 # Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, 81 # Turkish, Ukrainian and Vietnamese. 82 # The default value is: English. 84 OUTPUT_LANGUAGE = English
86 # If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member 87 # descriptions after the members that are listed in the file and class 88 # documentation (similar to Javadoc). Set to NO to disable this. 89 # The default value is: YES. 91 BRIEF_MEMBER_DESC = YES
93 # If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief 94 # description of a member or function before the detailed description 96 # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 97 # brief descriptions will be completely suppressed. 98 # The default value is: YES. 102 # This tag implements a quasi-intelligent brief description abbreviator that is 103 # used to form the text in various listings. Each string in this list, if found 104 # as the leading text of the brief description, will be stripped from the text 105 # and the result, after processing the whole list, is used as the annotated 106 # text. Otherwise, the brief description is used as-is. If left blank, the 107 # following values are used ($name is automatically replaced with the name of 108 # the entity):The $name class, The $name widget, The $name file, is, provides, 109 # specifies, contains, represents, a, an and the. 111 ABBREVIATE_BRIEF =
"The $name class" \
123 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 124 # doxygen will generate a detailed section even if there is only a brief 126 # The default value is: NO. 128 ALWAYS_DETAILED_SEC = YES
130 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 131 # inherited members of a class in the documentation of that class as if those 132 # members were ordinary class members. Constructors, destructors and assignment 133 # operators of the base classes will not be shown. 134 # The default value is: NO. 136 INLINE_INHERITED_MEMB = NO
138 # If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path 139 # before files name in the file list and in the header files. If set to NO the 140 # shortest path that makes the file name unique will be used 141 # The default value is: YES. 143 FULL_PATH_NAMES = YES
145 # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. 146 # Stripping is only done if one of the specified strings matches the left-hand 147 # part of the path. The tag can be used to show relative paths in the file list. 148 # If left blank the directory from which doxygen is run is used as the path to 151 # Note that you can specify absolute paths here, but also relative paths, which 152 # will be relative from the directory where doxygen is started. 153 # This tag requires that the tag FULL_PATH_NAMES is set to YES. 157 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the 158 # path mentioned in the documentation of a class, which tells the reader which 159 # header file to include in order to use a class. If left blank only the name of 160 # the header file containing the class definition is used. Otherwise one should 161 # specify the list of include paths that are normally passed to the compiler 164 STRIP_FROM_INC_PATH =
166 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but 167 # less readable) file names. This can be useful is your file systems doesn't 168 # support long names like on DOS, Mac, or CD-ROM. 169 # The default value is: NO. 173 # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the 174 # first line (until the first dot) of a Javadoc-style comment as the brief 175 # description. If set to NO, the Javadoc-style will behave just like regular Qt- 176 # style comments (thus requiring an explicit @brief command for a brief 178 # The default value is: NO. 180 JAVADOC_AUTOBRIEF = YES
182 # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first 183 # line (until the first dot) of a Qt-style comment as the brief description. If 184 # set to NO, the Qt-style will behave just like regular Qt-style comments (thus 185 # requiring an explicit \brief command for a brief description.) 186 # The default value is: NO. 190 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a 191 # multi-line C++ special comment block (i.e. a block of 192 # a brief description. This used to be the default behavior. The new default is
193 # to treat a multi-line C++ comment block as a detailed description. Set this 194 # tag to YES if you prefer the old behavior instead. 196 # Note that setting this tag to YES also means that rational rose comments are 197 # not recognized any more. 198 # The default value is: NO. 200 MULTILINE_CPP_IS_BRIEF = NO
202 # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the 203 # documentation from any documented member that it re-implements. 204 # The default value is: YES. 208 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a 209 # new page for each member. If set to NO, the documentation of a member will be 210 # part of the file/class/namespace that contains it. 211 # The default value is: NO. 213 SEPARATE_MEMBER_PAGES = NO
215 # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen 216 # uses this value to replace tabs by spaces in code fragments. 217 # Minimum value: 1, maximum value: 16, default value: 4. 221 # This tag can be used to specify a number of aliases that act as commands in 222 # the documentation. An alias has the form: 225 # "sideeffect=@par Side Effects:\n" 226 # will allow you to put the command \sideeffect (or @sideeffect) in the 227 # documentation, which will result in a user-defined paragraph with heading 228 # "Side Effects:". You can put \n's in the value part of an alias to insert 233 # This tag can be used to specify a number of word-keyword mappings (TCL only). 234 # A mapping has the form "name=value". For example adding "class=itcl::class" 235 # will allow you to use the command class in the itcl::class meaning. 239 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources 240 # only. Doxygen will then generate output that is more tailored for C. For 241 # instance, some of the names that are used will be different. The list of all 242 # members will be omitted, etc. 243 # The default value is: NO. 245 OPTIMIZE_OUTPUT_FOR_C = NO
247 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or 248 # Python sources only. Doxygen will then generate output that is more tailored 249 # for that language. For instance, namespaces will be presented as packages, 250 # qualified scopes will look different, etc. 251 # The default value is: NO. 253 OPTIMIZE_OUTPUT_JAVA = NO
255 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 256 # sources. Doxygen will then generate output that is tailored for Fortran. 257 # The default value is: NO. 259 OPTIMIZE_FOR_FORTRAN = NO
261 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 262 # sources. Doxygen will then generate output that is tailored for VHDL. 263 # The default value is: NO. 265 OPTIMIZE_OUTPUT_VHDL = NO
267 # Doxygen selects the parser to use depending on the extension of the files it 268 # parses. With this tag you can assign which parser to use for a given 269 # extension. Doxygen has a built-in mapping, but you can override or extend it 270 # using this tag. The format is ext=language, where ext is a file extension, and 271 # language is one of the parsers supported by doxygen: IDL, Java, Javascript, 272 # C#, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL. For instance to make 273 # doxygen treat .inc files as Fortran files (default is PHP), and .f files as C 274 # (default is Fortran), use: inc=Fortran f=C. 276 # Note For files without extension you can use no_extension as a placeholder. 278 # Note that for custom extensions you also need to set FILE_PATTERNS otherwise 279 # the files are not read by doxygen. 281 EXTENSION_MAPPING = I=C++
283 # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments 284 # according to the Markdown format, which allows for more readable 285 # documentation. See http://daringfireball.net/projects/markdown/ for details. 286 # The output of markdown processing is further processed by doxygen, so you can 287 # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in 288 # case of backward compatibilities issues. 289 # The default value is: YES. 291 MARKDOWN_SUPPORT = NO
293 # When enabled doxygen tries to link words that correspond to documented 294 # classes, or namespaces to their corresponding documentation. Such a link can 295 # be prevented in individual cases by by putting a % sign in front of the word 296 # or globally by setting AUTOLINK_SUPPORT to NO. 297 # The default value is: YES. 299 AUTOLINK_SUPPORT = YES
301 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 302 # to include (a tag file for) the STL sources as input, then you should set this 303 # tag to YES in order to let doxygen match functions declarations and 304 # definitions whose arguments contain STL classes (e.g. func(std::string); 305 # versus func(std::string) {}). This also make the inheritance and collaboration 306 # diagrams that involve STL classes more complete and accurate. 307 # The default value is: NO. 309 BUILTIN_STL_SUPPORT = YES
311 # If you use Microsoft's C++/CLI language, you should set this option to YES to 312 # enable parsing support. 313 # The default value is: NO. 317 # Set the SIP_SUPPORT tag to YES if your project consists of sip (see: 318 # http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen 319 # will parse them like normal C++ but will assume all classes use public instead 320 # of private inheritance when no explicit protection keyword is present. 321 # The default value is: NO. 325 # For Microsoft's IDL there are propget and propput attributes to indicate 326 # getter and setter methods for a property. Setting this option to YES will make 327 # doxygen to replace the get and set methods by a property in the documentation. 328 # This will only work if the methods are indeed getting or setting a simple 329 # type. If this is not the case, or you want to show the methods anyway, you 330 # should set this option to NO. 331 # The default value is: YES. 333 IDL_PROPERTY_SUPPORT = YES
335 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 336 # tag is set to YES, then doxygen will reuse the documentation of the first 337 # member in the group (if any) for the other members of the group. By default 338 # all members of a group must be documented explicitly. 339 # The default value is: NO. 341 DISTRIBUTE_GROUP_DOC = NO
343 # Set the SUBGROUPING tag to YES to allow class member groups of the same type 344 # (for instance a group of public functions) to be put as a subgroup of that 345 # type (e.g. under the Public Functions section). Set it to NO to prevent 346 # subgrouping. Alternatively, this can be done per class using the 347 # \nosubgrouping command. 348 # The default value is: YES. 352 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions 353 # are shown inside the group in which they are included (e.g. using \ingroup) 354 # instead of on a separate page (for HTML and Man pages) or section (for LaTeX 357 # Note that this feature does not work in combination with 358 # SEPARATE_MEMBER_PAGES. 359 # The default value is: NO. 361 INLINE_GROUPED_CLASSES = NO
363 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions 364 # with only public data fields or simple typedef fields will be shown inline in 365 # the documentation of the scope in which they are defined (i.e. file, 366 # namespace, or group documentation), provided this scope is documented. If set 367 # to NO, structs, classes, and unions are shown on a separate page (for HTML and 368 # Man pages) or section (for LaTeX and RTF). 369 # The default value is: NO. 371 INLINE_SIMPLE_STRUCTS = NO
373 # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or 374 # enum is documented as struct, union, or enum with the name of the typedef. So 375 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct 376 # with name TypeT. When disabled the typedef will appear as a member of a file, 377 # namespace, or class. And the struct will be named TypeS. This can typically be 378 # useful for C code in case the coding convention dictates that all compound 379 # types are typedef'ed and only the typedef is referenced, never the tag name. 380 # The default value is: NO. 382 TYPEDEF_HIDES_STRUCT = NO
384 # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This 385 # cache is used to resolve symbols given their name and scope. Since this can be 386 # an expensive process and often the same symbol appears multiple times in the 387 # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small 388 # doxygen will become slower. If the cache is too large, memory is wasted. The 389 # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range 390 # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 391 # symbols. At the end of a run doxygen will report the cache usage and suggest 392 # the optimal cache size from a speed point of view. 393 # Minimum value: 0, maximum value: 9, default value: 0. 395 LOOKUP_CACHE_SIZE = 0
397 #--------------------------------------------------------------------------- 398 # Build related configuration options 399 #--------------------------------------------------------------------------- 401 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 402 # documentation are documented, even if no documentation was available. Private 403 # class members and static file members will be hidden unless the 404 # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. 405 # Note: This will also disable the warnings about undocumented members that are 406 # normally produced when WARNINGS is set to YES. 407 # The default value is: NO. 411 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class will 412 # be included in the documentation. 413 # The default value is: NO. 417 # If the EXTRACT_PACKAGE tag is set to YES all members with package or internal 418 # scope will be included in the documentation. 419 # The default value is: NO. 423 # If the EXTRACT_STATIC tag is set to YES all static members of a file will be 424 # included in the documentation. 425 # The default value is: NO. 429 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined 430 # locally in source files will be included in the documentation. If set to NO 431 # only classes defined in header files are included. Does not have any effect 433 # The default value is: YES. 435 EXTRACT_LOCAL_CLASSES = NO
437 # This flag is only useful for Objective-C code. When set to YES local methods, 438 # which are defined in the implementation section but not in the interface are 439 # included in the documentation. If set to NO only methods in the interface are 441 # The default value is: NO. 443 EXTRACT_LOCAL_METHODS = NO
445 # If this flag is set to YES, the members of anonymous namespaces will be 446 # extracted and appear in the documentation as a namespace called 447 # 'anonymous_namespace{file}', where file will be replaced with the base name of 448 # the file that contains the anonymous namespace. By default anonymous namespace 450 # The default value is: NO. 452 EXTRACT_ANON_NSPACES = NO
454 # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all 455 # undocumented members inside documented classes or files. If set to NO these 456 # members will be included in the various overviews, but no documentation 457 # section is generated. This option has no effect if EXTRACT_ALL is enabled. 458 # The default value is: NO. 460 HIDE_UNDOC_MEMBERS = NO
462 # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all 463 # undocumented classes that are normally visible in the class hierarchy. If set 464 # to NO these classes will be included in the various overviews. This option has 465 # no effect if EXTRACT_ALL is enabled. 466 # The default value is: NO. 468 HIDE_UNDOC_CLASSES = NO
470 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend 471 # (class|struct|union) declarations. If set to NO these declarations will be 472 # included in the documentation. 473 # The default value is: NO. 475 HIDE_FRIEND_COMPOUNDS = NO
477 # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any 478 # documentation blocks found inside the body of a function. If set to NO these 479 # blocks will be appended to the function's detailed documentation block. 480 # The default value is: NO. 482 HIDE_IN_BODY_DOCS = YES
484 # The INTERNAL_DOCS tag determines if documentation that is typed after a 485 # \internal command is included. If the tag is set to NO then the documentation 486 # will be excluded. Set it to YES to include the internal documentation. 487 # The default value is: NO. 491 # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file 492 # names in lower-case letters. If set to YES upper-case letters are also 493 # allowed. This is useful if you have classes or files whose names only differ 494 # in case and if your file system supports case sensitive file names. Windows 495 # and Mac users are advised to set this option to NO. 496 # The default value is: system dependent. 498 CASE_SENSE_NAMES = YES
500 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with 501 # their full class and namespace scopes in the documentation. If set to YES the 502 # scope will be hidden. 503 # The default value is: NO. 505 HIDE_SCOPE_NAMES = NO
507 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of 508 # the files that are included by a file in the documentation of that file. 509 # The default value is: YES. 511 SHOW_INCLUDE_FILES = YES
513 # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include 514 # files with double quotes in the documentation rather than with sharp brackets. 515 # The default value is: NO. 517 FORCE_LOCAL_INCLUDES = YES
519 # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the 520 # documentation for inline members. 521 # The default value is: YES. 525 # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the 526 # (detailed) documentation of file and class members alphabetically by member 527 # name. If set to NO the members will appear in declaration order. 528 # The default value is: YES. 530 SORT_MEMBER_DOCS = YES
532 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief 533 # descriptions of file, namespace and class members alphabetically by member 534 # name. If set to NO the members will appear in declaration order. 535 # The default value is: NO. 537 SORT_BRIEF_DOCS = YES
539 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the 540 # (brief and detailed) documentation of class members so that constructors and 541 # destructors are listed first. If set to NO the constructors will appear in the 542 # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. 543 # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief 544 # member documentation. 545 # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting 546 # detailed member documentation. 547 # The default value is: NO. 549 SORT_MEMBERS_CTORS_1ST = YES
551 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy 552 # of group names into alphabetical order. If set to NO the group names will 553 # appear in their defined order. 554 # The default value is: NO. 556 SORT_GROUP_NAMES = NO
558 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by 559 # fully-qualified names, including namespaces. If set to NO, the class list will 560 # be sorted only by class name, not including the namespace part. 561 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 562 # Note: This option applies only to the class list, not to the alphabetical 564 # The default value is: NO. 566 SORT_BY_SCOPE_NAME = NO
568 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper 569 # type resolution of all parameters of a function it will reject a match between 570 # the prototype and the implementation of a member function even if there is 571 # only one candidate or it is obvious which candidate to choose by doing a 572 # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still 573 # accept a match between prototype and implementation in such cases. 574 # The default value is: NO. 576 STRICT_PROTO_MATCHING = NO
578 # The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the 579 # todo list. This list is created by putting \todo commands in the 581 # The default value is: YES. 583 GENERATE_TODOLIST = NO
585 # The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the 586 # test list. This list is created by putting \test commands in the 588 # The default value is: YES. 590 GENERATE_TESTLIST = NO
592 # The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug 593 # list. This list is created by putting \bug commands in the documentation. 594 # The default value is: YES. 596 GENERATE_BUGLIST = NO
598 # The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO) 599 # the deprecated list. This list is created by putting \deprecated commands in 601 # The default value is: YES. 603 GENERATE_DEPRECATEDLIST= NO
605 # The ENABLED_SECTIONS tag can be used to enable conditional documentation 606 # sections, marked by \if <section_label> ... \endif and \cond <section_label> 607 # ... \endcond blocks. 611 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the 612 # initial value of a variable or macro / define can have for it to appear in the 613 # documentation. If the initializer consists of more lines than specified here 614 # it will be hidden. Use a value of 0 to hide initializers completely. The 615 # appearance of the value of individual variables and macros / defines can be 616 # controlled using \showinitializer or \hideinitializer command in the 617 # documentation regardless of this setting. 618 # Minimum value: 0, maximum value: 10000, default value: 30. 620 MAX_INITIALIZER_LINES = 30
622 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at 623 # the bottom of the documentation of classes and structs. If set to YES the list 624 # will mention the files that were used to generate the documentation. 625 # The default value is: YES. 627 SHOW_USED_FILES = YES
629 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This 630 # will remove the Files entry from the Quick Index and from the Folder Tree View 632 # The default value is: YES. 636 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces 637 # page. This will remove the Namespaces entry from the Quick Index and from the 638 # Folder Tree View (if specified). 639 # The default value is: YES. 641 SHOW_NAMESPACES = YES
643 # The FILE_VERSION_FILTER tag can be used to specify a program or script that 644 # doxygen should invoke to get the current version for each file (typically from 645 # the version control system). Doxygen will invoke the program by executing (via 646 # popen()) the command command input-file, where command is the value of the 647 # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided 648 # by doxygen. Whatever the program writes to standard output is used as the file 649 # version. For an example see the documentation. 651 FILE_VERSION_FILTER =
653 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed 654 # by doxygen. The layout file controls the global structure of the generated 655 # output files in an output format independent way. To create the layout file 656 # that represents doxygen's defaults, run doxygen with the -l option. You can 657 # optionally specify a file name after the option, if omitted DoxygenLayout.xml 658 # will be used as the name of the layout file. 660 # Note that if you run doxygen from a directory containing a file called 661 # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE 666 # The CITE_BIB_FILES tag can be used to specify one or more bib files containing 667 # the reference definitions. This must be a list of .bib files. The .bib 668 # extension is automatically appended if omitted. This requires the bibtex tool 669 # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. 670 # For LaTeX the style of the bibliography can be controlled using 671 # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the 672 # search path. Do not use file names with spaces, bibtex cannot handle them. See 673 # also \cite for info how to create references. 677 #--------------------------------------------------------------------------- 678 # Configuration options related to warning and progress messages 679 #--------------------------------------------------------------------------- 681 # The QUIET tag can be used to turn on/off the messages that are generated to 682 # standard output by doxygen. If QUIET is set to YES this implies that the 684 # The default value is: NO. 688 # The WARNINGS tag can be used to turn on/off the warning messages that are 689 # generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES 690 # this implies that the warnings are on. 692 # Tip: Turn warnings on while writing the documentation. 693 # The default value is: YES. 697 # If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate 698 # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag 699 # will automatically be disabled. 700 # The default value is: YES. 702 WARN_IF_UNDOCUMENTED = NO
704 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for 705 # potential errors in the documentation, such as not documenting some parameters 706 # in a documented function, or documenting parameters that don't exist or using 707 # markup commands wrongly. 708 # The default value is: YES. 710 WARN_IF_DOC_ERROR = YES
712 # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that 713 # are documented, but have no documentation for their parameters or return 714 # value. If set to NO doxygen will only warn about wrong or incomplete parameter 715 # documentation, but not about the absence of documentation. 716 # The default value is: NO. 718 WARN_NO_PARAMDOC = NO
720 # The WARN_FORMAT tag determines the format of the warning messages that doxygen 721 # can produce. The string should contain the $file, $line, and $text tags, which 722 # will be replaced by the file and line number from which the warning originated 723 # and the warning text. Optionally the format may contain $version, which will 724 # be replaced by the version of the file (if it could be obtained via 725 # FILE_VERSION_FILTER) 726 # The default value is: $file:$line: $text. 728 WARN_FORMAT =
"$file:$line: $text" 730 # The WARN_LOGFILE tag can be used to specify a file to which warning and error 731 # messages should be written. If left blank the output is written to standard 736 #--------------------------------------------------------------------------- 737 # Configuration options related to the input files 738 #--------------------------------------------------------------------------- 740 # The INPUT tag is used to specify the files and/or directories that contain 741 # documented source files. You may enter file names like myfile.cpp or 742 # directories like /usr/src/myproject. Separate the files or directories with 744 # Note: If this tag is empty the current directory is searched. 752 # This tag can be used to specify the character encoding of the source files 753 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses 754 # libiconv (or the iconv built into libc) for the transcoding. See the libiconv 755 # documentation (see: http://www.gnu.org/software/libiconv) for the list of 756 # possible encodings. 757 # The default value is: UTF-8. 759 INPUT_ENCODING = UTF-8
761 # If the value of the INPUT tag contains directories, you can use the 762 # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and 763 # *.h) to filter out the source-files in the directories. If left blank the 764 # following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii, 765 # *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, 766 # *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, 767 # *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, 768 # *.qsf, *.as and *.js. 770 FILE_PATTERNS = *.cxx \
776 # The RECURSIVE tag can be used to specify whether or not subdirectories should 777 # be searched for input files as well. 778 # The default value is: NO. 782 # The EXCLUDE tag can be used to specify files and/or directories that should be 783 # excluded from the INPUT source files. This way you can easily exclude a 784 # subdirectory from a directory tree whose root is specified with the INPUT tag. 786 # Note that relative paths are relative to the directory from which doxygen is 789 EXCLUDE = dtool/src/parser-inc \
790 dtool/src/cppparser \
791 dtool/src/interrogate \
793 direct/src/plugin_standalone \
794 direct/src/plugin_npapi \
795 direct/src/plugin_activex \
796 dtool/src/test_interrogate \
797 panda/src/linmath/fltnames.h \
panda/src/linmath/dblnames.h \
panda/src/linmath/dbl2fltnames.h \
panda/src/linmath/flt2dblnames.h \
panda/src/android \
799 panda/src/tinydisplay \
800 panda/src/movies/dr_flac.h \
panda/src/windisplay/winDetectDx.h \
panda/src/wgldisplay/wglext.h \
panda/src/glxdisplay/panda_glxext.h \
pandatool/src/gtk-stats \
801 dtool/src/dtoolbase/fakestringstream.h \
dtool/src/dtoolbase/pdtoa.cxx \
dtool/src/dtoolutil/panda_getopt_long.h \
dtool/src/dtoolutil/panda_getopt_impl.h \
dtool/src/dtoolutil/panda_getopt_impl.cxx
803 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or 804 # directories that are symbolic links (a Unix file system feature) are excluded 806 # The default value is: NO. 808 EXCLUDE_SYMLINKS = NO
810 # If the value of the INPUT tag contains directories, you can use the 811 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 812 # certain files from those directories. 814 # Note that the wildcards are matched against the file with absolute path, so to 815 # exclude all test directories for example use the pattern */test 827 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 828 # (namespaces, classes, functions, etc.) that should be excluded from the 829 # output. The symbol name can be a fully qualified name, a word, or if the 830 # wildcard * is used, a substring. Examples: ANamespace, AClass, 831 # AClass::ANamespace, ANamespace::*Test 833 # Note that the wildcards are matched against the file with absolute path, so to 834 # exclude all test directories use the pattern */test