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