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