libisofs: doc/doxygen.conf.in

"Fossies" - the Fresh Open Source Software Archive

Member "libisofs-1.5.4/doc/doxygen.conf.in" (8 Jul 2020, 53222 Bytes) of package /linux/misc/libisofs-1.5.4.tar.gz:

As a special service "Fossies" has tried to format the requested text file into HTML format (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file. See also the last Fossies "Diffs" side-by-side code changes report for "doxygen.conf.in":

1.4.4_vs_1.4.6.

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