Doxyfile (62293B)
1 # Doxyfile 1.5.5 2 3 # This file describes the settings to be used by the documentation system 4 # doxygen (www.doxygen.org) for a project 5 # 6 # All text after a hash (#) is considered a comment and will be ignored 7 # The format is: 8 # TAG = value [value, ...] 9 # For lists items can also be appended using: 10 # TAG += value [value, ...] 11 # Values that contain spaces should be placed between quotes (" ") 12 13 #--------------------------------------------------------------------------- 14 # Project related configuration options 15 #--------------------------------------------------------------------------- 16 17 # This tag specifies the encoding used for all characters in the config file 18 # that follow. The default is UTF-8 which is also the encoding used for all 19 # text before the first occurrence of this tag. Doxygen uses libiconv (or the 20 # iconv built into libc) for the transcoding. See 21 # http://www.gnu.org/software/libiconv for the list of possible encodings. 22 23 DOXYFILE_ENCODING = UTF-8 24 25 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded 26 # by quotes) that should identify the project. 27 28 PROJECT_NAME = PortMidi 29 30 # The PROJECT_NUMBER tag can be used to enter a project or revision number. 31 # This could be handy for archiving the generated documentation or 32 # if some version control system is used. 33 34 PROJECT_NUMBER = 2.2.x 35 36 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 37 # base path where the generated documentation will be put. 38 # If a relative path is entered, it will be relative to the location 39 # where doxygen was started. If left blank the current directory will be used. 40 41 OUTPUT_DIRECTORY = . 42 43 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 44 # 4096 sub-directories (in 2 levels) under the output directory of each output 45 # format and will distribute the generated files over these directories. 46 # Enabling this option can be useful when feeding doxygen a huge amount of 47 # source files, where putting all generated files in the same directory would 48 # otherwise cause performance problems for the file system. 49 50 CREATE_SUBDIRS = NO 51 52 # The OUTPUT_LANGUAGE tag is used to specify the language in which all 53 # documentation generated by doxygen is written. Doxygen will use this 54 # information to generate all constant output in the proper language. 55 # The default language is English, other supported languages are: 56 # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, 57 # Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek, 58 # Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages), 59 # Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish, 60 # Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak, Slovene, 61 # Spanish, Swedish, and Ukrainian. 62 63 OUTPUT_LANGUAGE = English 64 65 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 66 # include brief member descriptions after the members that are listed in 67 # the file and class documentation (similar to JavaDoc). 68 # Set to NO to disable this. 69 70 BRIEF_MEMBER_DESC = YES 71 72 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 73 # the brief description of a member or function before the detailed description. 74 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 75 # brief descriptions will be completely suppressed. 76 77 REPEAT_BRIEF = YES 78 79 # This tag implements a quasi-intelligent brief description abbreviator 80 # that is used to form the text in various listings. Each string 81 # in this list, if found as the leading text of the brief description, will be 82 # stripped from the text and the result after processing the whole list, is 83 # used as the annotated text. Otherwise, the brief description is used as-is. 84 # If left blank, the following values are used ("$name" is automatically 85 # replaced with the name of the entity): "The $name class" "The $name widget" 86 # "The $name file" "is" "provides" "specifies" "contains" 87 # "represents" "a" "an" "the" 88 89 ABBREVIATE_BRIEF = 90 91 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 92 # Doxygen will generate a detailed section even if there is only a brief 93 # description. 94 95 ALWAYS_DETAILED_SEC = NO 96 97 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 98 # inherited members of a class in the documentation of that class as if those 99 # members were ordinary class members. Constructors, destructors and assignment 100 # operators of the base classes will not be shown. 101 102 INLINE_INHERITED_MEMB = NO 103 104 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 105 # path before files name in the file list and in the header files. If set 106 # to NO the shortest path that makes the file name unique will be used. 107 108 FULL_PATH_NAMES = NO 109 110 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 111 # can be used to strip a user-defined part of the path. Stripping is 112 # only done if one of the specified strings matches the left-hand part of 113 # the path. The tag can be used to show relative paths in the file list. 114 # If left blank the directory from which doxygen is run is used as the 115 # path to strip. 116 117 STRIP_FROM_PATH = 118 119 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 120 # the path mentioned in the documentation of a class, which tells 121 # the reader which header file to include in order to use a class. 122 # If left blank only the name of the header file containing the class 123 # definition is used. Otherwise one should specify the include paths that 124 # are normally passed to the compiler using the -I flag. 125 126 STRIP_FROM_INC_PATH = 127 128 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 129 # (but less readable) file names. This can be useful is your file systems 130 # doesn't support long names like on DOS, Mac, or CD-ROM. 131 132 SHORT_NAMES = NO 133 134 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 135 # will interpret the first line (until the first dot) of a JavaDoc-style 136 # comment as the brief description. If set to NO, the JavaDoc 137 # comments will behave just like regular Qt-style comments 138 # (thus requiring an explicit @brief command for a brief description.) 139 140 JAVADOC_AUTOBRIEF = YES 141 142 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will 143 # interpret the first line (until the first dot) of a Qt-style 144 # comment as the brief description. If set to NO, the comments 145 # will behave just like regular Qt-style comments (thus requiring 146 # an explicit \brief command for a brief description.) 147 148 QT_AUTOBRIEF = NO 149 150 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 151 # treat a multi-line C++ special comment block (i.e. a block of //! or /// 152 # comments) as a brief description. This used to be the default behaviour. 153 # The new default is to treat a multi-line C++ comment block as a detailed 154 # description. Set this tag to YES if you prefer the old behaviour instead. 155 156 MULTILINE_CPP_IS_BRIEF = NO 157 158 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 159 # member inherits the documentation from any documented member that it 160 # re-implements. 161 162 INHERIT_DOCS = YES 163 164 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce 165 # a new page for each member. If set to NO, the documentation of a member will 166 # be part of the file/class/namespace that contains it. 167 168 SEPARATE_MEMBER_PAGES = NO 169 170 # The TAB_SIZE tag can be used to set the number of spaces in a tab. 171 # Doxygen uses this value to replace tabs by spaces in code fragments. 172 173 TAB_SIZE = 8 174 175 # This tag can be used to specify a number of aliases that acts 176 # as commands in the documentation. An alias has the form "name=value". 177 # For example adding "sideeffect=\par Side Effects:\n" will allow you to 178 # put the command \sideeffect (or @sideeffect) in the documentation, which 179 # will result in a user-defined paragraph with heading "Side Effects:". 180 # You can put \n's in the value part of an alias to insert newlines. 181 182 ALIASES = 183 184 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 185 # sources only. Doxygen will then generate output that is more tailored for C. 186 # For instance, some of the names that are used will be different. The list 187 # of all members will be omitted, etc. 188 189 OPTIMIZE_OUTPUT_FOR_C = YES 190 191 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java 192 # sources only. Doxygen will then generate output that is more tailored for 193 # Java. For instance, namespaces will be presented as packages, qualified 194 # scopes will look different, etc. 195 196 OPTIMIZE_OUTPUT_JAVA = NO 197 198 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 199 # sources only. Doxygen will then generate output that is more tailored for 200 # Fortran. 201 202 OPTIMIZE_FOR_FORTRAN = NO 203 204 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 205 # sources. Doxygen will then generate output that is tailored for 206 # VHDL. 207 208 OPTIMIZE_OUTPUT_VHDL = NO 209 210 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 211 # to include (a tag file for) the STL sources as input, then you should 212 # set this tag to YES in order to let doxygen match functions declarations and 213 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s. 214 # func(std::string) {}). This also make the inheritance and collaboration 215 # diagrams that involve STL classes more complete and accurate. 216 217 BUILTIN_STL_SUPPORT = NO 218 219 # If you use Microsoft's C++/CLI language, you should set this option to YES to 220 # enable parsing support. 221 222 CPP_CLI_SUPPORT = NO 223 224 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. 225 # Doxygen will parse them like normal C++ but will assume all classes use public 226 # instead of private inheritance when no explicit protection keyword is present. 227 228 SIP_SUPPORT = NO 229 230 # For Microsoft's IDL there are propget and propput attributes to indicate getter 231 # and setter methods for a property. Setting this option to YES (the default) 232 # will make doxygen to replace the get and set methods by a property in the 233 # documentation. This will only work if the methods are indeed getting or 234 # setting a simple type. If this is not the case, or you want to show the 235 # methods anyway, you should set this option to NO. 236 # 1.5.7 237 #IDL_PROPERTY_SUPPORT = YES 238 239 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 240 # tag is set to YES, then doxygen will reuse the documentation of the first 241 # member in the group (if any) for the other members of the group. By default 242 # all members of a group must be documented explicitly. 243 244 DISTRIBUTE_GROUP_DOC = NO 245 246 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of 247 # the same type (for instance a group of public functions) to be put as a 248 # subgroup of that type (e.g. under the Public Functions section). Set it to 249 # NO to prevent subgrouping. Alternatively, this can be done per class using 250 # the \nosubgrouping command. 251 252 SUBGROUPING = YES 253 254 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum 255 # is documented as struct, union, or enum with the name of the typedef. So 256 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct 257 # with name TypeT. When disabled the typedef will appear as a member of a file, 258 # namespace, or class. And the struct will be named TypeS. This can typically 259 # be useful for C code in case the coding convention dictates that all compound 260 # types are typedef'ed and only the typedef is referenced, never the tag name. 261 262 TYPEDEF_HIDES_STRUCT = NO 263 264 # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to 265 # determine which symbols to keep in memory and which to flush to disk. 266 # When the cache is full, less often used symbols will be written to disk. 267 # For small to medium size projects (<1000 input files) the default value is 268 # probably good enough. For larger projects a too small cache size can cause 269 # doxygen to be busy swapping symbols to and from disk most of the time 270 # causing a significant performance penality. 271 # If the system has enough physical memory increasing the cache will improve the 272 # performance by keeping more symbols in memory. Note that the value works on 273 # a logarithmic scale so increasing the size by one will rougly double the 274 # memory usage. The cache size is given by this formula: 275 # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, 276 # corresponding to a cache size of 2^16 = 65536 symbols 277 # 1.5.7 278 # SYMBOL_CACHE_SIZE = 0 279 280 #--------------------------------------------------------------------------- 281 # Build related configuration options 282 #--------------------------------------------------------------------------- 283 284 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 285 # documentation are documented, even if no documentation was available. 286 # Private class members and static file members will be hidden unless 287 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES 288 289 EXTRACT_ALL = NO 290 291 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class 292 # will be included in the documentation. 293 294 EXTRACT_PRIVATE = NO 295 296 # If the EXTRACT_STATIC tag is set to YES all static members of a file 297 # will be included in the documentation. 298 299 EXTRACT_STATIC = NO 300 301 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 302 # defined locally in source files will be included in the documentation. 303 # If set to NO only classes defined in header files are included. 304 305 EXTRACT_LOCAL_CLASSES = NO 306 307 # This flag is only useful for Objective-C code. When set to YES local 308 # methods, which are defined in the implementation section but not in 309 # the interface are included in the documentation. 310 # If set to NO (the default) only methods in the interface are included. 311 312 EXTRACT_LOCAL_METHODS = NO 313 314 # If this flag is set to YES, the members of anonymous namespaces will be 315 # extracted and appear in the documentation as a namespace called 316 # 'anonymous_namespace{file}', where file will be replaced with the base 317 # name of the file that contains the anonymous namespace. By default 318 # anonymous namespace are hidden. 319 320 EXTRACT_ANON_NSPACES = NO 321 322 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 323 # undocumented members of documented classes, files or namespaces. 324 # If set to NO (the default) these members will be included in the 325 # various overviews, but no documentation section is generated. 326 # This option has no effect if EXTRACT_ALL is enabled. 327 328 HIDE_UNDOC_MEMBERS = NO 329 330 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 331 # undocumented classes that are normally visible in the class hierarchy. 332 # If set to NO (the default) these classes will be included in the various 333 # overviews. This option has no effect if EXTRACT_ALL is enabled. 334 335 HIDE_UNDOC_CLASSES = NO 336 337 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 338 # friend (class|struct|union) declarations. 339 # If set to NO (the default) these declarations will be included in the 340 # documentation. 341 342 HIDE_FRIEND_COMPOUNDS = NO 343 344 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 345 # documentation blocks found inside the body of a function. 346 # If set to NO (the default) these blocks will be appended to the 347 # function's detailed documentation block. 348 349 HIDE_IN_BODY_DOCS = NO 350 351 # The INTERNAL_DOCS tag determines if documentation 352 # that is typed after a \internal command is included. If the tag is set 353 # to NO (the default) then the documentation will be excluded. 354 # Set it to YES to include the internal documentation. 355 356 INTERNAL_DOCS = NO 357 358 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 359 # file names in lower-case letters. If set to YES upper-case letters are also 360 # allowed. This is useful if you have classes or files whose names only differ 361 # in case and if your file system supports case sensitive file names. Windows 362 # and Mac users are advised to set this option to NO. 363 364 CASE_SENSE_NAMES = YES 365 366 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 367 # will show members with their full class and namespace scopes in the 368 # documentation. If set to YES the scope will be hidden. 369 370 HIDE_SCOPE_NAMES = NO 371 372 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 373 # will put a list of the files that are included by a file in the documentation 374 # of that file. 375 376 SHOW_INCLUDE_FILES = YES 377 378 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 379 # is inserted in the documentation for inline members. 380 381 INLINE_INFO = YES 382 383 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 384 # will sort the (detailed) documentation of file and class members 385 # alphabetically by member name. If set to NO the members will appear in 386 # declaration order. 387 388 SORT_MEMBER_DOCS = YES 389 390 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 391 # brief documentation of file, namespace and class members alphabetically 392 # by member name. If set to NO (the default) the members will appear in 393 # declaration order. 394 395 SORT_BRIEF_DOCS = NO 396 397 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the 398 # hierarchy of group names into alphabetical order. If set to NO (the default) 399 # the group names will appear in their defined order. 400 401 SORT_GROUP_NAMES = NO 402 403 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 404 # sorted by fully-qualified names, including namespaces. If set to 405 # NO (the default), the class list will be sorted only by class name, 406 # not including the namespace part. 407 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 408 # Note: This option applies only to the class list, not to the 409 # alphabetical list. 410 411 SORT_BY_SCOPE_NAME = NO 412 413 # The GENERATE_TODOLIST tag can be used to enable (YES) or 414 # disable (NO) the todo list. This list is created by putting \todo 415 # commands in the documentation. 416 417 GENERATE_TODOLIST = YES 418 419 # The GENERATE_TESTLIST tag can be used to enable (YES) or 420 # disable (NO) the test list. This list is created by putting \test 421 # commands in the documentation. 422 423 GENERATE_TESTLIST = YES 424 425 # The GENERATE_BUGLIST tag can be used to enable (YES) or 426 # disable (NO) the bug list. This list is created by putting \bug 427 # commands in the documentation. 428 429 GENERATE_BUGLIST = YES 430 431 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 432 # disable (NO) the deprecated list. This list is created by putting 433 # \deprecated commands in the documentation. 434 435 GENERATE_DEPRECATEDLIST= YES 436 437 # The ENABLED_SECTIONS tag can be used to enable conditional 438 # documentation sections, marked by \if sectionname ... \endif. 439 440 ENABLED_SECTIONS = 441 442 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines 443 # the initial value of a variable or define consists of for it to appear in 444 # the documentation. If the initializer consists of more lines than specified 445 # here it will be hidden. Use a value of 0 to hide initializers completely. 446 # The appearance of the initializer of individual variables and defines in the 447 # documentation can be controlled using \showinitializer or \hideinitializer 448 # command in the documentation regardless of this setting. 449 450 MAX_INITIALIZER_LINES = 30 451 452 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated 453 # at the bottom of the documentation of classes and structs. If set to YES the 454 # list will mention the files that were used to generate the documentation. 455 456 SHOW_USED_FILES = YES 457 458 # If the sources in your project are distributed over multiple directories 459 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy 460 # in the documentation. The default is NO. 461 462 SHOW_DIRECTORIES = NO 463 464 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. 465 # This will remove the Files entry from the Quick Index and from the 466 # Folder Tree View (if specified). The default is YES. 467 # 1.5.7 468 # SHOW_FILES = YES 469 470 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the 471 # Namespaces page. This will remove the Namespaces entry from the Quick Index 472 # and from the Folder Tree View (if specified). The default is YES. 473 # 1.5.7 474 # SHOW_NAMESPACES = YES 475 476 # The FILE_VERSION_FILTER tag can be used to specify a program or script that 477 # doxygen should invoke to get the current version for each file (typically from 478 # the version control system). Doxygen will invoke the program by executing (via 479 # popen()) the command <command> <input-file>, where <command> is the value of 480 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file 481 # provided by doxygen. Whatever the program writes to standard output 482 # is used as the file version. See the manual for examples. 483 484 FILE_VERSION_FILTER = 485 486 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by 487 # doxygen. The layout file controls the global structure of the generated output files 488 # in an output format independent way. The create the layout file that represents 489 # doxygen's defaults, run doxygen with the -l option. You can optionally specify a 490 # file name after the option, if omitted DoxygenLayout.xml will be used as the name 491 # of the layout file. 492 # 1.5.7 493 # LAYOUT_FILE = 494 495 #--------------------------------------------------------------------------- 496 # configuration options related to warning and progress messages 497 #--------------------------------------------------------------------------- 498 499 # The QUIET tag can be used to turn on/off the messages that are generated 500 # by doxygen. Possible values are YES and NO. If left blank NO is used. 501 502 QUIET = YES 503 504 # The WARNINGS tag can be used to turn on/off the warning messages that are 505 # generated by doxygen. Possible values are YES and NO. If left blank 506 # NO is used. 507 508 WARNINGS = YES 509 510 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 511 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will 512 # automatically be disabled. 513 514 WARN_IF_UNDOCUMENTED = NO 515 516 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 517 # potential errors in the documentation, such as not documenting some 518 # parameters in a documented function, or documenting parameters that 519 # don't exist or using markup commands wrongly. 520 521 WARN_IF_DOC_ERROR = YES 522 523 # This WARN_NO_PARAMDOC option can be abled to get warnings for 524 # functions that are documented, but have no documentation for their parameters 525 # or return value. If set to NO (the default) doxygen will only warn about 526 # wrong or incomplete parameter documentation, but not about the absence of 527 # documentation. 528 529 WARN_NO_PARAMDOC = NO 530 531 # The WARN_FORMAT tag determines the format of the warning messages that 532 # doxygen can produce. The string should contain the $file, $line, and $text 533 # tags, which will be replaced by the file and line number from which the 534 # warning originated and the warning text. Optionally the format may contain 535 # $version, which will be replaced by the version of the file (if it could 536 # be obtained via FILE_VERSION_FILTER) 537 538 WARN_FORMAT = "$file:$line: $text" 539 540 # The WARN_LOGFILE tag can be used to specify a file to which warning 541 # and error messages should be written. If left blank the output is written 542 # to stderr. 543 544 WARN_LOGFILE = 545 546 #--------------------------------------------------------------------------- 547 # configuration options related to the input files 548 #--------------------------------------------------------------------------- 549 550 # The INPUT tag can be used to specify the files and/or directories that contain 551 # documented source files. You may enter file names like "myfile.cpp" or 552 # directories like "/usr/src/myproject". Separate the files or directories 553 # with spaces. 554 555 INPUT = \ 556 pm_common/portmidi.h \ 557 pm_common/portmidi.c \ 558 559 # This tag can be used to specify the character encoding of the source files 560 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is 561 # also the default input encoding. Doxygen uses libiconv (or the iconv built 562 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for 563 # the list of possible encodings. 564 565 INPUT_ENCODING = UTF-8 566 567 # If the value of the INPUT tag contains directories, you can use the 568 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 569 # and *.h) to filter out the source-files in the directories. If left 570 # blank the following patterns are tested: 571 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx 572 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 573 574 FILE_PATTERNS = *.h \ 575 *.c 576 577 # The RECURSIVE tag can be used to turn specify whether or not subdirectories 578 # should be searched for input files as well. Possible values are YES and NO. 579 # If left blank NO is used. 580 581 RECURSIVE = NO 582 583 # The EXCLUDE tag can be used to specify files and/or directories that should 584 # excluded from the INPUT source files. This way you can easily exclude a 585 # subdirectory from a directory tree whose root is specified with the INPUT tag. 586 587 EXCLUDE = 588 589 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or 590 # directories that are symbolic links (a Unix filesystem feature) are excluded 591 # from the input. 592 593 EXCLUDE_SYMLINKS = NO 594 595 # If the value of the INPUT tag contains directories, you can use the 596 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 597 # certain files from those directories. Note that the wildcards are matched 598 # against the file with absolute path, so to exclude all test directories 599 # for example use the pattern */test/* 600 601 EXCLUDE_PATTERNS = 602 603 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 604 # (namespaces, classes, functions, etc.) that should be excluded from the 605 # output. The symbol name can be a fully qualified name, a word, or if the 606 # wildcard * is used, a substring. Examples: ANamespace, AClass, 607 # AClass::ANamespace, ANamespace::*Test 608 609 EXCLUDE_SYMBOLS = 610 611 # The EXAMPLE_PATH tag can be used to specify one or more files or 612 # directories that contain example code fragments that are included (see 613 # the \include command). 614 615 EXAMPLE_PATH = ./pm_test 616 617 # If the value of the EXAMPLE_PATH tag contains directories, you can use the 618 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 619 # and *.h) to filter out the source-files in the directories. If left 620 # blank all files are included. 621 622 EXAMPLE_PATTERNS = *.cxx \ 623 *.h \ 624 *.H \ 625 *.fl 626 627 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 628 # searched for input files to be used with the \include or \dontinclude 629 # commands irrespective of the value of the RECURSIVE tag. 630 # Possible values are YES and NO. If left blank NO is used. 631 632 EXAMPLE_RECURSIVE = NO 633 634 # The IMAGE_PATH tag can be used to specify one or more files or 635 # directories that contain image that are included in the documentation (see 636 # the \image command). 637 638 IMAGE_PATH = 639 640 # The INPUT_FILTER tag can be used to specify a program that doxygen should 641 # invoke to filter for each input file. Doxygen will invoke the filter program 642 # by executing (via popen()) the command <filter> <input-file>, where <filter> 643 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an 644 # input file. Doxygen will then use the output that the filter program writes 645 # to standard output. If FILTER_PATTERNS is specified, this tag will be 646 # ignored. 647 648 INPUT_FILTER = 649 650 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 651 # basis. Doxygen will compare the file name with each pattern and apply the 652 # filter if there is a match. The filters are a list of the form: 653 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 654 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER 655 # is applied to all files. 656 657 FILTER_PATTERNS = 658 659 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 660 # INPUT_FILTER) will be used to filter the input files when producing source 661 # files to browse (i.e. when SOURCE_BROWSER is set to YES). 662 663 FILTER_SOURCE_FILES = NO 664 665 #--------------------------------------------------------------------------- 666 # configuration options related to source browsing 667 #--------------------------------------------------------------------------- 668 669 # If the SOURCE_BROWSER tag is set to YES then a list of source files will 670 # be generated. Documented entities will be cross-referenced with these sources. 671 # Note: To get rid of all source code in the generated output, make sure also 672 # VERBATIM_HEADERS is set to NO. 673 674 SOURCE_BROWSER = YES 675 676 # Setting the INLINE_SOURCES tag to YES will include the body 677 # of functions and classes directly in the documentation. 678 679 INLINE_SOURCES = NO 680 681 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 682 # doxygen to hide any special comment blocks from generated source code 683 # fragments. Normal C and C++ comments will always remain visible. 684 685 STRIP_CODE_COMMENTS = YES 686 687 # If the REFERENCED_BY_RELATION tag is set to YES 688 # then for each documented function all documented 689 # functions referencing it will be listed. 690 691 REFERENCED_BY_RELATION = YES 692 693 # If the REFERENCES_RELATION tag is set to YES 694 # then for each documented function all documented entities 695 # called/used by that function will be listed. 696 697 REFERENCES_RELATION = YES 698 699 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default) 700 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from 701 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will 702 # link to the source code. Otherwise they will link to the documentstion. 703 704 REFERENCES_LINK_SOURCE = YES 705 706 # If the USE_HTAGS tag is set to YES then the references to source code 707 # will point to the HTML generated by the htags(1) tool instead of doxygen 708 # built-in source browser. The htags tool is part of GNU's global source 709 # tagging system (see http://www.gnu.org/software/global/global.html). You 710 # will need version 4.8.6 or higher. 711 712 USE_HTAGS = NO 713 714 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 715 # will generate a verbatim copy of the header file for each class for 716 # which an include is specified. Set to NO to disable this. 717 718 VERBATIM_HEADERS = YES 719 720 #--------------------------------------------------------------------------- 721 # configuration options related to the alphabetical class index 722 #--------------------------------------------------------------------------- 723 724 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 725 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 726 # in which this list will be split (can be a number in the range [1..20]) 727 728 COLS_IN_ALPHA_INDEX = 5 729 730 # In case all classes in a project start with a common prefix, all 731 # classes will be put under the same header in the alphabetical index. 732 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that 733 # should be ignored while generating the index headers. 734 735 IGNORE_PREFIX = Pm_ 736 737 #--------------------------------------------------------------------------- 738 # configuration options related to the HTML output 739 #--------------------------------------------------------------------------- 740 741 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will 742 # generate HTML output. 743 744 GENERATE_HTML = YES 745 746 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 747 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 748 # put in front of it. If left blank `html' will be used as the default path. 749 750 HTML_OUTPUT = html 751 752 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for 753 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank 754 # doxygen will generate files with .html extension. 755 756 HTML_FILE_EXTENSION = .html 757 758 # The HTML_HEADER tag can be used to specify a personal HTML header for 759 # each generated HTML page. If it is left blank doxygen will generate a 760 # standard header. 761 762 HTML_HEADER = 763 764 # The HTML_FOOTER tag can be used to specify a personal HTML footer for 765 # each generated HTML page. If it is left blank doxygen will generate a 766 # standard footer. 767 768 HTML_FOOTER = 769 770 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading 771 # style sheet that is used by each HTML page. It can be used to 772 # fine-tune the look of the HTML output. If the tag is left blank doxygen 773 # will generate a default style sheet. Note that doxygen will try to copy 774 # the style sheet file to the HTML output directory, so don't put your own 775 # stylesheet in the HTML output directory as well, or it will be erased! 776 777 HTML_STYLESHEET = 778 779 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 780 # files or namespaces will be aligned in HTML using tables. If set to 781 # NO a bullet list will be used. 782 783 HTML_ALIGN_MEMBERS = YES 784 785 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 786 # documentation will contain sections that can be hidden and shown after the 787 # page has loaded. For this to work a browser that supports 788 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox 789 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). 790 791 HTML_DYNAMIC_SECTIONS = NO 792 793 # If the GENERATE_DOCSET tag is set to YES, additional index files 794 # will be generated that can be used as input for Apple's Xcode 3 795 # integrated development environment, introduced with OSX 10.5 (Leopard). 796 # To create a documentation set, doxygen will generate a Makefile in the 797 # HTML output directory. Running make will produce the docset in that 798 # directory and running "make install" will install the docset in 799 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find 800 # it at startup. 801 # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information. 802 803 GENERATE_DOCSET = YES 804 805 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the 806 # feed. A documentation feed provides an umbrella under which multiple 807 # documentation sets from a single provider (such as a company or product suite) 808 # can be grouped. 809 810 DOCSET_FEEDNAME = "Doxygen generated docs" 811 812 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that 813 # should uniquely identify the documentation set bundle. This should be a 814 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen 815 # will append .docset to the name. 816 817 DOCSET_BUNDLE_ID = org.doxygen.Project 818 819 # If the GENERATE_HTMLHELP tag is set to YES, additional index files 820 # will be generated that can be used as input for tools like the 821 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm) 822 # of the generated HTML documentation. 823 824 GENERATE_HTMLHELP = NO 825 826 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 827 # be used to specify the file name of the resulting .chm file. You 828 # can add a path in front of the file if the result should not be 829 # written to the html output directory. 830 831 CHM_FILE = 832 833 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 834 # be used to specify the location (absolute path including file name) of 835 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 836 # the HTML help compiler on the generated index.hhp. 837 838 HHC_LOCATION = 839 840 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 841 # controls if a separate .chi index file is generated (YES) or that 842 # it should be included in the master .chm file (NO). 843 844 GENERATE_CHI = NO 845 846 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING 847 # is used to encode HtmlHelp index (hhk), content (hhc) and project file 848 # content. 849 # 1.5.7 850 # CHM_INDEX_ENCODING = 851 852 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 853 # controls whether a binary table of contents is generated (YES) or a 854 # normal table of contents (NO) in the .chm file. 855 856 BINARY_TOC = NO 857 858 # The TOC_EXPAND flag can be set to YES to add extra items for group members 859 # to the contents of the HTML help documentation and to the tree view. 860 861 TOC_EXPAND = NO 862 863 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER 864 # are set, an additional index file will be generated that can be used as input for 865 # Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated 866 # HTML documentation. 867 # 1.5.7 868 # GENERATE_QHP = NO 869 870 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can 871 # be used to specify the file name of the resulting .qch file. 872 # The path specified is relative to the HTML output folder. 873 # 1.5.7 874 # QCH_FILE = 875 876 # The QHP_NAMESPACE tag specifies the namespace to use when generating 877 # Qt Help Project output. For more information please see 878 # <a href="http://doc.trolltech.com/qthelpproject.html#namespace">Qt Help Project / Namespace</a>. 879 # 1.5.7 880 # QHP_NAMESPACE = org.doxygen.Project 881 882 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating 883 # Qt Help Project output. For more information please see 884 # <a href="http://doc.trolltech.com/qthelpproject.html#virtual-folders">Qt Help Project / Virtual Folders</a>. 885 # 1.5.7 886 # QHP_VIRTUAL_FOLDER = doc 887 888 # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can 889 # be used to specify the location of Qt's qhelpgenerator. 890 # If non-empty doxygen will try to run qhelpgenerator on the generated 891 # .qhp file . 892 # 1.5.7 893 # QHG_LOCATION = 894 895 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at 896 # top of each HTML page. The value NO (the default) enables the index and 897 # the value YES disables it. 898 899 DISABLE_INDEX = NO 900 901 # This tag can be used to set the number of enum values (range [1..20]) 902 # that doxygen will group on one line in the generated HTML documentation. 903 904 ENUM_VALUES_PER_LINE = 4 905 906 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 907 # structure should be generated to display hierarchical information. 908 # If the tag value is set to FRAME, a side panel will be generated 909 # containing a tree-like index structure (just like the one that 910 # is generated for HTML Help). For this to work a browser that supports 911 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, 912 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are 913 # probably better off using the HTML help feature. Other possible values 914 # for this tag are: HIERARCHIES, which will generate the Groups, Directories, 915 # and Class Hierarchy pages using a tree view instead of an ordered list; 916 # ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which 917 # disables this behavior completely. For backwards compatibility with previous 918 # releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE 919 # respectively. 920 921 GENERATE_TREEVIEW = YES 922 923 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 924 # used to set the initial width (in pixels) of the frame in which the tree 925 # is shown. 926 927 TREEVIEW_WIDTH = 200 928 929 # Use this tag to change the font size of Latex formulas included 930 # as images in the HTML documentation. The default is 10. Note that 931 # when you change the font size after a successful doxygen run you need 932 # to manually remove any form_*.png images from the HTML output directory 933 # to force them to be regenerated. 934 # 1.5.7 935 # FORMULA_FONTSIZE = 10 936 937 #--------------------------------------------------------------------------- 938 # configuration options related to the LaTeX output 939 #--------------------------------------------------------------------------- 940 941 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 942 # generate Latex output. 943 944 GENERATE_LATEX = YES 945 946 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 947 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 948 # put in front of it. If left blank `latex' will be used as the default path. 949 950 LATEX_OUTPUT = latex 951 952 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 953 # invoked. If left blank `latex' will be used as the default command name. 954 955 LATEX_CMD_NAME = latex 956 957 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 958 # generate index for LaTeX. If left blank `makeindex' will be used as the 959 # default command name. 960 961 MAKEINDEX_CMD_NAME = makeindex 962 963 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 964 # LaTeX documents. This may be useful for small projects and may help to 965 # save some trees in general. 966 967 COMPACT_LATEX = NO 968 969 # The PAPER_TYPE tag can be used to set the paper type that is used 970 # by the printer. Possible values are: a4, a4wide, letter, legal and 971 # executive. If left blank a4wide will be used. 972 973 PAPER_TYPE = a4wide 974 975 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 976 # packages that should be included in the LaTeX output. 977 978 EXTRA_PACKAGES = 979 980 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for 981 # the generated latex document. The header should contain everything until 982 # the first chapter. If it is left blank doxygen will generate a 983 # standard header. Notice: only use this tag if you know what you are doing! 984 985 LATEX_HEADER = 986 987 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 988 # is prepared for conversion to pdf (using ps2pdf). The pdf file will 989 # contain links (just like the HTML output) instead of page references 990 # This makes the output suitable for online browsing using a pdf viewer. 991 992 PDF_HYPERLINKS = YES 993 994 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 995 # plain latex in the generated Makefile. Set this option to YES to get a 996 # higher quality PDF documentation. 997 998 USE_PDFLATEX = YES 999 1000 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 1001 # command to the generated LaTeX files. This will instruct LaTeX to keep 1002 # running if errors occur, instead of asking the user for help. 1003 # This option is also used when generating formulas in HTML. 1004 1005 LATEX_BATCHMODE = YES 1006 1007 # If LATEX_HIDE_INDICES is set to YES then doxygen will not 1008 # include the index chapters (such as File Index, Compound Index, etc.) 1009 # in the output. 1010 1011 LATEX_HIDE_INDICES = NO 1012 1013 #--------------------------------------------------------------------------- 1014 # configuration options related to the RTF output 1015 #--------------------------------------------------------------------------- 1016 1017 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 1018 # The RTF output is optimized for Word 97 and may not look very pretty with 1019 # other RTF readers or editors. 1020 1021 GENERATE_RTF = NO 1022 1023 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 1024 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 1025 # put in front of it. If left blank `rtf' will be used as the default path. 1026 1027 RTF_OUTPUT = rtf 1028 1029 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact 1030 # RTF documents. This may be useful for small projects and may help to 1031 # save some trees in general. 1032 1033 COMPACT_RTF = NO 1034 1035 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 1036 # will contain hyperlink fields. The RTF file will 1037 # contain links (just like the HTML output) instead of page references. 1038 # This makes the output suitable for online browsing using WORD or other 1039 # programs which support those fields. 1040 # Note: wordpad (write) and others do not support links. 1041 1042 RTF_HYPERLINKS = NO 1043 1044 # Load stylesheet definitions from file. Syntax is similar to doxygen's 1045 # config file, i.e. a series of assignments. You only have to provide 1046 # replacements, missing definitions are set to their default value. 1047 1048 RTF_STYLESHEET_FILE = 1049 1050 # Set optional variables used in the generation of an rtf document. 1051 # Syntax is similar to doxygen's config file. 1052 1053 RTF_EXTENSIONS_FILE = 1054 1055 #--------------------------------------------------------------------------- 1056 # configuration options related to the man page output 1057 #--------------------------------------------------------------------------- 1058 1059 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will 1060 # generate man pages 1061 1062 GENERATE_MAN = NO 1063 1064 # The MAN_OUTPUT tag is used to specify where the man pages will be put. 1065 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 1066 # put in front of it. If left blank `man' will be used as the default path. 1067 1068 MAN_OUTPUT = man 1069 1070 # The MAN_EXTENSION tag determines the extension that is added to 1071 # the generated man pages (default is the subroutine's section .3) 1072 1073 MAN_EXTENSION = .3 1074 1075 # If the MAN_LINKS tag is set to YES and Doxygen generates man output, 1076 # then it will generate one additional man file for each entity 1077 # documented in the real man page(s). These additional files 1078 # only source the real man page, but without them the man command 1079 # would be unable to find the correct page. The default is NO. 1080 1081 MAN_LINKS = NO 1082 1083 #--------------------------------------------------------------------------- 1084 # configuration options related to the XML output 1085 #--------------------------------------------------------------------------- 1086 1087 # If the GENERATE_XML tag is set to YES Doxygen will 1088 # generate an XML file that captures the structure of 1089 # the code including all documentation. 1090 1091 GENERATE_XML = NO 1092 1093 # The XML_OUTPUT tag is used to specify where the XML pages will be put. 1094 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 1095 # put in front of it. If left blank `xml' will be used as the default path. 1096 1097 XML_OUTPUT = xml 1098 1099 # The XML_SCHEMA tag can be used to specify an XML schema, 1100 # which can be used by a validating XML parser to check the 1101 # syntax of the XML files. 1102 1103 XML_SCHEMA = 1104 1105 # The XML_DTD tag can be used to specify an XML DTD, 1106 # which can be used by a validating XML parser to check the 1107 # syntax of the XML files. 1108 1109 XML_DTD = 1110 1111 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will 1112 # dump the program listings (including syntax highlighting 1113 # and cross-referencing information) to the XML output. Note that 1114 # enabling this will significantly increase the size of the XML output. 1115 1116 XML_PROGRAMLISTING = YES 1117 1118 #--------------------------------------------------------------------------- 1119 # configuration options for the AutoGen Definitions output 1120 #--------------------------------------------------------------------------- 1121 1122 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 1123 # generate an AutoGen Definitions (see autogen.sf.net) file 1124 # that captures the structure of the code including all 1125 # documentation. Note that this feature is still experimental 1126 # and incomplete at the moment. 1127 1128 GENERATE_AUTOGEN_DEF = NO 1129 1130 #--------------------------------------------------------------------------- 1131 # configuration options related to the Perl module output 1132 #--------------------------------------------------------------------------- 1133 1134 # If the GENERATE_PERLMOD tag is set to YES Doxygen will 1135 # generate a Perl module file that captures the structure of 1136 # the code including all documentation. Note that this 1137 # feature is still experimental and incomplete at the 1138 # moment. 1139 1140 GENERATE_PERLMOD = NO 1141 1142 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate 1143 # the necessary Makefile rules, Perl scripts and LaTeX code to be able 1144 # to generate PDF and DVI output from the Perl module output. 1145 1146 PERLMOD_LATEX = NO 1147 1148 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 1149 # nicely formatted so it can be parsed by a human reader. This is useful 1150 # if you want to understand what is going on. On the other hand, if this 1151 # tag is set to NO the size of the Perl module output will be much smaller 1152 # and Perl will parse it just the same. 1153 1154 PERLMOD_PRETTY = YES 1155 1156 # The names of the make variables in the generated doxyrules.make file 1157 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 1158 # This is useful so different doxyrules.make files included by the same 1159 # Makefile don't overwrite each other's variables. 1160 1161 PERLMOD_MAKEVAR_PREFIX = 1162 1163 #--------------------------------------------------------------------------- 1164 # Configuration options related to the preprocessor 1165 #--------------------------------------------------------------------------- 1166 1167 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 1168 # evaluate all C-preprocessor directives found in the sources and include 1169 # files. 1170 1171 ENABLE_PREPROCESSING = YES 1172 1173 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 1174 # names in the source code. If set to NO (the default) only conditional 1175 # compilation will be performed. Macro expansion can be done in a controlled 1176 # way by setting EXPAND_ONLY_PREDEF to YES. 1177 1178 MACRO_EXPANSION = NO 1179 1180 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 1181 # then the macro expansion is limited to the macros specified with the 1182 # PREDEFINED and EXPAND_AS_DEFINED tags. 1183 1184 EXPAND_ONLY_PREDEF = NO 1185 1186 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 1187 # in the INCLUDE_PATH (see below) will be search if a #include is found. 1188 1189 SEARCH_INCLUDES = YES 1190 1191 # The INCLUDE_PATH tag can be used to specify one or more directories that 1192 # contain include files that are not input files but should be processed by 1193 # the preprocessor. 1194 1195 INCLUDE_PATH = 1196 1197 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 1198 # patterns (like *.h and *.hpp) to filter out the header-files in the 1199 # directories. If left blank, the patterns specified with FILE_PATTERNS will 1200 # be used. 1201 1202 INCLUDE_FILE_PATTERNS = 1203 1204 # The PREDEFINED tag can be used to specify one or more macro names that 1205 # are defined before the preprocessor is started (similar to the -D option of 1206 # gcc). The argument of the tag is a list of macros of the form: name 1207 # or name=definition (no spaces). If the definition and the = are 1208 # omitted =1 is assumed. To prevent a macro definition from being 1209 # undefined via #undef or recursively expanded use the := operator 1210 # instead of the = operator. 1211 1212 PREDEFINED = FL_DOXYGEN \ 1213 HAVE_CAIRO \ 1214 HAVE_GL \ 1215 HAVE_GL_OVERLAY \ 1216 FL_EXPORT:= 1217 1218 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 1219 # this tag can be used to specify a list of macro names that should be expanded. 1220 # The macro definition that is found in the sources will be used. 1221 # Use the PREDEFINED tag if you want to use a different macro definition. 1222 1223 EXPAND_AS_DEFINED = 1224 1225 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 1226 # doxygen's preprocessor will remove all function-like macros that are alone 1227 # on a line, have an all uppercase name, and do not end with a semicolon. Such 1228 # function macros are typically used for boiler-plate code, and will confuse 1229 # the parser if not removed. 1230 1231 SKIP_FUNCTION_MACROS = YES 1232 1233 #--------------------------------------------------------------------------- 1234 # Configuration::additions related to external references 1235 #--------------------------------------------------------------------------- 1236 1237 # The TAGFILES option can be used to specify one or more tagfiles. 1238 # Optionally an initial location of the external documentation 1239 # can be added for each tagfile. The format of a tag file without 1240 # this location is as follows: 1241 # TAGFILES = file1 file2 ... 1242 # Adding location for the tag files is done as follows: 1243 # TAGFILES = file1=loc1 "file2 = loc2" ... 1244 # where "loc1" and "loc2" can be relative or absolute paths or 1245 # URLs. If a location is present for each tag, the installdox tool 1246 # does not have to be run to correct the links. 1247 # Note that each tag file must have a unique name 1248 # (where the name does NOT include the path) 1249 # If a tag file is not located in the directory in which doxygen 1250 # is run, you must also specify the path to the tagfile here. 1251 1252 TAGFILES = 1253 1254 # When a file name is specified after GENERATE_TAGFILE, doxygen will create 1255 # a tag file that is based on the input files it reads. 1256 1257 GENERATE_TAGFILE = 1258 1259 # If the ALLEXTERNALS tag is set to YES all external classes will be listed 1260 # in the class index. If set to NO only the inherited external classes 1261 # will be listed. 1262 1263 ALLEXTERNALS = NO 1264 1265 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 1266 # in the modules index. If set to NO, only the current project's groups will 1267 # be listed. 1268 1269 EXTERNAL_GROUPS = YES 1270 1271 # The PERL_PATH should be the absolute path and name of the perl script 1272 # interpreter (i.e. the result of `which perl'). 1273 1274 PERL_PATH = /usr/bin/perl 1275 1276 #--------------------------------------------------------------------------- 1277 # Configuration options related to the dot tool 1278 #--------------------------------------------------------------------------- 1279 1280 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 1281 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base 1282 # or super classes. Setting the tag to NO turns the diagrams off. Note that 1283 # this option is superseded by the HAVE_DOT option below. This is only a 1284 # fallback. It is recommended to install and use dot, since it yields more 1285 # powerful graphs. 1286 1287 CLASS_DIAGRAMS = YES 1288 1289 # You can define message sequence charts within doxygen comments using the \msc 1290 # command. Doxygen will then run the mscgen tool (see 1291 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the 1292 # documentation. The MSCGEN_PATH tag allows you to specify the directory where 1293 # the mscgen tool resides. If left empty the tool is assumed to be found in the 1294 # default search path. 1295 1296 MSCGEN_PATH = 1297 1298 # If set to YES, the inheritance and collaboration graphs will hide 1299 # inheritance and usage relations if the target is undocumented 1300 # or is not a class. 1301 1302 HIDE_UNDOC_RELATIONS = YES 1303 1304 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 1305 # available from the path. This tool is part of Graphviz, a graph visualization 1306 # toolkit from AT&T and Lucent Bell Labs. The other options in this section 1307 # have no effect if this option is set to NO (the default) 1308 1309 HAVE_DOT = NO 1310 1311 # By default doxygen will write a font called FreeSans.ttf to the output 1312 # directory and reference it in all dot files that doxygen generates. This 1313 # font does not include all possible unicode characters however, so when you need 1314 # these (or just want a differently looking font) you can specify the font name 1315 # using DOT_FONTNAME. You need need to make sure dot is able to find the font, 1316 # which can be done by putting it in a standard location or by setting the 1317 # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory 1318 # containing the font. 1319 # 1.5.7 1320 # DOT_FONTNAME = FreeSans 1321 1322 # By default doxygen will tell dot to use the output directory to look for the 1323 # FreeSans.ttf font (which doxygen will put there itself). If you specify a 1324 # different font using DOT_FONTNAME you can set the path where dot 1325 # can find it using this tag. 1326 # 1.5.7 1327 # DOT_FONTPATH = 1328 1329 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 1330 # will generate a graph for each documented class showing the direct and 1331 # indirect inheritance relations. Setting this tag to YES will force the 1332 # the CLASS_DIAGRAMS tag to NO. 1333 1334 CLASS_GRAPH = YES 1335 1336 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 1337 # will generate a graph for each documented class showing the direct and 1338 # indirect implementation dependencies (inheritance, containment, and 1339 # class references variables) of the class with other documented classes. 1340 1341 COLLABORATION_GRAPH = YES 1342 1343 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen 1344 # will generate a graph for groups, showing the direct groups dependencies 1345 1346 GROUP_GRAPHS = YES 1347 1348 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and 1349 # collaboration diagrams in a style similar to the OMG's Unified Modeling 1350 # Language. 1351 1352 UML_LOOK = NO 1353 1354 # If set to YES, the inheritance and collaboration graphs will show the 1355 # relations between templates and their instances. 1356 1357 TEMPLATE_RELATIONS = NO 1358 1359 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 1360 # tags are set to YES then doxygen will generate a graph for each documented 1361 # file showing the direct and indirect include dependencies of the file with 1362 # other documented files. 1363 1364 INCLUDE_GRAPH = YES 1365 1366 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 1367 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each 1368 # documented header file showing the documented files that directly or 1369 # indirectly include this file. 1370 1371 INCLUDED_BY_GRAPH = YES 1372 1373 # If the CALL_GRAPH and HAVE_DOT options are set to YES then 1374 # doxygen will generate a call dependency graph for every global function 1375 # or class method. Note that enabling this option will significantly increase 1376 # the time of a run. So in most cases it will be better to enable call graphs 1377 # for selected functions only using the \callgraph command. 1378 1379 CALL_GRAPH = NO 1380 1381 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then 1382 # doxygen will generate a caller dependency graph for every global function 1383 # or class method. Note that enabling this option will significantly increase 1384 # the time of a run. So in most cases it will be better to enable caller 1385 # graphs for selected functions only using the \callergraph command. 1386 1387 CALLER_GRAPH = NO 1388 1389 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 1390 # will graphical hierarchy of all classes instead of a textual one. 1391 1392 GRAPHICAL_HIERARCHY = YES 1393 1394 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES 1395 # then doxygen will show the dependencies a directory has on other directories 1396 # in a graphical way. The dependency relations are determined by the #include 1397 # relations between the files in the directories. 1398 1399 DIRECTORY_GRAPH = YES 1400 1401 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 1402 # generated by dot. Possible values are png, jpg, or gif 1403 # If left blank png will be used. 1404 1405 DOT_IMAGE_FORMAT = png 1406 1407 # The tag DOT_PATH can be used to specify the path where the dot tool can be 1408 # found. If left blank, it is assumed the dot tool can be found in the path. 1409 1410 DOT_PATH = 1411 1412 # The DOTFILE_DIRS tag can be used to specify one or more directories that 1413 # contain dot files that are included in the documentation (see the 1414 # \dotfile command). 1415 1416 DOTFILE_DIRS = 1417 1418 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of 1419 # nodes that will be shown in the graph. If the number of nodes in a graph 1420 # becomes larger than this value, doxygen will truncate the graph, which is 1421 # visualized by representing a node as a red box. Note that doxygen if the 1422 # number of direct children of the root node in a graph is already larger than 1423 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note 1424 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. 1425 1426 DOT_GRAPH_MAX_NODES = 50 1427 1428 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 1429 # graphs generated by dot. A depth value of 3 means that only nodes reachable 1430 # from the root by following a path via at most 3 edges will be shown. Nodes 1431 # that lay further from the root node will be omitted. Note that setting this 1432 # option to 1 or 2 may greatly reduce the computation time needed for large 1433 # code bases. Also note that the size of a graph can be further restricted by 1434 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. 1435 1436 MAX_DOT_GRAPH_DEPTH = 0 1437 1438 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 1439 # background. This is disabled by default, because dot on Windows does not 1440 # seem to support this out of the box. Warning: Depending on the platform used, 1441 # enabling this option may lead to badly anti-aliased labels on the edges of 1442 # a graph (i.e. they become hard to read). 1443 1444 DOT_TRANSPARENT = NO 1445 1446 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output 1447 # files in one run (i.e. multiple -o and -T options on the command line). This 1448 # makes dot run faster, but since only newer versions of dot (>1.8.10) 1449 # support this, this feature is disabled by default. 1450 1451 DOT_MULTI_TARGETS = NO 1452 1453 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 1454 # generate a legend page explaining the meaning of the various boxes and 1455 # arrows in the dot generated graphs. 1456 1457 GENERATE_LEGEND = YES 1458 1459 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 1460 # remove the intermediate dot files that are used to generate 1461 # the various graphs. 1462 1463 DOT_CLEANUP = YES 1464 1465 #--------------------------------------------------------------------------- 1466 # Configuration::additions related to the search engine 1467 #--------------------------------------------------------------------------- 1468 1469 # The SEARCHENGINE tag specifies whether or not a search engine should be 1470 # used. If set to NO the values of all tags below this one will be ignored. 1471 1472 SEARCHENGINE = NO