Changeset 207
- Timestamp:
- 02/07/08 07:14:35 (4 years ago)
- Files:
-
- branches/2.3.2beta3/doxconf (modified) (17 diffs)
- branches/2.3.2beta3/doxconf.in (modified) (17 diffs)
Legend:
- Unmodified
- Added
- Removed
- Modified
- Copied
- Moved
branches/2.3.2beta3/doxconf
r170 r207 11 11 # Values that contain spaces should be placed between quotes (" ") 12 12 13 #---------------------------------------------------------------------------14 # Project related configuration options15 #---------------------------------------------------------------------------16 17 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded18 # by quotes) that should identify the project.19 20 13 PROJECT_NAME = FahMon 21 22 # The PROJECT_NUMBER tag can be used to enter a project or revision number.23 # This could be handy for archiving the generated documentation or24 # if some version control system is used.25 26 14 PROJECT_NUMBER = 2.3.2beta3 27 28 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)29 # base path where the generated documentation will be put.30 # If a relative path is entered, it will be relative to the location31 # where doxygen was started. If left blank the current directory will be used.32 33 15 OUTPUT_DIRECTORY = doc 34 35 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create36 # 4096 sub-directories (in 2 levels) under the output directory of each output37 # format and will distribute the generated files over these directories.38 # Enabling this option can be useful when feeding doxygen a huge amount of39 # source files, where putting all generated files in the same directory would40 # otherwise cause performance problems for the file system.41 42 16 CREATE_SUBDIRS = NO 43 44 # The OUTPUT_LANGUAGE tag is used to specify the language in which all45 # documentation generated by doxygen is written. Doxygen will use this46 # information to generate all constant output in the proper language.47 # The default language is English, other supported languages are:48 # Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish,49 # Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese,50 # Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian,51 # Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish,52 # Swedish, and Ukrainian.53 54 17 OUTPUT_LANGUAGE = English 55 56 # This tag can be used to specify the encoding used in the generated output.57 # The encoding is not always determined by the language that is chosen,58 # but also whether or not the output is meant for Windows or non-Windows users.59 # In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES60 # forces the Windows encoding (this is the default for the Windows binary),61 # whereas setting the tag to NO uses a Unix-style encoding (the default for62 # all platforms other than Windows).63 64 18 USE_WINDOWS_ENCODING = NO 65 66 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will67 # include brief member descriptions after the members that are listed in68 # the file and class documentation (similar to JavaDoc).69 # Set to NO to disable this.70 71 19 BRIEF_MEMBER_DESC = YES 72 73 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend74 # the brief description of a member or function before the detailed description.75 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the76 # brief descriptions will be completely suppressed.77 78 20 REPEAT_BRIEF = YES 79 80 # This tag implements a quasi-intelligent brief description abbreviator81 # that is used to form the text in various listings. Each string82 # in this list, if found as the leading text of the brief description, will be83 # stripped from the text and the result after processing the whole list, is84 # used as the annotated text. Otherwise, the brief description is used as-is.85 # If left blank, the following values are used ("$name" is automatically86 # replaced with the name of the entity): "The $name class" "The $name widget"87 # "The $name file" "is" "provides" "specifies" "contains"88 # "represents" "a" "an" "the"89 90 21 ABBREVIATE_BRIEF = 91 92 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then93 # Doxygen will generate a detailed section even if there is only a brief94 # description.95 96 22 ALWAYS_DETAILED_SEC = NO 97 98 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all99 # inherited members of a class in the documentation of that class as if those100 # members were ordinary class members. Constructors, destructors and assignment101 # operators of the base classes will not be shown.102 103 23 INLINE_INHERITED_MEMB = NO 104 105 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full106 # path before files name in the file list and in the header files. If set107 # to NO the shortest path that makes the file name unique will be used.108 109 24 FULL_PATH_NAMES = YES 110 111 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag112 # can be used to strip a user-defined part of the path. Stripping is113 # only done if one of the specified strings matches the left-hand part of114 # the path. The tag can be used to show relative paths in the file list.115 # If left blank the directory from which doxygen is run is used as the116 # path to strip.117 118 25 STRIP_FROM_PATH = 119 120 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of121 # the path mentioned in the documentation of a class, which tells122 # the reader which header file to include in order to use a class.123 # If left blank only the name of the header file containing the class124 # definition is used. Otherwise one should specify the include paths that125 # are normally passed to the compiler using the -I flag.126 127 26 STRIP_FROM_INC_PATH = 128 129 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter130 # (but less readable) file names. This can be useful is your file systems131 # doesn't support long names like on DOS, Mac, or CD-ROM.132 133 27 SHORT_NAMES = NO 134 135 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen136 # will interpret the first line (until the first dot) of a JavaDoc-style137 # comment as the brief description. If set to NO, the JavaDoc138 # comments will behave just like the Qt-style comments (thus requiring an139 # explicit @brief command for a brief description.140 141 28 JAVADOC_AUTOBRIEF = YES 142 143 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen144 # treat a multi-line C++ special comment block (i.e. a block of //! or ///145 # comments) as a brief description. This used to be the default behaviour.146 # The new default is to treat a multi-line C++ comment block as a detailed147 # description. Set this tag to YES if you prefer the old behaviour instead.148 149 29 MULTILINE_CPP_IS_BRIEF = NO 150 151 # If the DETAILS_AT_TOP tag is set to YES then Doxygen152 # will output the detailed description near the top, like JavaDoc.153 # If set to NO, the detailed description appears after the member154 # documentation.155 156 30 DETAILS_AT_TOP = NO 157 158 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented159 # member inherits the documentation from any documented member that it160 # re-implements.161 162 31 INHERIT_DOCS = YES 163 164 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce165 # a new page for each member. If set to NO, the documentation of a member will166 # be part of the file/class/namespace that contains it.167 168 32 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 33 TAB_SIZE = 8 174 175 # This tag can be used to specify a number of aliases that acts176 # as commands in the documentation. An alias has the form "name=value".177 # For example adding "sideeffect=\par Side Effects:\n" will allow you to178 # put the command \sideeffect (or @sideeffect) in the documentation, which179 # 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 34 ALIASES = 183 184 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C185 # 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 list187 # of all members will be omitted, etc.188 189 35 OPTIMIZE_OUTPUT_FOR_C = NO 190 191 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java192 # sources only. Doxygen will then generate output that is more tailored for Java.193 # For instance, namespaces will be presented as packages, qualified scopes194 # will look different, etc.195 196 36 OPTIMIZE_OUTPUT_JAVA = NO 197 198 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to199 # include (a tag file for) the STL sources as input, then you should200 # set this tag to YES in order to let doxygen match functions declarations and201 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.202 # func(std::string) {}). This also make the inheritance and collaboration203 # diagrams that involve STL classes more complete and accurate.204 205 37 BUILTIN_STL_SUPPORT = NO 206 207 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC208 # tag is set to YES, then doxygen will reuse the documentation of the first209 # member in the group (if any) for the other members of the group. By default210 # all members of a group must be documented explicitly.211 212 38 DISTRIBUTE_GROUP_DOC = NO 213 214 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of215 # the same type (for instance a group of public functions) to be put as a216 # subgroup of that type (e.g. under the Public Functions section). Set it to217 # NO to prevent subgrouping. Alternatively, this can be done per class using218 # the \nosubgrouping command.219 220 39 SUBGROUPING = YES 221 40 … … 224 43 #--------------------------------------------------------------------------- 225 44 226 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in227 # documentation are documented, even if no documentation was available.228 # Private class members and static file members will be hidden unless229 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES230 231 45 EXTRACT_ALL = YES 232 233 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class234 # will be included in the documentation.235 236 46 EXTRACT_PRIVATE = YES 237 238 # If the EXTRACT_STATIC tag is set to YES all static members of a file239 # will be included in the documentation.240 241 47 EXTRACT_STATIC = YES 242 243 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)244 # defined locally in source files will be included in the documentation.245 # If set to NO only classes defined in header files are included.246 247 48 EXTRACT_LOCAL_CLASSES = YES 248 249 # This flag is only useful for Objective-C code. When set to YES local250 # methods, which are defined in the implementation section but not in251 # the interface are included in the documentation.252 # If set to NO (the default) only methods in the interface are included.253 254 49 EXTRACT_LOCAL_METHODS = YES 255 256 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all257 # undocumented members of documented classes, files or namespaces.258 # If set to NO (the default) these members will be included in the259 # various overviews, but no documentation section is generated.260 # This option has no effect if EXTRACT_ALL is enabled.261 262 50 HIDE_UNDOC_MEMBERS = NO 263 264 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all265 # undocumented classes that are normally visible in the class hierarchy.266 # If set to NO (the default) these classes will be included in the various267 # overviews. This option has no effect if EXTRACT_ALL is enabled.268 269 51 HIDE_UNDOC_CLASSES = NO 270 271 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all272 # friend (class|struct|union) declarations.273 # If set to NO (the default) these declarations will be included in the274 # documentation.275 276 52 HIDE_FRIEND_COMPOUNDS = NO 277 278 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any279 # documentation blocks found inside the body of a function.280 # If set to NO (the default) these blocks will be appended to the281 # function's detailed documentation block.282 283 53 HIDE_IN_BODY_DOCS = NO 284 285 # The INTERNAL_DOCS tag determines if documentation286 # that is typed after a \internal command is included. If the tag is set287 # to NO (the default) then the documentation will be excluded.288 # Set it to YES to include the internal documentation.289 290 54 INTERNAL_DOCS = NO 291 292 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate293 # file names in lower-case letters. If set to YES upper-case letters are also294 # allowed. This is useful if you have classes or files whose names only differ295 # in case and if your file system supports case sensitive file names. Windows296 # and Mac users are advised to set this option to NO.297 298 55 CASE_SENSE_NAMES = YES 299 300 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen301 # will show members with their full class and namespace scopes in the302 # documentation. If set to YES the scope will be hidden.303 304 56 HIDE_SCOPE_NAMES = NO 305 306 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen307 # will put a list of the files that are included by a file in the documentation308 # of that file.309 310 57 SHOW_INCLUDE_FILES = YES 311 312 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]313 # is inserted in the documentation for inline members.314 315 58 INLINE_INFO = YES 316 317 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen318 # will sort the (detailed) documentation of file and class members319 # alphabetically by member name. If set to NO the members will appear in320 # declaration order.321 322 59 SORT_MEMBER_DOCS = YES 323 324 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the325 # brief documentation of file, namespace and class members alphabetically326 # by member name. If set to NO (the default) the members will appear in327 # declaration order.328 329 60 SORT_BRIEF_DOCS = NO 330 331 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be332 # sorted by fully-qualified names, including namespaces. If set to333 # NO (the default), the class list will be sorted only by class name,334 # not including the namespace part.335 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.336 # Note: This option applies only to the class list, not to the337 # alphabetical list.338 339 61 SORT_BY_SCOPE_NAME = NO 340 341 # The GENERATE_TODOLIST tag can be used to enable (YES) or342 # disable (NO) the todo list. This list is created by putting \todo343 # commands in the documentation.344 345 62 GENERATE_TODOLIST = YES 346 347 # The GENERATE_TESTLIST tag can be used to enable (YES) or348 # disable (NO) the test list. This list is created by putting \test349 # commands in the documentation.350 351 63 GENERATE_TESTLIST = YES 352 353 # The GENERATE_BUGLIST tag can be used to enable (YES) or354 # disable (NO) the bug list. This list is created by putting \bug355 # commands in the documentation.356 357 64 GENERATE_BUGLIST = YES 358 359 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or360 # disable (NO) the deprecated list. This list is created by putting361 # \deprecated commands in the documentation.362 363 65 GENERATE_DEPRECATEDLIST= YES 364 365 # The ENABLED_SECTIONS tag can be used to enable conditional366 # documentation sections, marked by \if sectionname ... \endif.367 368 66 ENABLED_SECTIONS = 369 370 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines371 # the initial value of a variable or define consists of for it to appear in372 # the documentation. If the initializer consists of more lines than specified373 # here it will be hidden. Use a value of 0 to hide initializers completely.374 # The appearance of the initializer of individual variables and defines in the375 # documentation can be controlled using \showinitializer or \hideinitializer376 # command in the documentation regardless of this setting.377 378 67 MAX_INITIALIZER_LINES = 30 379 380 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated381 # at the bottom of the documentation of classes and structs. If set to YES the382 # list will mention the files that were used to generate the documentation.383 384 68 SHOW_USED_FILES = YES 385 386 # If the sources in your project are distributed over multiple directories387 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy388 # in the documentation. The default is NO.389 390 69 SHOW_DIRECTORIES = NO 391 392 # The FILE_VERSION_FILTER tag can be used to specify a program or script that393 # doxygen should invoke to get the current version for each file (typically from the394 # version control system). Doxygen will invoke the program by executing (via395 # popen()) the command <command> <input-file>, where <command> is the value of396 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file397 # provided by doxygen. Whatever the program writes to standard output398 # is used as the file version. See the manual for examples.399 400 70 FILE_VERSION_FILTER = 401 71 … … 404 74 #--------------------------------------------------------------------------- 405 75 406 # The QUIET tag can be used to turn on/off the messages that are generated407 # by doxygen. Possible values are YES and NO. If left blank NO is used.408 409 76 QUIET = NO 410 411 # The WARNINGS tag can be used to turn on/off the warning messages that are412 # generated by doxygen. Possible values are YES and NO. If left blank413 # NO is used.414 415 77 WARNINGS = YES 416 417 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings418 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will419 # automatically be disabled.420 421 78 WARN_IF_UNDOCUMENTED = YES 422 423 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for424 # potential errors in the documentation, such as not documenting some425 # parameters in a documented function, or documenting parameters that426 # don't exist or using markup commands wrongly.427 428 79 WARN_IF_DOC_ERROR = YES 429 430 # This WARN_NO_PARAMDOC option can be abled to get warnings for431 # functions that are documented, but have no documentation for their parameters432 # or return value. If set to NO (the default) doxygen will only warn about433 # wrong or incomplete parameter documentation, but not about the absence of434 # documentation.435 436 80 WARN_NO_PARAMDOC = NO 437 438 # The WARN_FORMAT tag determines the format of the warning messages that439 # doxygen can produce. The string should contain the $file, $line, and $text440 # tags, which will be replaced by the file and line number from which the441 # warning originated and the warning text. Optionally the format may contain442 # $version, which will be replaced by the version of the file (if it could443 # be obtained via FILE_VERSION_FILTER)444 445 81 WARN_FORMAT = "$file:$line: $text" 446 447 # The WARN_LOGFILE tag can be used to specify a file to which warning448 # and error messages should be written. If left blank the output is written449 # to stderr.450 451 82 WARN_LOGFILE = 452 83 … … 455 86 #--------------------------------------------------------------------------- 456 87 457 # The INPUT tag can be used to specify the files and/or directories that contain458 # documented source files. You may enter file names like "myfile.cpp" or459 # directories like "/usr/src/myproject". Separate the files or directories460 # with spaces.461 462 88 INPUT = src src/include 463 464 # If the value of the INPUT tag contains directories, you can use the465 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp466 # and *.h) to filter out the source-files in the directories. If left467 # blank the following patterns are tested:468 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx469 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py470 471 89 FILE_PATTERNS = 472 473 # The RECURSIVE tag can be used to turn specify whether or not subdirectories474 # should be searched for input files as well. Possible values are YES and NO.475 # If left blank NO is used.476 477 90 RECURSIVE = NO 478 479 # The EXCLUDE tag can be used to specify files and/or directories that should480 # excluded from the INPUT source files. This way you can easily exclude a481 # subdirectory from a directory tree whose root is specified with the INPUT tag.482 483 91 EXCLUDE = src/gettext.h 484 485 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or486 # directories that are symbolic links (a Unix filesystem feature) are excluded487 # from the input.488 489 92 EXCLUDE_SYMLINKS = NO 490 491 # If the value of the INPUT tag contains directories, you can use the492 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude493 # certain files from those directories. Note that the wildcards are matched494 # against the file with absolute path, so to exclude all test directories495 # for example use the pattern */test/*496 497 93 EXCLUDE_PATTERNS = 498 499 # The EXAMPLE_PATH tag can be used to specify one or more files or500 # directories that contain example code fragments that are included (see501 # the \include command).502 503 94 EXAMPLE_PATH = 504 505 # If the value of the EXAMPLE_PATH tag contains directories, you can use the506 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp507 # and *.h) to filter out the source-files in the directories. If left508 # blank all files are included.509 510 95 EXAMPLE_PATTERNS = 511 512 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be513 # searched for input files to be used with the \include or \dontinclude514 # commands irrespective of the value of the RECURSIVE tag.515 # Possible values are YES and NO. If left blank NO is used.516 517 96 EXAMPLE_RECURSIVE = NO 518 519 # The IMAGE_PATH tag can be used to specify one or more files or520 # directories that contain image that are included in the documentation (see521 # the \image command).522 523 97 IMAGE_PATH = 524 525 # The INPUT_FILTER tag can be used to specify a program that doxygen should526 # invoke to filter for each input file. Doxygen will invoke the filter program527 # by executing (via popen()) the command <filter> <input-file>, where <filter>528 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an529 # input file. Doxygen will then use the output that the filter program writes530 # to standard output. If FILTER_PATTERNS is specified, this tag will be531 # ignored.532 533 98 INPUT_FILTER = 534 535 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern536 # basis. Doxygen will compare the file name with each pattern and apply the537 # filter if there is a match. The filters are a list of the form:538 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further539 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER540 # is applied to all files.541 542 99 FILTER_PATTERNS = 543 544 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using545 # INPUT_FILTER) will be used to filter the input files when producing source546 # files to browse (i.e. when SOURCE_BROWSER is set to YES).547 548 100 FILTER_SOURCE_FILES = NO 549 101 … … 552 104 #--------------------------------------------------------------------------- 553 105 554 # If the SOURCE_BROWSER tag is set to YES then a list of source files will555 # be generated. Documented entities will be cross-referenced with these sources.556 # Note: To get rid of all source code in the generated output, make sure also557 # VERBATIM_HEADERS is set to NO.558 559 106 SOURCE_BROWSER = YES 560 561 # Setting the INLINE_SOURCES tag to YES will include the body562 # of functions and classes directly in the documentation.563 564 107 INLINE_SOURCES = NO 565 566 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct567 # doxygen to hide any special comment blocks from generated source code568 # fragments. Normal C and C++ comments will always remain visible.569 570 108 STRIP_CODE_COMMENTS = YES 571 572 # If the REFERENCED_BY_RELATION tag is set to YES (the default)573 # then for each documented function all documented574 # functions referencing it will be listed.575 576 109 REFERENCED_BY_RELATION = YES 577 578 # If the REFERENCES_RELATION tag is set to YES (the default)579 # then for each documented function all documented entities580 # called/used by that function will be listed.581 582 110 REFERENCES_RELATION = YES 583 584 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)585 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from586 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will587 # link to the source code. Otherwise they will link to the documentstion.588 589 111 REFERENCES_LINK_SOURCE = YES 590 591 # If the USE_HTAGS tag is set to YES then the references to source code592 # will point to the HTML generated by the htags(1) tool instead of doxygen593 # built-in source browser. The htags tool is part of GNU's global source594 # tagging system (see http://www.gnu.org/software/global/global.html). You595 # will need version 4.8.6 or higher.596 597 112 USE_HTAGS = NO 598 599 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen600 # will generate a verbatim copy of the header file for each class for601 # which an include is specified. Set to NO to disable this.602 603 113 VERBATIM_HEADERS = YES 604 114 … … 607 117 #--------------------------------------------------------------------------- 608 118 609 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index610 # of all compounds will be generated. Enable this if the project611 # contains a lot of classes, structs, unions or interfaces.612 613 119 ALPHABETICAL_INDEX = YES 614 615 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then616 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns617 # in which this list will be split (can be a number in the range [1..20])618 619 120 COLS_IN_ALPHA_INDEX = 5 620 621 # In case all classes in a project start with a common prefix, all622 # classes will be put under the same header in the alphabetical index.623 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that624 # should be ignored while generating the index headers.625 626 121 IGNORE_PREFIX = 627 122 … … 630 125 #--------------------------------------------------------------------------- 631 126 632 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will633 # generate HTML output.634 635 127 GENERATE_HTML = YES 636 637 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.638 # If a relative path is entered the value of OUTPUT_DIRECTORY will be639 # put in front of it. If left blank `html' will be used as the default path.640 641 128 HTML_OUTPUT = html 642 643 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for644 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank645 # doxygen will generate files with .html extension.646 647 129 HTML_FILE_EXTENSION = .html 648 649 # The HTML_HEADER tag can be used to specify a personal HTML header for650 # each generated HTML page. If it is left blank doxygen will generate a651 # standard header.652 653 130 HTML_HEADER = 654 655 # The HTML_FOOTER tag can be used to specify a personal HTML footer for656 # each generated HTML page. If it is left blank doxygen will generate a657 # standard footer.658 659 131 HTML_FOOTER = 660 661 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading662 # style sheet that is used by each HTML page. It can be used to663 # fine-tune the look of the HTML output. If the tag is left blank doxygen664 # will generate a default style sheet. Note that doxygen will try to copy665 # the style sheet file to the HTML output directory, so don't put your own666 # stylesheet in the HTML output directory as well, or it will be erased!667 668 132 HTML_STYLESHEET = 669 670 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,671 # files or namespaces will be aligned in HTML using tables. If set to672 # NO a bullet list will be used.673 674 133 HTML_ALIGN_MEMBERS = YES 675 676 # If the GENERATE_HTMLHELP tag is set to YES, additional index files677 # will be generated that can be used as input for tools like the678 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)679 # of the generated HTML documentation.680 681 134 GENERATE_HTMLHELP = NO 682 683 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can684 # be used to specify the file name of the resulting .chm file. You685 # can add a path in front of the file if the result should not be686 # written to the html output directory.687 688 135 CHM_FILE = 689 690 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can691 # be used to specify the location (absolute path including file name) of692 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run693 # the HTML help compiler on the generated index.hhp.694 695 136 HHC_LOCATION = 696 697 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag698 # controls if a separate .chi index file is generated (YES) or that699 # it should be included in the master .chm file (NO).700 701 137 GENERATE_CHI = NO 702 703 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag704 # controls whether a binary table of contents is generated (YES) or a705 # normal table of contents (NO) in the .chm file.706 707 138 BINARY_TOC = NO 708 709 # The TOC_EXPAND flag can be set to YES to add extra items for group members710 # to the contents of the HTML help documentation and to the tree view.711 712 139 TOC_EXPAND = NO 713 714 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at715 # top of each HTML page. The value NO (the default) enables the index and716 # the value YES disables it.717 718 140 DISABLE_INDEX = NO 719 720 # This tag can be used to set the number of enum values (range [1..20])721 # that doxygen will group on one line in the generated HTML documentation.722 723 141 ENUM_VALUES_PER_LINE = 4 724 725 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be726 # generated containing a tree-like index structure (just like the one that727 # is generated for HTML Help). For this to work a browser that supports728 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,729 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are730 # probably better off using the HTML help feature.731 732 142 GENERATE_TREEVIEW = NO 733 734 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be735 # used to set the initial width (in pixels) of the frame in which the tree736 # is shown.737 738 143 TREEVIEW_WIDTH = 250 739 144 … … 742 147 #--------------------------------------------------------------------------- 743 148 744 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will745 # generate Latex output.746 747 149 GENERATE_LATEX = YES 748 749 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.750 # If a relative path is entered the value of OUTPUT_DIRECTORY will be751 # put in front of it. If left blank `latex' will be used as the default path.752 753 150 LATEX_OUTPUT = latex 754 755 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be756 # invoked. If left blank `latex' will be used as the default command name.757 758 151 LATEX_CMD_NAME = latex 759 760 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to761 # generate index for LaTeX. If left blank `makeindex' will be used as the762 # default command name.763 764 152 MAKEINDEX_CMD_NAME = makeindex 765 766 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact767 # LaTeX documents. This may be useful for small projects and may help to768 # save some trees in general.769 770 153 COMPACT_LATEX = NO 771 772 # The PAPER_TYPE tag can be used to set the paper type that is used773 # by the printer. Possible values are: a4, a4wide, letter, legal and774 # executive. If left blank a4wide will be used.775 776 154 PAPER_TYPE = a4wide 777 778 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX779 # packages that should be included in the LaTeX output.780 781 155 EXTRA_PACKAGES = 782 783 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for784 # the generated latex document. The header should contain everything until785 # the first chapter. If it is left blank doxygen will generate a786 # standard header. Notice: only use this tag if you know what you are doing!787 788 156 LATEX_HEADER = 789 790 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated791 # is prepared for conversion to pdf (using ps2pdf). The pdf file will792 # contain links (just like the HTML output) instead of page references793 # This makes the output suitable for online browsing using a pdf viewer.794 795 157 PDF_HYPERLINKS = YES 796 797 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of798 # plain latex in the generated Makefile. Set this option to YES to get a799 # higher quality PDF documentation.800 801 158 USE_PDFLATEX = YES 802 803 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.804 # command to the generated LaTeX files. This will instruct LaTeX to keep805 # running if errors occur, instead of asking the user for help.806 # This option is also used when generating formulas in HTML.807 808 159 LATEX_BATCHMODE = NO 809 810 # If LATEX_HIDE_INDICES is set to YES then doxygen will not811 # include the index chapters (such as File Index, Compound Index, etc.)812 # in the output.813 814 160 LATEX_HIDE_INDICES = NO 815 161 … … 818 164 #--------------------------------------------------------------------------- 819 165 820 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output821 # The RTF output is optimized for Word 97 and may not look very pretty with822 # other RTF readers or editors.823 824 166 GENERATE_RTF = NO 825 826 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.827 # If a relative path is entered the value of OUTPUT_DIRECTORY will be828 # put in front of it. If left blank `rtf' will be used as the default path.829 830 167 RTF_OUTPUT = rtf 831 832 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact833 # RTF documents. This may be useful for small projects and may help to834 # save some trees in general.835 836 168 COMPACT_RTF = NO 837 838 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated839 # will contain hyperlink fields. The RTF file will840 # contain links (just like the HTML output) instead of page references.841 # This makes the output suitable for online browsing using WORD or other842 # programs which support those fields.843 # Note: wordpad (write) and others do not support links.844 845 169 RTF_HYPERLINKS = NO 846 847 # Load stylesheet definitions from file. Syntax is similar to doxygen's848 # config file, i.e. a series of assignments. You only have to provide849 # replacements, missing definitions are set to their default value.850 851 170 RTF_STYLESHEET_FILE = 852 853 # Set optional variables used in the generation of an rtf document.854 # Syntax is similar to doxygen's config file.855 856 171 RTF_EXTENSIONS_FILE = 857 172 … … 860 175 #--------------------------------------------------------------------------- 861 176 862 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will863 # generate man pages864 865 177 GENERATE_MAN = NO 866 867 # The MAN_OUTPUT tag is used to specify where the man pages will be put.868 # If a relative path is entered the value of OUTPUT_DIRECTORY will be869 # put in front of it. If left blank `man' will be used as the default path.870 871 178 MAN_OUTPUT = man 872 873 # The MAN_EXTENSION tag determines the extension that is added to874 # the generated man pages (default is the subroutine's section .3)875 876 179 MAN_EXTENSION = .3 877 878 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,879 # then it will generate one additional man file for each entity880 # documented in the real man page(s). These additional files881 # only source the real man page, but without them the man command882 # would be unable to find the correct page. The default is NO.883 884 180 MAN_LINKS = NO 885 181 … … 888 184 #--------------------------------------------------------------------------- 889 185 890 # If the GENERATE_XML tag is set to YES Doxygen will891 # generate an XML file that captures the structure of892 # the code including all documentation.893 894 186 GENERATE_XML = NO 895 896 # The XML_OUTPUT tag is used to specify where the XML pages will be put.897 # If a relative path is entered the value of OUTPUT_DIRECTORY will be898 # put in front of it. If left blank `xml' will be used as the default path.899 900 187 XML_OUTPUT = xml 901 902 # The XML_SCHEMA tag can be used to specify an XML schema,903 # which can be used by a validating XML parser to check the904 # syntax of the XML files.905 906 188 XML_SCHEMA = 907 908 # The XML_DTD tag can be used to specify an XML DTD,909 # which can be used by a validating XML parser to check the910 # syntax of the XML files.911 912 189 XML_DTD = 913 914 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will915 # dump the program listings (including syntax highlighting916 # and cross-referencing information) to the XML output. Note that917 # enabling this will significantly increase the size of the XML output.918 919 190 XML_PROGRAMLISTING = YES 920 191 … … 923 194 #--------------------------------------------------------------------------- 924 195 925 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will926 # generate an AutoGen Definitions (see autogen.sf.net) file927 # that captures the structure of the code including all928 # documentation. Note that this feature is still experimental929 # and incomplete at the moment.930 931 196 GENERATE_AUTOGEN_DEF = NO 932 197 … … 935 200 #--------------------------------------------------------------------------- 936 201 937 # If the GENERATE_PERLMOD tag is set to YES Doxygen will938 # generate a Perl module file that captures the structure of939 # the code including all documentation. Note that this940 # feature is still experimental and incomplete at the941 # moment.942 943 202 GENERATE_PERLMOD = NO 944 945 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate946 # the necessary Makefile rules, Perl scripts and LaTeX code to be able947 # to generate PDF and DVI output from the Perl module output.948 949 203 PERLMOD_LATEX = NO 950 951 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be952 # nicely formatted so it can be parsed by a human reader. This is useful953 # if you want to understand what is going on. On the other hand, if this954 # tag is set to NO the size of the Perl module output will be much smaller955 # and Perl will parse it just the same.956 957 204 PERLMOD_PRETTY = YES 958 959 # The names of the make variables in the generated doxyrules.make file960 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.961 # This is useful so different doxyrules.make files included by the same962 # Makefile don't overwrite each other's variables.963 964 205 PERLMOD_MAKEVAR_PREFIX = 965 206 … … 968 209 #--------------------------------------------------------------------------- 969 210 970 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will971 # evaluate all C-preprocessor directives found in the sources and include972 # files.973 974 211 ENABLE_PREPROCESSING = YES 975 976 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro977 # names in the source code. If set to NO (the default) only conditional978 # compilation will be performed. Macro expansion can be done in a controlled979 # way by setting EXPAND_ONLY_PREDEF to YES.980 981 212 MACRO_EXPANSION = NO 982 983 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES984 # then the macro expansion is limited to the macros specified with the985 # PREDEFINED and EXPAND_AS_DEFINED tags.986 987 213 EXPAND_ONLY_PREDEF = NO 988 989 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files990 # in the INCLUDE_PATH (see below) will be search if a #include is found.991 992 214 SEARCH_INCLUDES = YES 993 994 # The INCLUDE_PATH tag can be used to specify one or more directories that995 # contain include files that are not input files but should be processed by996 # the preprocessor.997 998 215 INCLUDE_PATH = 999 1000 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard1001 # patterns (like *.h and *.hpp) to filter out the header-files in the1002 # directories. If left blank, the patterns specified with FILE_PATTERNS will1003 # be used.1004 1005 216 INCLUDE_FILE_PATTERNS = 1006 1007 # The PREDEFINED tag can be used to specify one or more macro names that1008 # are defined before the preprocessor is started (similar to the -D option of1009 # gcc). The argument of the tag is a list of macros of the form: name1010 # or name=definition (no spaces). If the definition and the = are1011 # omitted =1 is assumed. To prevent a macro definition from being1012 # undefined via #undef or recursively expanded use the := operator1013 # instead of the = operator.1014 1015 217 PREDEFINED = 1016 1017 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then1018 # this tag can be used to specify a list of macro names that should be expanded.1019 # The macro definition that is found in the sources will be used.1020 # Use the PREDEFINED tag if you want to use a different macro definition.1021 1022 218 EXPAND_AS_DEFINED = 1023 1024 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then1025 # doxygen's preprocessor will remove all function-like macros that are alone1026 # on a line, have an all uppercase name, and do not end with a semicolon. Such1027 # function macros are typically used for boiler-plate code, and will confuse1028 # the parser if not removed.1029 1030 219 SKIP_FUNCTION_MACROS = YES 1031 220 … … 1034 223 #--------------------------------------------------------------------------- 1035 224 1036 # The TAGFILES option can be used to specify one or more tagfiles.1037 # Optionally an initial location of the external documentation1038 # can be added for each tagfile. The format of a tag file without1039 # this location is as follows:1040 # TAGFILES = file1 file2 ...1041 # Adding location for the tag files is done as follows:1042 # TAGFILES = file1=loc1 "file2 = loc2" ...1043 # where "loc1" and "loc2" can be relative or absolute paths or1044 # URLs. If a location is present for each tag, the installdox tool1045 # does not have to be run to correct the links.1046 # Note that each tag file must have a unique name1047 # (where the name does NOT include the path)1048 # If a tag file is not located in the directory in which doxygen1049 # is run, you must also specify the path to the tagfile here.1050 1051 225 TAGFILES = 1052 1053 # When a file name is specified after GENERATE_TAGFILE, doxygen will create1054 # a tag file that is based on the input files it reads.1055 1056 226 GENERATE_TAGFILE = 1057 1058 # If the ALLEXTERNALS tag is set to YES all external classes will be listed1059 # in the class index. If set to NO only the inherited external classes1060 # will be listed.1061 1062 227 ALLEXTERNALS = NO 1063 1064 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed1065 # in the modules index. If set to NO, only the current project's groups will1066 # be listed.1067 1068 228 EXTERNAL_GROUPS = YES 1069 1070 # The PERL_PATH should be the absolute path and name of the perl script1071 # interpreter (i.e. the result of `which perl').1072 1073 229 PERL_PATH = /usr/bin/perl 1074 230 … … 1077 233 #--------------------------------------------------------------------------- 1078 234 1079 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will1080 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base1081 # or super classes. Setting the tag to NO turns the diagrams off. Note that1082 # this option is superseded by the HAVE_DOT option below. This is only a1083 # fallback. It is recommended to install and use dot, since it yields more1084 # powerful graphs.1085 1086 235 CLASS_DIAGRAMS = YES 1087 1088 # If set to YES, the inheritance and collaboration graphs will hide1089 # inheritance and usage relations if the target is undocumented1090 # or is not a class.1091 1092 236 HIDE_UNDOC_RELATIONS = YES 1093 1094 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is1095 # available from the path. This tool is part of Graphviz, a graph visualization1096 # toolkit from AT&T and Lucent Bell Labs. The other options in this section1097 # have no effect if this option is set to NO (the default)1098 1099 237 HAVE_DOT = YES 1100 1101 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen1102 # will generate a graph for each documented class showing the direct and1103 # indirect inheritance relations. Setting this tag to YES will force the1104 # the CLASS_DIAGRAMS tag to NO.1105 1106 238 CLASS_GRAPH = YES 1107 1108 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen1109 # will generate a graph for each documented class showing the direct and1110 # indirect implementation dependencies (inheritance, containment, and1111 # class references variables) of the class with other documented classes.1112 1113 239 COLLABORATION_GRAPH = YES 1114 1115 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen1116 # will generate a graph for groups, showing the direct groups dependencies1117 1118 240 GROUP_GRAPHS = YES 1119 1120 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and1121 # collaboration diagrams in a style similar to the OMG's Unified Modeling1122 # Language.1123 1124 241 UML_LOOK = YES 1125 1126 # If set to YES, the inheritance and collaboration graphs will show the1127 # relations between templates and their instances.1128 1129 242 TEMPLATE_RELATIONS = YES 1130 1131 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT1132 # tags are set to YES then doxygen will generate a graph for each documented1133 # file showing the direct and indirect include dependencies of the file with1134 # other documented files.1135 1136 243 INCLUDE_GRAPH = YES 1137 1138 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and1139 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each1140 # documented header file showing the documented files that directly or1141 # indirectly include this file.1142 1143 244 INCLUDED_BY_GRAPH = YES 1144 1145 # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will1146 # generate a call dependency graph for every global function or class method.1147 # Note that enabling this option will significantly increase the time of a run.1148 # So in most cases it will be better to enable call graphs for selected1149 # functions only using the \callgraph command.1150 1151 245 CALL_GRAPH = YES 1152 1153 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then doxygen will1154 # generate a caller dependency graph for every global function or class method.1155 # Note that enabling this option will significantly increase the time of a run.1156 # So in most cases it will be better to enable caller graphs for selected1157 # functions only using the \callergraph command.1158 1159 246 CALLER_GRAPH = YES 1160 1161 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen1162 # will graphical hierarchy of all classes instead of a textual one.1163 1164 247 GRAPHICAL_HIERARCHY = YES 1165 1166 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES1167 # then doxygen will show the dependencies a directory has on other directories1168 # in a graphical way. The dependency relations are determined by the #include1169 # relations between the files in the directories.1170 1171 248 DIRECTORY_GRAPH = YES 1172 1173 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images1174 # generated by dot. Possible values are png, jpg, or gif1175 # If left blank png will be used.1176 1177 249 DOT_IMAGE_FORMAT = png 1178 1179 # The tag DOT_PATH can be used to specify the path where the dot tool can be1180 # found. If left blank, it is assumed the dot tool can be found in the path.1181 1182 250 DOT_PATH = 1183 1184 # The DOTFILE_DIRS tag can be used to specify one or more directories that1185 # contain dot files that are included in the documentation (see the1186 # \dotfile command).1187 1188 251 DOTFILE_DIRS = 1189 1190 # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width1191 # (in pixels) of the graphs generated by dot. If a graph becomes larger than1192 # this value, doxygen will try to truncate the graph, so that it fits within1193 # the specified constraint. Beware that most browsers cannot cope with very1194 # large images.1195 1196 252 MAX_DOT_GRAPH_WIDTH = 1024 1197 1198 # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height1199 # (in pixels) of the graphs generated by dot. If a graph becomes larger than1200 # this value, doxygen will try to truncate the graph, so that it fits within1201 # the specified constraint. Beware that most browsers cannot cope with very1202 # large images.1203 1204 253 MAX_DOT_GRAPH_HEIGHT = 1024 1205 1206 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the1207 # graphs generated by dot. A depth value of 3 means that only nodes reachable1208 # from the root by following a path via at most 3 edges will be shown. Nodes1209 # that lay further from the root node will be omitted. Note that setting this1210 # option to 1 or 2 may greatly reduce the computation time needed for large1211 # code bases. Also note that a graph may be further truncated if the graph's1212 # image dimensions are not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH1213 # and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the depth value (the default),1214 # the graph is not depth-constrained.1215 1216 254 MAX_DOT_GRAPH_DEPTH = 0 1217 1218 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent1219 # background. This is disabled by default, which results in a white background.1220 # Warning: Depending on the platform used, enabling this option may lead to1221 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to1222 # read).1223 1224 255 DOT_TRANSPARENT = NO 1225 1226 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output1227 # files in one run (i.e. multiple -o and -T options on the command line). This1228 # makes dot run faster, but since only newer versions of dot (>1.8.10)1229 # support this, this feature is disabled by default.1230 1231 256 DOT_MULTI_TARGETS = YES 1232 1233 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will1234 # generate a legend page explaining the meaning of the various boxes and1235 # arrows in the dot generated graphs.1236 1237 257 GENERATE_LEGEND = YES 1238 1239 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will1240 # remove the intermediate dot files that are used to generate1241 # the various graphs.1242 1243 258 DOT_CLEANUP = YES 1244 259 … … 1247 262 #--------------------------------------------------------------------------- 1248 263 1249 # The SEARCHENGINE tag specifies whether or not a search engine should be1250 # used. If set to NO the values of all tags below this one will be ignored.1251 1252 264 SEARCHENGINE = NO branches/2.3.2beta3/doxconf.in
r158 r207 11 11 # Values that contain spaces should be placed between quotes (" ") 12 12 13 #---------------------------------------------------------------------------14 # Project related configuration options15 #---------------------------------------------------------------------------16 17 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded18 # by quotes) that should identify the project.19 20 13 PROJECT_NAME = FahMon 21 22 # The PROJECT_NUMBER tag can be used to enter a project or revision number.23 # This could be handy for archiving the generated documentation or24 # if some version control system is used.25 26 14 PROJECT_NUMBER = @PACKAGE_VERSION@ 27 28 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)29 # base path where the generated documentation will be put.30 # If a relative path is entered, it will be relative to the location31 # where doxygen was started. If left blank the current directory will be used.32 33 15 OUTPUT_DIRECTORY = doc 34 35 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create36 # 4096 sub-directories (in 2 levels) under the output directory of each output37 # format and will distribute the generated files over these directories.38 # Enabling this option can be useful when feeding doxygen a huge amount of39 # source files, where putting all generated files in the same directory would40 # otherwise cause performance problems for the file system.41 42 16 CREATE_SUBDIRS = NO 43 44 # The OUTPUT_LANGUAGE tag is used to specify the language in which all45 # documentation generated by doxygen is written. Doxygen will use this46 # information to generate all constant output in the proper language.47 # The default language is English, other supported languages are:48 # Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish,49 # Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese,50 # Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian,51 # Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish,52 # Swedish, and Ukrainian.53 54 17 OUTPUT_LANGUAGE = English 55 56 # This tag can be used to specify the encoding used in the generated output.57 # The encoding is not always determined by the language that is chosen,58 # but also whether or not the output is meant for Windows or non-Windows users.59 # In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES60 # forces the Windows encoding (this is the default for the Windows binary),61 # whereas setting the tag to NO uses a Unix-style encoding (the default for62 # all platforms other than Windows).63 64 18 USE_WINDOWS_ENCODING = NO 65 66 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will67 # include brief member descriptions after the members that are listed in68 # the file and class documentation (similar to JavaDoc).69 # Set to NO to disable this.70 71 19 BRIEF_MEMBER_DESC = YES 72 73 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend74 # the brief description of a member or function before the detailed description.75 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the76 # brief descriptions will be completely suppressed.77 78 20 REPEAT_BRIEF = YES 79 80 # This tag implements a quasi-intelligent brief description abbreviator81 # that is used to form the text in various listings. Each string82 # in this list, if found as the leading text of the brief description, will be83 # stripped from the text and the result after processing the whole list, is84 # used as the annotated text. Otherwise, the brief description is used as-is.85 # If left blank, the following values are used ("$name" is automatically86 # replaced with the name of the entity): "The $name class" "The $name widget"87 # "The $name file" "is" "provides" "specifies" "contains"88 # "represents" "a" "an" "the"89 90 21 ABBREVIATE_BRIEF = 91 92 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then93 # Doxygen will generate a detailed section even if there is only a brief94 # description.95 96 22 ALWAYS_DETAILED_SEC = NO 97 98 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all99 # inherited members of a class in the documentation of that class as if those100 # members were ordinary class members. Constructors, destructors and assignment101 # operators of the base classes will not be shown.102 103 23 INLINE_INHERITED_MEMB = NO 104 105 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full106 # path before files name in the file list and in the header files. If set107 # to NO the shortest path that makes the file name unique will be used.108 109 24 FULL_PATH_NAMES = YES 110 111 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag112 # can be used to strip a user-defined part of the path. Stripping is113 # only done if one of the specified strings matches the left-hand part of114 # the path. The tag can be used to show relative paths in the file list.115 # If left blank the directory from which doxygen is run is used as the116 # path to strip.117 118 25 STRIP_FROM_PATH = 119 120 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of121 # the path mentioned in the documentation of a class, which tells122 # the reader which header file to include in order to use a class.123 # If left blank only the name of the header file containing the class124 # definition is used. Otherwise one should specify the include paths that125 # are normally passed to the compiler using the -I flag.126 127 26 STRIP_FROM_INC_PATH = 128 129 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter130 # (but less readable) file names. This can be useful is your file systems131 # doesn't support long names like on DOS, Mac, or CD-ROM.132 133 27 SHORT_NAMES = NO 134 135 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen136 # will interpret the first line (until the first dot) of a JavaDoc-style137 # comment as the brief description. If set to NO, the JavaDoc138 # comments will behave just like the Qt-style comments (thus requiring an139 # explicit @brief command for a brief description.140 141 28 JAVADOC_AUTOBRIEF = YES 142 143 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen144 # treat a multi-line C++ special comment block (i.e. a block of //! or ///145 # comments) as a brief description. This used to be the default behaviour.146 # The new default is to treat a multi-line C++ comment block as a detailed147 # description. Set this tag to YES if you prefer the old behaviour instead.148 149 29 MULTILINE_CPP_IS_BRIEF = NO 150 151 # If the DETAILS_AT_TOP tag is set to YES then Doxygen152 # will output the detailed description near the top, like JavaDoc.153 # If set to NO, the detailed description appears after the member154 # documentation.155 156 30 DETAILS_AT_TOP = NO 157 158 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented159 # member inherits the documentation from any documented member that it160 # re-implements.161 162 31 INHERIT_DOCS = YES 163 164 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce165 # a new page for each member. If set to NO, the documentation of a member will166 # be part of the file/class/namespace that contains it.167 168 32 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 33 TAB_SIZE = 8 174 175 # This tag can be used to specify a number of aliases that acts176 # as commands in the documentation. An alias has the form "name=value".177 # For example adding "sideeffect=\par Side Effects:\n" will allow you to178 # put the command \sideeffect (or @sideeffect) in the documentation, which179 # 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 34 ALIASES = 183 184 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C185 # 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 list187 # of all members will be omitted, etc.188 189 35 OPTIMIZE_OUTPUT_FOR_C = NO 190 191 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java192 # sources only. Doxygen will then generate output that is more tailored for Java.193 # For instance, namespaces will be presented as packages, qualified scopes194 # will look different, etc.195 196 36 OPTIMIZE_OUTPUT_JAVA = NO 197 198 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to199 # include (a tag file for) the STL sources as input, then you should200 # set this tag to YES in order to let doxygen match functions declarations and201 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.202 # func(std::string) {}). This also make the inheritance and collaboration203 # diagrams that involve STL classes more complete and accurate.204 205 37 BUILTIN_STL_SUPPORT = NO 206 207 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC208 # tag is set to YES, then doxygen will reuse the documentation of the first209 # member in the group (if any) for the other members of the group. By default210 # all members of a group must be documented explicitly.211 212 38 DISTRIBUTE_GROUP_DOC = NO 213 214 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of215 # the same type (for instance a group of public functions) to be put as a216 # subgroup of that type (e.g. under the Public Functions section). Set it to217 # NO to prevent subgrouping. Alternatively, this can be done per class using218 # the \nosubgrouping command.219 220 39 SUBGROUPING = YES 221 40 … … 224 43 #--------------------------------------------------------------------------- 225 44 226 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in227 # documentation are documented, even if no documentation was available.228 # Private class members and static file members will be hidden unless229 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES230 231 45 EXTRACT_ALL = YES 232 233 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class234 # will be included in the documentation.235 236 46 EXTRACT_PRIVATE = YES 237 238 # If the EXTRACT_STATIC tag is set to YES all static members of a file239 # will be included in the documentation.240 241 47 EXTRACT_STATIC = YES 242 243 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)244 # defined locally in source files will be included in the documentation.245 # If set to NO only classes defined in header files are included.246 247 48 EXTRACT_LOCAL_CLASSES = YES 248 249 # This flag is only useful for Objective-C code. When set to YES local250 # methods, which are defined in the implementation section but not in251 # the interface are included in the documentation.252 # If set to NO (the default) only methods in the interface are included.253 254 49 EXTRACT_LOCAL_METHODS = YES 255 256 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all257 # undocumented members of documented classes, files or namespaces.258 # If set to NO (the default) these members will be included in the259 # various overviews, but no documentation section is generated.260 # This option has no effect if EXTRACT_ALL is enabled.261 262 50 HIDE_UNDOC_MEMBERS = NO 263 264 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all265 # undocumented classes that are normally visible in the class hierarchy.266 # If set to NO (the default) these classes will be included in the various267 # overviews. This option has no effect if EXTRACT_ALL is enabled.268 269 51 HIDE_UNDOC_CLASSES = NO 270 271 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all272 # friend (class|struct|union) declarations.273 # If set to NO (the default) these declarations will be included in the274 # documentation.275 276 52 HIDE_FRIEND_COMPOUNDS = NO 277 278 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any279 # documentation blocks found inside the body of a function.280 # If set to NO (the default) these blocks will be appended to the281 # function's detailed documentation block.282 283 53 HIDE_IN_BODY_DOCS = NO 284 285 # The INTERNAL_DOCS tag determines if documentation286 # that is typed after a \internal command is included. If the tag is set287 # to NO (the default) then the documentation will be excluded.288 # Set it to YES to include the internal documentation.289 290 54 INTERNAL_DOCS = NO 291 292 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate293 # file names in lower-case letters. If set to YES upper-case letters are also294 # allowed. This is useful if you have classes or files whose names only differ295 # in case and if your file system supports case sensitive file names. Windows296 # and Mac users are advised to set this option to NO.297 298 55 CASE_SENSE_NAMES = YES 299 300 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen301 # will show members with their full class and namespace scopes in the302 # documentation. If set to YES the scope will be hidden.303 304 56 HIDE_SCOPE_NAMES = NO 305 306 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen307 # will put a list of the files that are included by a file in the documentation308 # of that file.309 310 57 SHOW_INCLUDE_FILES = YES 311 312 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]313 # is inserted in the documentation for inline members.314 315 58 INLINE_INFO = YES 316 317 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen318 # will sort the (detailed) documentation of file and class members319 # alphabetically by member name. If set to NO the members will appear in320 # declaration order.321 322 59 SORT_MEMBER_DOCS = YES 323 324 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the325 # brief documentation of file, namespace and class members alphabetically326 # by member name. If set to NO (the default) the members will appear in327 # declaration order.328 329 60 SORT_BRIEF_DOCS = NO 330 331 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be332 # sorted by fully-qualified names, including namespaces. If set to333 # NO (the default), the class list will be sorted only by class name,334 # not including the namespace part.335 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.336 # Note: This option applies only to the class list, not to the337 # alphabetical list.338 339 61 SORT_BY_SCOPE_NAME = NO 340 341 # The GENERATE_TODOLIST tag can be used to enable (YES) or342 # disable (NO) the todo list. This list is created by putting \todo343 # commands in the documentation.344 345 62 GENERATE_TODOLIST = YES 346 347 # The GENERATE_TESTLIST tag can be used to enable (YES) or348 # disable (NO) the test list. This list is created by putting \test349 # commands in the documentation.350 351 63 GENERATE_TESTLIST = YES 352 353 # The GENERATE_BUGLIST tag can be used to enable (YES) or354 # disable (NO) the bug list. This list is created by putting \bug355 # commands in the documentation.356 357 64 GENERATE_BUGLIST = YES 358 359 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or360 # disable (NO) the deprecated list. This list is created by putting361 # \deprecated commands in the documentation.362 363 65 GENERATE_DEPRECATEDLIST= YES 364 365 # The ENABLED_SECTIONS tag can be used to enable conditional366 # documentation sections, marked by \if sectionname ... \endif.367 368 66 ENABLED_SECTIONS = 369 370 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines371 # the initial value of a variable or define consists of for it to appear in372 # the documentation. If the initializer consists of more lines than specified373 # here it will be hidden. Use a value of 0 to hide initializers completely.374 # The appearance of the initializer of individual variables and defines in the375 # documentation can be controlled using \showinitializer or \hideinitializer376 # command in the documentation regardless of this setting.377 378 67 MAX_INITIALIZER_LINES = 30 379 380 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated381 # at the bottom of the documentation of classes and structs. If set to YES the382 # list will mention the files that were used to generate the documentation.383 384 68 SHOW_USED_FILES = YES 385 386 # If the sources in your project are distributed over multiple directories387 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy388 # in the documentation. The default is NO.389 390 69 SHOW_DIRECTORIES = NO 391 392 # The FILE_VERSION_FILTER tag can be used to specify a program or script that393 # doxygen should invoke to get the current version for each file (typically from the394 # version control system). Doxygen will invoke the program by executing (via395 # popen()) the command <command> <input-file>, where <command> is the value of396 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file397 # provided by doxygen. Whatever the program writes to standard output398 # is used as the file version. See the manual for examples.399 400 70 FILE_VERSION_FILTER = 401 71 … … 404 74 #--------------------------------------------------------------------------- 405 75 406 # The QUIET tag can be used to turn on/off the messages that are generated407 # by doxygen. Possible values are YES and NO. If left blank NO is used.408 409 76 QUIET = NO 410 411 # The WARNINGS tag can be used to turn on/off the warning messages that are412 # generated by doxygen. Possible values are YES and NO. If left blank413 # NO is used.414 415 77 WARNINGS = YES 416 417 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings418 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will419 # automatically be disabled.420 421 78 WARN_IF_UNDOCUMENTED = YES 422 423 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for424 # potential errors in the documentation, such as not documenting some425 # parameters in a documented function, or documenting parameters that426 # don't exist or using markup commands wrongly.427 428 79 WARN_IF_DOC_ERROR = YES 429 430 # This WARN_NO_PARAMDOC option can be abled to get warnings for431 # functions that are documented, but have no documentation for their parameters432 # or return value. If set to NO (the default) doxygen will only warn about433 # wrong or incomplete parameter documentation, but not about the absence of434 # documentation.435 436 80 WARN_NO_PARAMDOC = NO 437 438 # The WARN_FORMAT tag determines the format of the warning messages that439 # doxygen can produce. The string should contain the $file, $line, and $text440 # tags, which will be replaced by the file and line number from which the441 # warning originated and the warning text. Optionally the format may contain442 # $version, which will be replaced by the version of the file (if it could443 # be obtained via FILE_VERSION_FILTER)444 445 81 WARN_FORMAT = "$file:$line: $text" 446 447 # The WARN_LOGFILE tag can be used to specify a file to which warning448 # and error messages should be written. If left blank the output is written449 # to stderr.450 451 82 WARN_LOGFILE = 452 83 … … 455 86 #--------------------------------------------------------------------------- 456 87 457 # The INPUT tag can be used to specify the files and/or directories that contain458 # documented source files. You may enter file names like "myfile.cpp" or459 # directories like "/usr/src/myproject". Separate the files or directories460 # with spaces.461 462 88 INPUT = src src/include 463 464 # If the value of the INPUT tag contains directories, you can use the465 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp466 # and *.h) to filter out the source-files in the directories. If left467 # blank the following patterns are tested:468 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx469 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py470 471 89 FILE_PATTERNS = 472 473 # The RECURSIVE tag can be used to turn specify whether or not subdirectories474 # should be searched for input files as well. Possible values are YES and NO.475 # If left blank NO is used.476 477 90 RECURSIVE = NO 478 479 # The EXCLUDE tag can be used to specify files and/or directories that should480 # excluded from the INPUT source files. This way you can easily exclude a481 # subdirectory from a directory tree whose root is specified with the INPUT tag.482 483 91 EXCLUDE = src/gettext.h 484 485 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or486 # directories that are symbolic links (a Unix filesystem feature) are excluded487 # from the input.488 489 92 EXCLUDE_SYMLINKS = NO 490 491 # If the value of the INPUT tag contains directories, you can use the492 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude493 # certain files from those directories. Note that the wildcards are matched494 # against the file with absolute path, so to exclude all test directories495 # for example use the pattern */test/*496 497 93 EXCLUDE_PATTERNS = 498 499 # The EXAMPLE_PATH tag can be used to specify one or more files or500 # directories that contain example code fragments that are included (see501 # the \include command).502 503 94 EXAMPLE_PATH = 504 505 # If the value of the EXAMPLE_PATH tag contains directories, you can use the506 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp507 # and *.h) to filter out the source-files in the directories. If left508 # blank all files are included.509 510 95 EXAMPLE_PATTERNS = 511 512 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be513 # searched for input files to be used with the \include or \dontinclude514 # commands irrespective of the value of the RECURSIVE tag.515 # Possible values are YES and NO. If left blank NO is used.516 517 96 EXAMPLE_RECURSIVE = NO 518 519 # The IMAGE_PATH tag can be used to specify one or more files or520 # directories that contain image that are included in the documentation (see521 # the \image command).522 523 97 IMAGE_PATH = 524 525 # The INPUT_FILTER tag can be used to specify a program that doxygen should526 # invoke to filter for each input file. Doxygen will invoke the filter program527 # by executing (via popen()) the command <filter> <input-file>, where <filter>528 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an529 # input file. Doxygen will then use the output that the filter program writes530 # to standard output. If FILTER_PATTERNS is specified, this tag will be531 # ignored.532 533 98 INPUT_FILTER = 534 535 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern536 # basis. Doxygen will compare the file name with each pattern and apply the537 # filter if there is a match. The filters are a list of the form:538 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further539 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER540 # is applied to all files.541 542 99 FILTER_PATTERNS = 543 544 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using545 # INPUT_FILTER) will be used to filter the input files when producing source546 # files to browse (i.e. when SOURCE_BROWSER is set to YES).547 548 100 FILTER_SOURCE_FILES = NO 549 101 … … 552 104 #--------------------------------------------------------------------------- 553 105 554 # If the SOURCE_BROWSER tag is set to YES then a list of source files will555 # be generated. Documented entities will be cross-referenced with these sources.556 # Note: To get rid of all source code in the generated output, make sure also557 # VERBATIM_HEADERS is set to NO.558 559 106 SOURCE_BROWSER = YES 560 561 # Setting the INLINE_SOURCES tag to YES will include the body562 # of functions and classes directly in the documentation.563 564 107 INLINE_SOURCES = NO 565 566 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct567 # doxygen to hide any special comment blocks from generated source code568 # fragments. Normal C and C++ comments will always remain visible.569 570 108 STRIP_CODE_COMMENTS = YES 571 572 # If the REFERENCED_BY_RELATION tag is set to YES (the default)573 # then for each documented function all documented574 # functions referencing it will be listed.575 576 109 REFERENCED_BY_RELATION = YES 577 578 # If the REFERENCES_RELATION tag is set to YES (the default)579 # then for each documented function all documented entities580 # called/used by that function will be listed.581 582 110 REFERENCES_RELATION = YES 583 584 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)585 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from586 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will587 # link to the source code. Otherwise they will link to the documentstion.588 589 111 REFERENCES_LINK_SOURCE = YES 590 591 # If the USE_HTAGS tag is set to YES then the references to source code592 # will point to the HTML generated by the htags(1) tool instead of doxygen593 # built-in source browser. The htags tool is part of GNU's global source594 # tagging system (see http://www.gnu.org/software/global/global.html). You595 # will need version 4.8.6 or higher.596 597 112 USE_HTAGS = NO 598 599 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen600 # will generate a verbatim copy of the header file for each class for601 # which an include is specified. Set to NO to disable this.602 603 113 VERBATIM_HEADERS = YES 604 114 … … 607 117 #--------------------------------------------------------------------------- 608 118 609 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index610 # of all compounds will be generated. Enable this if the project611 # contains a lot of classes, structs, unions or interfaces.612 613 119 ALPHABETICAL_INDEX = YES 614 615 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then616 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns617 # in which this list will be split (can be a number in the range [1..20])618 619 120 COLS_IN_ALPHA_INDEX = 5 620 621 # In case all classes in a project start with a common prefix, all622 # classes will be put under the same header in the alphabetical index.623 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that624 # should be ignored while generating the index headers.625 626 121 IGNORE_PREFIX = 627 122 … … 630 125 #--------------------------------------------------------------------------- 631 126 632 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will633 # generate HTML output.634 635 127 GENERATE_HTML = YES 636 637 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.638 # If a relative path is entered the value of OUTPUT_DIRECTORY will be639 # put in front of it. If left blank `html' will be used as the default path.640 641 128 HTML_OUTPUT = html 642 643 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for644 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank645 # doxygen will generate files with .html extension.646 647 129 HTML_FILE_EXTENSION = .html 648 649 # The HTML_HEADER tag can be used to specify a personal HTML header for650 # each generated HTML page. If it is left blank doxygen will generate a651 # standard header.652 653 130 HTML_HEADER = 654 655 # The HTML_FOOTER tag can be used to specify a personal HTML footer for656 # each generated HTML page. If it is left blank doxygen will generate a657 # standard footer.658 659 131 HTML_FOOTER = 660 661 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading662 # style sheet that is used by each HTML page. It can be used to663 # fine-tune the look of the HTML output. If the tag is left blank doxygen664 # will generate a default style sheet. Note that doxygen will try to copy665 # the style sheet file to the HTML output directory, so don't put your own666 # stylesheet in the HTML output directory as well, or it will be erased!667 668 132 HTML_STYLESHEET = 669 670 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,671 # files or namespaces will be aligned in HTML using tables. If set to672 # NO a bullet list will be used.673 674 133 HTML_ALIGN_MEMBERS = YES 675 676 # If the GENERATE_HTMLHELP tag is set to YES, additional index files677 # will be generated that can be used as input for tools like the678 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)679 # of the generated HTML documentation.680 681 134 GENERATE_HTMLHELP = NO 682 683 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can684 # be used to specify the file name of the resulting .chm file. You685 # can add a path in front of the file if the result should not be686 # written to the html output directory.687 688 135 CHM_FILE = 689 690 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can691 # be used to specify the location (absolute path including file name) of692 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run693 # the HTML help compiler on the generated index.hhp.694 695 136 HHC_LOCATION = 696 697 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag698 # controls if a separate .chi index file is generated (YES) or that699 # it should be included in the master .chm file (NO).700 701 137 GENERATE_CHI = NO 702 703 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag704 # controls whether a binary table of contents is generated (YES) or a705 # normal table of contents (NO) in the .chm file.706 707 138 BINARY_TOC = NO 708 709 # The TOC_EXPAND flag can be set to YES to add extra items for group members710 # to the contents of the HTML help documentation and to the tree view.711 712 139 TOC_EXPAND = NO 713 714 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at715 # top of each HTML page. The value NO (the default) enables the index and716 # the value YES disables it.717 718 140 DISABLE_INDEX = NO 719 720 # This tag can be used to set the number of enum values (range [1..20])721 # that doxygen will group on one line in the generated HTML documentation.722 723 141 ENUM_VALUES_PER_LINE = 4 724 725 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be726 # generated containing a tree-like index structure (just like the one that727 # is generated for HTML Help). For this to work a browser that supports728 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,729 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are730 # probably better off using the HTML help feature.731 732 142 GENERATE_TREEVIEW = NO 733 734 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be735 # used to set the initial width (in pixels) of the frame in which the tree736 # is shown.737 738 143 TREEVIEW_WIDTH = 250 739 144 … … 742 147 #--------------------------------------------------------------------------- 743 148 744 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will745 # generate Latex output.746 747 149 GENERATE_LATEX = YES 748 749 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.750 # If a relative path is entered the value of OUTPUT_DIRECTORY will be751 # put in front of it. If left blank `latex' will be used as the default path.752 753 150 LATEX_OUTPUT = latex 754 755 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be756 # invoked. If left blank `latex' will be used as the default command name.757 758 151 LATEX_CMD_NAME = latex 759 760 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to761 # generate index for LaTeX. If left blank `makeindex' will be used as the762 # default command name.763 764 152 MAKEINDEX_CMD_NAME = makeindex 765 766 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact767 # LaTeX documents. This may be useful for small projects and may help to768 # save some trees in general.769 770 153 COMPACT_LATEX = NO 771 772 # The PAPER_TYPE tag can be used to set the paper type that is used773 # by the printer. Possible values are: a4, a4wide, letter, legal and774 # executive. If left blank a4wide will be used.775 776 154 PAPER_TYPE = a4wide 777 778 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX779 # packages that should be included in the LaTeX output.780 781 155 EXTRA_PACKAGES = 782 783 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for784 # the generated latex document. The header should contain everything until785 # the first chapter. If it is left blank doxygen will generate a786 # standard header. Notice: only use this tag if you know what you are doing!787 788 156 LATEX_HEADER = 789 790 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated791 # is prepared for conversion to pdf (using ps2pdf). The pdf file will792 # contain links (just like the HTML output) instead of page references793 # This makes the output suitable for online browsing using a pdf viewer.794 795 157 PDF_HYPERLINKS = YES 796 797 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of798 # plain latex in the generated Makefile. Set this option to YES to get a799 # higher quality PDF documentation.800 801 158 USE_PDFLATEX = YES 802 803 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.804 # command to the generated LaTeX files. This will instruct LaTeX to keep805 # running if errors occur, instead of asking the user for help.806 # This option is also used when generating formulas in HTML.807 808 159 LATEX_BATCHMODE = NO 809 810 # If LATEX_HIDE_INDICES is set to YES then doxygen will not811 # include the index chapters (such as File Index, Compound Index, etc.)812 # in the output.813 814 160 LATEX_HIDE_INDICES = NO 815 161 … … 818 164 #--------------------------------------------------------------------------- 819 165 820 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output821 # The RTF output is optimized for Word 97 and may not look very pretty with822 # other RTF readers or editors.823 824 166 GENERATE_RTF = NO 825 826 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.827 # If a relative path is entered the value of OUTPUT_DIRECTORY will be828 # put in front of it. If left blank `rtf' will be used as the default path.829 830 167 RTF_OUTPUT = rtf 831 832 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact833 # RTF documents. This may be useful for small projects and may help to834 # save some trees in general.835 836 168 COMPACT_RTF = NO 837 838 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated839 # will contain hyperlink fields. The RTF file will840 # contain links (just like the HTML output) instead of page references.841 # This makes the output suitable for online browsing using WORD or other842 # programs which support those fields.843 # Note: wordpad (write) and others do not support links.844 845 169 RTF_HYPERLINKS = NO 846 847 # Load stylesheet definitions from file. Syntax is similar to doxygen's848 # config file, i.e. a series of assignments. You only have to provide849 # replacements, missing definitions are set to their default value.850 851 170 RTF_STYLESHEET_FILE = 852 853 # Set optional variables used in the generation of an rtf document.854 # Syntax is similar to doxygen's config file.855 856 171 RTF_EXTENSIONS_FILE = 857 172 … … 860 175 #--------------------------------------------------------------------------- 861 176 862 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will863 # generate man pages864 865 177 GENERATE_MAN = NO 866 867 # The MAN_OUTPUT tag is used to specify where the man pages will be put.868 # If a relative path is entered the value of OUTPUT_DIRECTORY will be869 # put in front of it. If left blank `man' will be used as the default path.870 871 178 MAN_OUTPUT = man 872 873 # The MAN_EXTENSION tag determines the extension that is added to874 # the generated man pages (default is the subroutine's section .3)875 876 179 MAN_EXTENSION = .3 877 878 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,879 # then it will generate one additional man file for each entity880 # documented in the real man page(s). These additional files881 # only source the real man page, but without them the man command882 # would be unable to find the correct page. The default is NO.883 884 180 MAN_LINKS = NO 885 181 … … 888 184 #--------------------------------------------------------------------------- 889 185 890 # If the GENERATE_XML tag is set to YES Doxygen will891 # generate an XML file that captures the structure of892 # the code including all documentation.893 894 186 GENERATE_XML = NO 895 896 # The XML_OUTPUT tag is used to specify where the XML pages will be put.897 # If a relative path is entered the value of OUTPUT_DIRECTORY will be898 # put in front of it. If left blank `xml' will be used as the default path.899 900 187 XML_OUTPUT = xml 901 902 # The XML_SCHEMA tag can be used to specify an XML schema,903 # which can be used by a validating XML parser to check the904 # syntax of the XML files.905 906 188 XML_SCHEMA = 907 908 # The XML_DTD tag can be used to specify an XML DTD,909 # which can be used by a validating XML parser to check the910 # syntax of the XML files.911 912 189 XML_DTD = 913 914 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will915 # dump the program listings (including syntax highlighting916 # and cross-referencing information) to the XML output. Note that917 # enabling this will significantly increase the size of the XML output.918 919 190 XML_PROGRAMLISTING = YES 920 191 … … 923 194 #--------------------------------------------------------------------------- 924 195 925 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will926 # generate an AutoGen Definitions (see autogen.sf.net) file927 # that captures the structure of the code including all928 # documentation. Note that this feature is still experimental929 # and incomplete at the moment.930 931 196 GENERATE_AUTOGEN_DEF = NO 932 197 … … 935 200 #--------------------------------------------------------------------------- 936 201 937 # If the GENERATE_PERLMOD tag is set to YES Doxygen will938 # generate a Perl module file that captures the structure of939 # the code including all documentation. Note that this940 # feature is still experimental and incomplete at the941 # moment.942 943 202 GENERATE_PERLMOD = NO 944 945 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate946 # the necessary Makefile rules, Perl scripts and LaTeX code to be able947 # to generate PDF and DVI output from the Perl module output.948 949 203 PERLMOD_LATEX = NO 950 951 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be952 # nicely formatted so it can be parsed by a human reader. This is useful953 # if you want to understand what is going on. On the other hand, if this954 # tag is set to NO the size of the Perl module output will be much smaller955 # and Perl will parse it just the same.956 957 204 PERLMOD_PRETTY = YES 958 959 # The names of the make variables in the generated doxyrules.make file960 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.961 # This is useful so different doxyrules.make files included by the same962 # Makefile don't overwrite each other's variables.963 964 205 PERLMOD_MAKEVAR_PREFIX = 965 206 … … 968 209 #--------------------------------------------------------------------------- 969 210 970 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will971 # evaluate all C-preprocessor directives found in the sources and include972 # files.973 974 211 ENABLE_PREPROCESSING = YES 975 976 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro977 # names in the source code. If set to NO (the default) only conditional978 # compilation will be performed. Macro expansion can be done in a controlled979 # way by setting EXPAND_ONLY_PREDEF to YES.980 981 212 MACRO_EXPANSION = NO 982 983 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES984 # then the macro expansion is limited to the macros specified with the985 # PREDEFINED and EXPAND_AS_DEFINED tags.986 987 213 EXPAND_ONLY_PREDEF = NO 988 989 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files990 # in the INCLUDE_PATH (see below) will be search if a #include is found.991 992 214 SEARCH_INCLUDES = YES 993 994 # The INCLUDE_PATH tag can be used to specify one or more directories that995 # contain include files that are not input files but should be processed by996 # the preprocessor.997 998 215 INCLUDE_PATH = 999 1000 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard1001 # patterns (like *.h and *.hpp) to filter out the header-files in the1002 # directories. If left blank, the patterns specified with FILE_PATTERNS will1003 # be used.1004 1005 216 INCLUDE_FILE_PATTERNS = 1006 1007 # The PREDEFINED tag can be used to specify one or more macro names that1008 # are defined before the preprocessor is started (similar to the -D option of1009 # gcc). The argument of the tag is a list of macros of the form: name1010 # or name=definition (no spaces). If the definition and the = are1011 # omitted =1 is assumed. To prevent a macro definition from being1012 # undefined via #undef or recursively expanded use the := operator1013 # instead of the = operator.1014 1015 217 PREDEFINED = 1016 1017 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then1018 # this tag can be used to specify a list of macro names that should be expanded.1019 # The macro definition that is found in the sources will be used.1020 # Use the PREDEFINED tag if you want to use a different macro definition.1021 1022 218 EXPAND_AS_DEFINED = 1023 1024 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then1025 # doxygen's preprocessor will remove all function-like macros that are alone1026 # on a line, have an all uppercase name, and do not end with a semicolon. Such1027 # function macros are typically used for boiler-plate code, and will confuse1028 # the parser if not removed.1029 1030 219 SKIP_FUNCTION_MACROS = YES 1031 220 … … 1034 223 #--------------------------------------------------------------------------- 1035 224 1036 # The TAGFILES option can be used to specify one or more tagfiles.1037 # Optionally an initial location of the external documentation1038 # can be added for each tagfile. The format of a tag file without1039 # this location is as follows:1040 # TAGFILES = file1 file2 ...1041 # Adding location for the tag files is done as follows:1042 # TAGFILES = file1=loc1 "file2 = loc2" ...1043 # where "loc1" and "loc2" can be relative or absolute paths or1044 # URLs. If a location is present for each tag, the installdox tool1045 # does not have to be run to correct the links.1046 # Note that each tag file must have a unique name1047 # (where the name does NOT include the path)1048 # If a tag file is not located in the directory in which doxygen1049 # is run, you must also specify the path to the tagfile here.1050 1051 225 TAGFILES = 1052 1053 # When a file name is specified after GENERATE_TAGFILE, doxygen will create1054 # a tag file that is based on the input files it reads.1055 1056 226 GENERATE_TAGFILE = 1057 1058 # If the ALLEXTERNALS tag is set to YES all external classes will be listed1059 # in the class index. If set to NO only the inherited external classes1060 # will be listed.1061 1062 227 ALLEXTERNALS = NO 1063 1064 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed1065 # in the modules index. If set to NO, only the current project's groups will1066 # be listed.1067 1068 228 EXTERNAL_GROUPS = YES 1069 1070 # The PERL_PATH should be the absolute path and name of the perl script1071 # interpreter (i.e. the result of `which perl').1072 1073 229 PERL_PATH = /usr/bin/perl 1074 230 … … 1077 233 #--------------------------------------------------------------------------- 1078 234 1079 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will1080 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base1081 # or super classes. Setting the tag to NO turns the diagrams off. Note that1082 # this option is superseded by the HAVE_DOT option below. This is only a1083 # fallback. It is recommended to install and use dot, since it yields more1084 # powerful graphs.1085 1086 235 CLASS_DIAGRAMS = YES 1087 1088 # If set to YES, the inheritance and collaboration graphs will hide1089 # inheritance and usage relations if the target is undocumented1090 # or is not a class.1091 1092 236 HIDE_UNDOC_RELATIONS = YES 1093 1094 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is1095 # available from the path. This tool is part of Graphviz, a graph visualization1096 # toolkit from AT&T and Lucent Bell Labs. The other options in this section1097 # have no effect if this option is set to NO (the default)1098 1099 237 HAVE_DOT = YES 1100 1101 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen1102 # will generate a graph for each documented class showing the direct and1103 # indirect inheritance relations. Setting this tag to YES will force the1104 # the CLASS_DIAGRAMS tag to NO.1105 1106 238 CLASS_GRAPH = YES 1107 1108 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen1109 # will generate a graph for each documented class showing the direct and1110 # indirect implementation dependencies (inheritance, containment, and1111 # class references variables) of the class with other documented classes.1112 1113 239 COLLABORATION_GRAPH = YES 1114 1115 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen1116 # will generate a graph for groups, showing the direct groups dependencies1117 1118 240 GROUP_GRAPHS = YES 1119 1120 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and1121 # collaboration diagrams in a style similar to the OMG's Unified Modeling1122 # Language.1123 1124 241 UML_LOOK = YES 1125 1126 # If set to YES, the inheritance and collaboration graphs will show the1127 # relations between templates and their instances.1128 1129 242 TEMPLATE_RELATIONS = YES 1130 1131 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT1132 # tags are set to YES then doxygen will generate a graph for each documented1133 # file showing the direct and indirect include dependencies of the file with1134 # other documented files.1135 1136 243 INCLUDE_GRAPH = YES 1137 1138 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and1139 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each1140 # documented header file showing the documented files that directly or1141 # indirectly include this file.1142 1143 244 INCLUDED_BY_GRAPH = YES 1144 1145 # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will1146 # generate a call dependency graph for every global function or class method.1147 # Note that enabling this option will significantly increase the time of a run.1148 # So in most cases it will be better to enable call graphs for selected1149 # functions only using the \callgraph command.1150 1151 245 CALL_GRAPH = YES 1152 1153 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then doxygen will1154 # generate a caller dependency graph for every global function or class method.1155 # Note that enabling this option will significantly increase the time of a run.1156 # So in most cases it will be better to enable caller graphs for selected1157 # functions only using the \callergraph command.1158 1159 246 CALLER_GRAPH = YES 1160 1161 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen1162 # will graphical hierarchy of all classes instead of a textual one.1163 1164 247 GRAPHICAL_HIERARCHY = YES 1165 1166 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES1167 # then doxygen will show the dependencies a directory has on other directories1168 # in a graphical way. The dependency relations are determined by the #include1169 # relations between the files in the directories.1170 1171 248 DIRECTORY_GRAPH = YES 1172 1173 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images1174 # generated by dot. Possible values are png, jpg, or gif1175 # If left blank png will be used.1176 1177 249 DOT_IMAGE_FORMAT = png 1178 1179 # The tag DOT_PATH can be used to specify the path where the dot tool can be1180 # found. If left blank, it is assumed the dot tool can be found in the path.1181 1182 250 DOT_PATH = 1183 1184 # The DOTFILE_DIRS tag can be used to specify one or more directories that1185 # contain dot files that are included in the documentation (see the1186 # \dotfile command).1187 1188 251 DOTFILE_DIRS = 1189 1190 # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width1191 # (in pixels) of the graphs generated by dot. If a graph becomes larger than1192 # this value, doxygen will try to truncate the graph, so that it fits within1193 # the specified constraint. Beware that most browsers cannot cope with very1194 # large images.1195 1196 252 MAX_DOT_GRAPH_WIDTH = 1024 1197 1198 # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height1199 # (in pixels) of the graphs generated by dot. If a graph becomes larger than1200 # this value, doxygen will try to truncate the graph, so that it fits within1201 # the specified constraint. Beware that most browsers cannot cope with very1202 # large images.1203 1204 253 MAX_DOT_GRAPH_HEIGHT = 1024 1205 1206 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the1207 # graphs generated by dot. A depth value of 3 means that only nodes reachable1208 # from the root by following a path via at most 3 edges will be shown. Nodes1209 # that lay further from the root node will be omitted. Note that setting this1210 # option to 1 or 2 may greatly reduce the computation time needed for large1211 # code bases. Also note that a graph may be further truncated if the graph's1212 # image dimensions are not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH1213 # and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the depth value (the default),1214 # the graph is not depth-constrained.1215 1216 254 MAX_DOT_GRAPH_DEPTH = 0 1217 1218 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent1219 # background. This is disabled by default, which results in a white background.1220 # Warning: Depending on the platform used, enabling this option may lead to1221 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to1222 # read).1223 1224 255 DOT_TRANSPARENT = NO 1225 1226 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output1227 # files in one run (i.e. multiple -o and -T options on the command line). This1228 # makes dot run faster, but since only newer versions of dot (>1.8.10)1229 # support this, this feature is disabled by default.1230 1231 256 DOT_MULTI_TARGETS = YES 1232 1233 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will1234 # generate a legend page explaining the meaning of the various boxes and1235 # arrows in the dot generated graphs.1236 1237 257 GENERATE_LEGEND = YES 1238 1239 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will1240 # remove the intermediate dot files that are used to generate1241 # the various graphs.1242 1243 258 DOT_CLEANUP = YES 1244 259 … … 1247 262 #--------------------------------------------------------------------------- 1248 263 1249 # The SEARCHENGINE tag specifies whether or not a search engine should be1250 # used. If set to NO the values of all tags below this one will be ignored.1251 1252 264 SEARCHENGINE = NO
