1 # Doxyfile 1.8.15
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 double hash (##) is considered a comment and is placed in
7 # front of the TAG it is preceding.
8 #
9 # All text after a single hash (#) is considered a comment and will be ignored.
10 # The format is:
11 # TAG = value [value, ...]
12 # For lists, items can also be appended using:
13 # TAG += value [value, ...]
14 # Values that contain spaces should be placed between quotes (\" \").
16 #---------------------------------------------------------------------------
17 # Project related configuration options
18 #---------------------------------------------------------------------------
20 # This tag specifies the encoding used for all characters in the configuration
21 # file that follow. The default is UTF-8 which is also the encoding used for all
22 # text before the first occurrence of this tag. Doxygen uses libiconv (or the
23 # iconv built into libc) for the transcoding. See
24 # https://www.gnu.org/software/libiconv/ for the list of possible encodings.
25 # The default value is: UTF-8.
27 DOXYFILE_ENCODING = UTF-8
29 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
30 # double-quotes, unless you are using Doxywizard) that should identify the
31 # project for which the documentation is generated. This name is used in the
32 # title of most generated pages and in a few other places.
33 # The default value is: My Project.
35 PROJECT_NAME = "ReactOS"
37 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
38 # could be handy for archiving the generated documentation or if some version
39 # control system is used.
41 # Automatically added by the script
42 #PROJECT_NUMBER =
44 # Using the PROJECT_BRIEF tag one can provide an optional one line description
45 # for a project that appears at the top of each page and should give viewer a
46 # quick idea about the purpose of the project. Keep the description short.
48 PROJECT_BRIEF =
50 # With the PROJECT_LOGO tag one can specify a logo or an icon that is included
51 # in the documentation. The maximum height of the logo should not exceed 55
52 # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
53 # the logo to the output directory.
55 PROJECT_LOGO =
57 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
58 # into which the generated documentation will be written. If a relative path is
59 # entered, it will be relative to the location where doxygen was started. If
60 # left blank the current directory will be used.
62 OUTPUT_DIRECTORY = "Doxygen"
64 # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
65 # directories (in 2 levels) under the output directory of each output format and
66 # will distribute the generated files over these directories. Enabling this
67 # option can be useful when feeding doxygen a huge amount of source files, where
68 # putting all generated files in the same directory would otherwise causes
69 # performance problems for the file system.
70 # The default value is: NO.
72 CREATE_SUBDIRS = YES
74 # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
75 # characters to appear in the names of generated files. If set to NO, non-ASCII
76 # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
77 # U+3044.
78 # The default value is: NO.
80 ALLOW_UNICODE_NAMES = NO
82 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
83 # documentation generated by doxygen is written. Doxygen will use this
84 # information to generate all constant output in the proper language.
85 # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
86 # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
87 # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
88 # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
89 # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
90 # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
91 # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
92 # Ukrainian and Vietnamese.
93 # The default value is: English.
95 OUTPUT_LANGUAGE = English
97 # The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all
98 # documentation generated by doxygen is written. Doxygen will use this
99 # information to generate all generated output in the proper direction.
100 # Possible values are: None, LTR, RTL and Context.
101 # The default value is: None.
103 OUTPUT_TEXT_DIRECTION = None
105 # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
106 # descriptions after the members that are listed in the file and class
107 # documentation (similar to Javadoc). Set to NO to disable this.
108 # The default value is: YES.
110 BRIEF_MEMBER_DESC = YES
112 # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
113 # description of a member or function before the detailed description
114 #
115 # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
116 # brief descriptions will be completely suppressed.
117 # The default value is: YES.
119 REPEAT_BRIEF = YES
121 # This tag implements a quasi-intelligent brief description abbreviator that is
122 # used to form the text in various listings. Each string in this list, if found
123 # as the leading text of the brief description, will be stripped from the text
124 # and the result, after processing the whole list, is used as the annotated
125 # text. Otherwise, the brief description is used as-is. If left blank, the
126 # following values are used ($name is automatically replaced with the name of 127 # the entity):The$name class, The $name widget, The$name file, is, provides,
128 # specifies, contains, represents, a, an and the.
130 ABBREVIATE_BRIEF = "The $name class" \ 131 "The$name widget" \
132 "The $name file" \ 133 is \ 134 provides \ 135 specifies \ 136 contains \ 137 represents \ 138 a \ 139 an \ 140 the 142 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 143 # doxygen will generate a detailed section even if there is only a brief 144 # description. 145 # The default value is: NO. 147 ALWAYS_DETAILED_SEC = NO 149 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 150 # inherited members of a class in the documentation of that class as if those 151 # members were ordinary class members. Constructors, destructors and assignment 152 # operators of the base classes will not be shown. 153 # The default value is: NO. 155 INLINE_INHERITED_MEMB = NO 157 # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path 158 # before files name in the file list and in the header files. If set to NO the 159 # shortest path that makes the file name unique will be used 160 # The default value is: YES. 162 FULL_PATH_NAMES = YES 164 # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. 165 # Stripping is only done if one of the specified strings matches the left-hand 166 # part of the path. The tag can be used to show relative paths in the file list. 167 # If left blank the directory from which doxygen is run is used as the path to 168 # strip. 169 # 170 # Note that you can specify absolute paths here, but also relative paths, which 171 # will be relative from the directory where doxygen is started. 172 # This tag requires that the tag FULL_PATH_NAMES is set to YES. 174 STRIP_FROM_PATH = 176 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the 177 # path mentioned in the documentation of a class, which tells the reader which 178 # header file to include in order to use a class. If left blank only the name of 179 # the header file containing the class definition is used. Otherwise one should 180 # specify the list of include paths that are normally passed to the compiler 181 # using the -I flag. 183 STRIP_FROM_INC_PATH = 185 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but 186 # less readable) file names. This can be useful is your file systems doesn't 187 # support long names like on DOS, Mac, or CD-ROM. 188 # The default value is: NO. 190 SHORT_NAMES = NO 192 # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the 193 # first line (until the first dot) of a Javadoc-style comment as the brief 194 # description. If set to NO, the Javadoc-style will behave just like regular Qt- 195 # style comments (thus requiring an explicit @brief command for a brief 196 # description.) 197 # The default value is: NO. 199 JAVADOC_AUTOBRIEF = NO 201 # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first 202 # line (until the first dot) of a Qt-style comment as the brief description. If 203 # set to NO, the Qt-style will behave just like regular Qt-style comments (thus 204 # requiring an explicit \brief command for a brief description.) 205 # The default value is: NO. 207 QT_AUTOBRIEF = NO 209 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a 210 # multi-line C++ special comment block (i.e. a block of //! or /// comments) as 211 # a brief description. This used to be the default behavior. The new default is 212 # to treat a multi-line C++ comment block as a detailed description. Set this 213 # tag to YES if you prefer the old behavior instead. 214 # 215 # Note that setting this tag to YES also means that rational rose comments are 216 # not recognized any more. 217 # The default value is: NO. 219 MULTILINE_CPP_IS_BRIEF = NO 221 # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the 222 # documentation from any documented member that it re-implements. 223 # The default value is: YES. 225 INHERIT_DOCS = YES 227 # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new 228 # page for each member. If set to NO, the documentation of a member will be part 229 # of the file/class/namespace that contains it. 230 # The default value is: NO. 232 SEPARATE_MEMBER_PAGES = NO 234 # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen 235 # uses this value to replace tabs by spaces in code fragments. 236 # Minimum value: 1, maximum value: 16, default value: 4. 238 TAB_SIZE = 4 240 # This tag can be used to specify a number of aliases that act as commands in 241 # the documentation. An alias has the form: 242 # name=value 243 # For example adding 244 # "sideeffect=@par Side Effects:\n" 245 # will allow you to put the command \sideeffect (or @sideeffect) in the 246 # documentation, which will result in a user-defined paragraph with heading 247 # "Side Effects:". You can put \n's in the value part of an alias to insert 248 # newlines (in the resulting output). You can put ^^ in the value part of an 249 # alias to insert a newline as if a physical newline was in the original file. 250 # When you need a literal { or } or , in the value part of an alias you have to 251 # escape them by means of a backslash (\), this can lead to conflicts with the 252 # commands \{ and \} for these it is advised to use the version @{ and @} or use 253 # a double escape (\\{ and \\}) 255 ALIASES = 257 # This tag can be used to specify a number of word-keyword mappings (TCL only). 258 # A mapping has the form "name=value". For example adding "class=itcl::class" 259 # will allow you to use the command class in the itcl::class meaning. 261 TCL_SUBST = 263 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources 264 # only. Doxygen will then generate output that is more tailored for C. For 265 # instance, some of the names that are used will be different. The list of all 266 # members will be omitted, etc. 267 # The default value is: NO. 269 OPTIMIZE_OUTPUT_FOR_C = NO 271 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or 272 # Python sources only. Doxygen will then generate output that is more tailored 273 # for that language. For instance, namespaces will be presented as packages, 274 # qualified scopes will look different, etc. 275 # The default value is: NO. 277 OPTIMIZE_OUTPUT_JAVA = NO 279 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 280 # sources. Doxygen will then generate output that is tailored for Fortran. 281 # The default value is: NO. 283 OPTIMIZE_FOR_FORTRAN = NO 285 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 286 # sources. Doxygen will then generate output that is tailored for VHDL. 287 # The default value is: NO. 289 OPTIMIZE_OUTPUT_VHDL = NO 291 # Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice 292 # sources only. Doxygen will then generate output that is more tailored for that 293 # language. For instance, namespaces will be presented as modules, types will be 294 # separated into more groups, etc. 295 # The default value is: NO. 297 OPTIMIZE_OUTPUT_SLICE = NO 299 # Doxygen selects the parser to use depending on the extension of the files it 300 # parses. With this tag you can assign which parser to use for a given 301 # extension. Doxygen has a built-in mapping, but you can override or extend it 302 # using this tag. The format is ext=language, where ext is a file extension, and 303 # language is one of the parsers supported by doxygen: IDL, Java, Javascript, 304 # Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice, 305 # Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: 306 # FortranFree, unknown formatted Fortran: Fortran. In the later case the parser 307 # tries to guess whether the code is fixed or free formatted code, this is the 308 # default for Fortran type files), VHDL, tcl. For instance to make doxygen treat 309 # .inc files as Fortran files (default is PHP), and .f files as C (default is 310 # Fortran), use: inc=Fortran f=C. 311 # 312 # Note: For files without extension you can use no_extension as a placeholder. 313 # 314 # Note that for custom extensions you also need to set FILE_PATTERNS otherwise 315 # the files are not read by doxygen. 317 EXTENSION_MAPPING = 319 # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments 320 # according to the Markdown format, which allows for more readable 321 # documentation. See https://daringfireball.net/projects/markdown/ for details. 322 # The output of markdown processing is further processed by doxygen, so you can 323 # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in 324 # case of backward compatibilities issues. 325 # The default value is: YES. 327 MARKDOWN_SUPPORT = YES 329 # When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up 330 # to that level are automatically included in the table of contents, even if 331 # they do not have an id attribute. 332 # Note: This feature currently applies only to Markdown headings. 333 # Minimum value: 0, maximum value: 99, default value: 0. 334 # This tag requires that the tag MARKDOWN_SUPPORT is set to YES. 336 TOC_INCLUDE_HEADINGS = 0 338 # When enabled doxygen tries to link words that correspond to documented 339 # classes, or namespaces to their corresponding documentation. Such a link can 340 # be prevented in individual cases by putting a % sign in front of the word or 341 # globally by setting AUTOLINK_SUPPORT to NO. 342 # The default value is: YES. 344 AUTOLINK_SUPPORT = YES 346 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 347 # to include (a tag file for) the STL sources as input, then you should set this 348 # tag to YES in order to let doxygen match functions declarations and 349 # definitions whose arguments contain STL classes (e.g. func(std::string); 350 # versus func(std::string) {}). This also make the inheritance and collaboration 351 # diagrams that involve STL classes more complete and accurate. 352 # The default value is: NO. 354 BUILTIN_STL_SUPPORT = NO 356 # If you use Microsoft's C++/CLI language, you should set this option to YES to 357 # enable parsing support. 358 # The default value is: NO. 360 CPP_CLI_SUPPORT = NO 362 # Set the SIP_SUPPORT tag to YES if your project consists of sip (see: 363 # https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen 364 # will parse them like normal C++ but will assume all classes use public instead 365 # of private inheritance when no explicit protection keyword is present. 366 # The default value is: NO. 368 SIP_SUPPORT = NO 370 # For Microsoft's IDL there are propget and propput attributes to indicate 371 # getter and setter methods for a property. Setting this option to YES will make 372 # doxygen to replace the get and set methods by a property in the documentation. 373 # This will only work if the methods are indeed getting or setting a simple 374 # type. If this is not the case, or you want to show the methods anyway, you 375 # should set this option to NO. 376 # The default value is: YES. 378 IDL_PROPERTY_SUPPORT = YES 380 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 381 # tag is set to YES then doxygen will reuse the documentation of the first 382 # member in the group (if any) for the other members of the group. By default 383 # all members of a group must be documented explicitly. 384 # The default value is: NO. 386 DISTRIBUTE_GROUP_DOC = NO 388 # If one adds a struct or class to a group and this option is enabled, then also 389 # any nested class or struct is added to the same group. By default this option 390 # is disabled and one has to add nested compounds explicitly via \ingroup. 391 # The default value is: NO. 393 GROUP_NESTED_COMPOUNDS = NO 395 # Set the SUBGROUPING tag to YES to allow class member groups of the same type 396 # (for instance a group of public functions) to be put as a subgroup of that 397 # type (e.g. under the Public Functions section). Set it to NO to prevent 398 # subgrouping. Alternatively, this can be done per class using the 399 # \nosubgrouping command. 400 # The default value is: YES. 402 SUBGROUPING = YES 404 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions 405 # are shown inside the group in which they are included (e.g. using \ingroup) 406 # instead of on a separate page (for HTML and Man pages) or section (for LaTeX 407 # and RTF). 408 # 409 # Note that this feature does not work in combination with 410 # SEPARATE_MEMBER_PAGES. 411 # The default value is: NO. 413 INLINE_GROUPED_CLASSES = NO 415 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions 416 # with only public data fields or simple typedef fields will be shown inline in 417 # the documentation of the scope in which they are defined (i.e. file, 418 # namespace, or group documentation), provided this scope is documented. If set 419 # to NO, structs, classes, and unions are shown on a separate page (for HTML and 420 # Man pages) or section (for LaTeX and RTF). 421 # The default value is: NO. 423 INLINE_SIMPLE_STRUCTS = NO 425 # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or 426 # enum is documented as struct, union, or enum with the name of the typedef. So 427 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct 428 # with name TypeT. When disabled the typedef will appear as a member of a file, 429 # namespace, or class. And the struct will be named TypeS. This can typically be 430 # useful for C code in case the coding convention dictates that all compound 431 # types are typedef'ed and only the typedef is referenced, never the tag name. 432 # The default value is: NO. 434 TYPEDEF_HIDES_STRUCT = NO 436 # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This 437 # cache is used to resolve symbols given their name and scope. Since this can be 438 # an expensive process and often the same symbol appears multiple times in the 439 # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small 440 # doxygen will become slower. If the cache is too large, memory is wasted. The 441 # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range 442 # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 443 # symbols. At the end of a run doxygen will report the cache usage and suggest 444 # the optimal cache size from a speed point of view. 445 # Minimum value: 0, maximum value: 9, default value: 0. 447 LOOKUP_CACHE_SIZE = 0 449 #--------------------------------------------------------------------------- 450 # Build related configuration options 451 #--------------------------------------------------------------------------- 453 # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in 454 # documentation are documented, even if no documentation was available. Private 455 # class members and static file members will be hidden unless the 456 # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. 457 # Note: This will also disable the warnings about undocumented members that are 458 # normally produced when WARNINGS is set to YES. 459 # The default value is: NO. 461 EXTRACT_ALL = YES 463 # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will 464 # be included in the documentation. 465 # The default value is: NO. 467 EXTRACT_PRIVATE = YES 469 # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal 470 # scope will be included in the documentation. 471 # The default value is: NO. 473 EXTRACT_PACKAGE = YES 475 # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be 476 # included in the documentation. 477 # The default value is: NO. 479 EXTRACT_STATIC = YES 481 # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined 482 # locally in source files will be included in the documentation. If set to NO, 483 # only classes defined in header files are included. Does not have any effect 484 # for Java sources. 485 # The default value is: YES. 487 EXTRACT_LOCAL_CLASSES = YES 489 # This flag is only useful for Objective-C code. If set to YES, local methods, 490 # which are defined in the implementation section but not in the interface are 491 # included in the documentation. If set to NO, only methods in the interface are 492 # included. 493 # The default value is: NO. 495 EXTRACT_LOCAL_METHODS = NO 497 # If this flag is set to YES, the members of anonymous namespaces will be 498 # extracted and appear in the documentation as a namespace called 499 # 'anonymous_namespace{file}', where file will be replaced with the base name of 500 # the file that contains the anonymous namespace. By default anonymous namespace 501 # are hidden. 502 # The default value is: NO. 504 EXTRACT_ANON_NSPACES = YES 506 # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all 507 # undocumented members inside documented classes or files. If set to NO these 508 # members will be included in the various overviews, but no documentation 509 # section is generated. This option has no effect if EXTRACT_ALL is enabled. 510 # The default value is: NO. 512 HIDE_UNDOC_MEMBERS = NO 514 # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all 515 # undocumented classes that are normally visible in the class hierarchy. If set 516 # to NO, these classes will be included in the various overviews. This option 517 # has no effect if EXTRACT_ALL is enabled. 518 # The default value is: NO. 520 HIDE_UNDOC_CLASSES = NO 522 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend 523 # (class|struct|union) declarations. If set to NO, these declarations will be 524 # included in the documentation. 525 # The default value is: NO. 527 HIDE_FRIEND_COMPOUNDS = NO 529 # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any 530 # documentation blocks found inside the body of a function. If set to NO, these 531 # blocks will be appended to the function's detailed documentation block. 532 # The default value is: NO. 534 HIDE_IN_BODY_DOCS = NO 536 # The INTERNAL_DOCS tag determines if documentation that is typed after a 537 # \internal command is included. If the tag is set to NO then the documentation 538 # will be excluded. Set it to YES to include the internal documentation. 539 # The default value is: NO. 541 INTERNAL_DOCS = NO 543 # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file 544 # names in lower-case letters. If set to YES, upper-case letters are also 545 # allowed. This is useful if you have classes or files whose names only differ 546 # in case and if your file system supports case sensitive file names. Windows 547 # and Mac users are advised to set this option to NO. 548 # The default value is: system dependent. 550 CASE_SENSE_NAMES = YES 552 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with 553 # their full class and namespace scopes in the documentation. If set to YES, the 554 # scope will be hidden. 555 # The default value is: NO. 557 HIDE_SCOPE_NAMES = NO 559 # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will 560 # append additional text to a page's title, such as Class Reference. If set to 561 # YES the compound reference will be hidden. 562 # The default value is: NO. 564 HIDE_COMPOUND_REFERENCE= NO 566 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of 567 # the files that are included by a file in the documentation of that file. 568 # The default value is: YES. 570 SHOW_INCLUDE_FILES = YES 572 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each 573 # grouped member an include statement to the documentation, telling the reader 574 # which file to include in order to use the member. 575 # The default value is: NO. 577 SHOW_GROUPED_MEMB_INC = NO 579 # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include 580 # files with double quotes in the documentation rather than with sharp brackets. 581 # The default value is: NO. 583 FORCE_LOCAL_INCLUDES = NO 585 # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the 586 # documentation for inline members. 587 # The default value is: YES. 589 INLINE_INFO = YES 591 # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the 592 # (detailed) documentation of file and class members alphabetically by member 593 # name. If set to NO, the members will appear in declaration order. 594 # The default value is: YES. 596 SORT_MEMBER_DOCS = YES 598 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief 599 # descriptions of file, namespace and class members alphabetically by member 600 # name. If set to NO, the members will appear in declaration order. Note that 601 # this will also influence the order of the classes in the class list. 602 # The default value is: NO. 604 SORT_BRIEF_DOCS = NO 606 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the 607 # (brief and detailed) documentation of class members so that constructors and 608 # destructors are listed first. If set to NO the constructors will appear in the 609 # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. 610 # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief 611 # member documentation. 612 # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting 613 # detailed member documentation. 614 # The default value is: NO. 616 SORT_MEMBERS_CTORS_1ST = NO 618 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy 619 # of group names into alphabetical order. If set to NO the group names will 620 # appear in their defined order. 621 # The default value is: NO. 623 SORT_GROUP_NAMES = NO 625 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by 626 # fully-qualified names, including namespaces. If set to NO, the class list will 627 # be sorted only by class name, not including the namespace part. 628 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 629 # Note: This option applies only to the class list, not to the alphabetical 630 # list. 631 # The default value is: NO. 633 SORT_BY_SCOPE_NAME = NO 635 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper 636 # type resolution of all parameters of a function it will reject a match between 637 # the prototype and the implementation of a member function even if there is 638 # only one candidate or it is obvious which candidate to choose by doing a 639 # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still 640 # accept a match between prototype and implementation in such cases. 641 # The default value is: NO. 643 STRICT_PROTO_MATCHING = NO 645 # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo 646 # list. This list is created by putting \todo commands in the documentation. 647 # The default value is: YES. 649 GENERATE_TODOLIST = YES 651 # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test 652 # list. This list is created by putting \test commands in the documentation. 653 # The default value is: YES. 655 GENERATE_TESTLIST = YES 657 # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug 658 # list. This list is created by putting \bug commands in the documentation. 659 # The default value is: YES. 661 GENERATE_BUGLIST = YES 663 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) 664 # the deprecated list. This list is created by putting \deprecated commands in 665 # the documentation. 666 # The default value is: YES. 668 GENERATE_DEPRECATEDLIST= YES 670 # The ENABLED_SECTIONS tag can be used to enable conditional documentation 671 # sections, marked by \if <section_label> ... \endif and \cond <section_label> 672 # ... \endcond blocks. 674 ENABLED_SECTIONS = 676 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the 677 # initial value of a variable or macro / define can have for it to appear in the 678 # documentation. If the initializer consists of more lines than specified here 679 # it will be hidden. Use a value of 0 to hide initializers completely. The 680 # appearance of the value of individual variables and macros / defines can be 681 # controlled using \showinitializer or \hideinitializer command in the 682 # documentation regardless of this setting. 683 # Minimum value: 0, maximum value: 10000, default value: 30. 685 MAX_INITIALIZER_LINES = 30 687 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at 688 # the bottom of the documentation of classes and structs. If set to YES, the 689 # list will mention the files that were used to generate the documentation. 690 # The default value is: YES. 692 SHOW_USED_FILES = YES 694 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This 695 # will remove the Files entry from the Quick Index and from the Folder Tree View 696 # (if specified). 697 # The default value is: YES. 699 SHOW_FILES = YES 701 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces 702 # page. This will remove the Namespaces entry from the Quick Index and from the 703 # Folder Tree View (if specified). 704 # The default value is: YES. 706 SHOW_NAMESPACES = YES 708 # The FILE_VERSION_FILTER tag can be used to specify a program or script that 709 # doxygen should invoke to get the current version for each file (typically from 710 # the version control system). Doxygen will invoke the program by executing (via 711 # popen()) the command command input-file, where command is the value of the 712 # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided 713 # by doxygen. Whatever the program writes to standard output is used as the file 714 # version. For an example see the documentation. 716 FILE_VERSION_FILTER = 718 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed 719 # by doxygen. The layout file controls the global structure of the generated 720 # output files in an output format independent way. To create the layout file 721 # that represents doxygen's defaults, run doxygen with the -l option. You can 722 # optionally specify a file name after the option, if omitted DoxygenLayout.xml 723 # will be used as the name of the layout file. 724 # 725 # Note that if you run doxygen from a directory containing a file called 726 # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE 727 # tag is left empty. 729 LAYOUT_FILE = 731 # The CITE_BIB_FILES tag can be used to specify one or more bib files containing 732 # the reference definitions. This must be a list of .bib files. The .bib 733 # extension is automatically appended if omitted. This requires the bibtex tool 734 # to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. 735 # For LaTeX the style of the bibliography can be controlled using 736 # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the 737 # search path. See also \cite for info how to create references. 739 CITE_BIB_FILES = 741 #--------------------------------------------------------------------------- 742 # Configuration options related to warning and progress messages 743 #--------------------------------------------------------------------------- 745 # The QUIET tag can be used to turn on/off the messages that are generated to 746 # standard output by doxygen. If QUIET is set to YES this implies that the 747 # messages are off. 748 # The default value is: NO. 750 QUIET = NO 752 # The WARNINGS tag can be used to turn on/off the warning messages that are 753 # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES 754 # this implies that the warnings are on. 755 # 756 # Tip: Turn warnings on while writing the documentation. 757 # The default value is: YES. 759 WARNINGS = YES 761 # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate 762 # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag 763 # will automatically be disabled. 764 # The default value is: YES. 766 WARN_IF_UNDOCUMENTED = YES 768 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for 769 # potential errors in the documentation, such as not documenting some parameters 770 # in a documented function, or documenting parameters that don't exist or using 771 # markup commands wrongly. 772 # The default value is: YES. 774 WARN_IF_DOC_ERROR = YES 776 # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that 777 # are documented, but have no documentation for their parameters or return 778 # value. If set to NO, doxygen will only warn about wrong or incomplete 779 # parameter documentation, but not about the absence of documentation. If 780 # EXTRACT_ALL is set to YES then this flag will automatically be disabled. 781 # The default value is: NO. 783 WARN_NO_PARAMDOC = NO 785 # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when 786 # a warning is encountered. 787 # The default value is: NO. 789 WARN_AS_ERROR = NO 791 # The WARN_FORMAT tag determines the format of the warning messages that doxygen 792 # can produce. The string should contain the$file, $line, and$text tags, which
793 # will be replaced by the file and line number from which the warning originated
794 # and the warning text. Optionally the format may contain $version, which will 795 # be replaced by the version of the file (if it could be obtained via 796 # FILE_VERSION_FILTER) 797 # The default value is:$file:$line:$text.
799 WARN_FORMAT = "$file:$line: $text" 801 # The WARN_LOGFILE tag can be used to specify a file to which warning and error 802 # messages should be written. If left blank the output is written to standard 803 # error (stderr). 805 WARN_LOGFILE = 807 #--------------------------------------------------------------------------- 808 # Configuration options related to the input files 809 #--------------------------------------------------------------------------- 811 # The INPUT tag is used to specify the files and/or directories that contain 812 # documented source files. You may enter file names like myfile.cpp or 813 # directories like /usr/src/myproject. Separate the files or directories with 814 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING 815 # Note: If this tag is empty the current directory is searched. 817 INPUT = 819 # This tag can be used to specify the character encoding of the source files 820 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses 821 # libiconv (or the iconv built into libc) for the transcoding. See the libiconv 822 # documentation (see: https://www.gnu.org/software/libiconv/) for the list of 823 # possible encodings. 824 # The default value is: UTF-8. 826 INPUT_ENCODING = UTF-8 828 # If the value of the INPUT tag contains directories, you can use the 829 # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and 830 # *.h) to filter out the source-files in the directories. 831 # 832 # Note that for custom extensions or not directly supported extensions you also 833 # need to set EXTENSION_MAPPING for the extension otherwise the files are not 834 # read by doxygen. 835 # 836 # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, 837 # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, 838 # *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, 839 # *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, 840 # *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, *.qsf and *.ice. 842 FILE_PATTERNS = *.c *.cc *.cxx *.cpp *.h *.hh *.hxx *.hpp *.idl 844 # The RECURSIVE tag can be used to specify whether or not subdirectories should 845 # be searched for input files as well. 846 # The default value is: NO. 848 RECURSIVE = YES 850 # The EXCLUDE tag can be used to specify files and/or directories that should be 851 # excluded from the INPUT source files. This way you can easily exclude a 852 # subdirectory from a directory tree whose root is specified with the INPUT tag. 853 # 854 # Note that relative paths are relative to the directory from which doxygen is 855 # run. 857 EXCLUDE = 859 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or 860 # directories that are symbolic links (a Unix file system feature) are excluded 861 # from the input. 862 # The default value is: NO. 864 EXCLUDE_SYMLINKS = NO 866 # If the value of the INPUT tag contains directories, you can use the 867 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 868 # certain files from those directories. 869 # 870 # Note that the wildcards are matched against the file with absolute path, so to 871 # exclude all test directories for example use the pattern */test/* 873 EXCLUDE_PATTERNS = */.git/* 875 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 876 # (namespaces, classes, functions, etc.) that should be excluded from the 877 # output. The symbol name can be a fully qualified name, a word, or if the 878 # wildcard * is used, a substring. Examples: ANamespace, AClass, 879 # AClass::ANamespace, ANamespace::*Test 880 # 881 # Note that the wildcards are matched against the file with absolute path, so to 882 # exclude all test directories use the pattern */test/* 884 EXCLUDE_SYMBOLS = 886 # The EXAMPLE_PATH tag can be used to specify one or more files or directories 887 # that contain example code fragments that are included (see the \include 888 # command). 890 EXAMPLE_PATH = 892 # If the value of the EXAMPLE_PATH tag contains directories, you can use the 893 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and 894 # *.h) to filter out the source-files in the directories. If left blank all 895 # files are included. 897 EXAMPLE_PATTERNS = * 899 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 900 # searched for input files to be used with the \include or \dontinclude commands 901 # irrespective of the value of the RECURSIVE tag. 902 # The default value is: NO. 904 EXAMPLE_RECURSIVE = NO 906 # The IMAGE_PATH tag can be used to specify one or more files or directories 907 # that contain images that are to be included in the documentation (see the 908 # \image command). 910 IMAGE_PATH = 912 # The INPUT_FILTER tag can be used to specify a program that doxygen should 913 # invoke to filter for each input file. Doxygen will invoke the filter program 914 # by executing (via popen()) the command: 915 # 916 # <filter> <input-file> 917 # 918 # where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the 919 # name of an input file. Doxygen will then use the output that the filter 920 # program writes to standard output. If FILTER_PATTERNS is specified, this tag 921 # will be ignored. 922 # 923 # Note that the filter must not add or remove lines; it is applied before the 924 # code is scanned, but not when the output code is generated. If lines are added 925 # or removed, the anchors will not be placed correctly. 926 # 927 # Note that for custom extensions or not directly supported extensions you also 928 # need to set EXTENSION_MAPPING for the extension otherwise the files are not 929 # properly processed by doxygen. 931 INPUT_FILTER = 933 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 934 # basis. Doxygen will compare the file name with each pattern and apply the 935 # filter if there is a match. The filters are a list of the form: pattern=filter 936 # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how 937 # filters are used. If the FILTER_PATTERNS tag is empty or if none of the 938 # patterns match the file name, INPUT_FILTER is applied. 939 # 940 # Note that for custom extensions or not directly supported extensions you also 941 # need to set EXTENSION_MAPPING for the extension otherwise the files are not 942 # properly processed by doxygen. 944 FILTER_PATTERNS = 946 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 947 # INPUT_FILTER) will also be used to filter the input files that are used for 948 # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). 949 # The default value is: NO. 951 FILTER_SOURCE_FILES = NO 953 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file 954 # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and 955 # it is also possible to disable source filtering for a specific pattern using 956 # *.ext= (so without naming a filter). 957 # This tag requires that the tag FILTER_SOURCE_FILES is set to YES. 959 FILTER_SOURCE_PATTERNS = 961 # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that 962 # is part of the input, its contents will be placed on the main page 963 # (index.html). This can be useful if you have a project on for instance GitHub 964 # and want to reuse the introduction page also for the doxygen output. 966 USE_MDFILE_AS_MAINPAGE = 968 #--------------------------------------------------------------------------- 969 # Configuration options related to source browsing 970 #--------------------------------------------------------------------------- 972 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be 973 # generated. Documented entities will be cross-referenced with these sources. 974 # 975 # Note: To get rid of all source code in the generated output, make sure that 976 # also VERBATIM_HEADERS is set to NO. 977 # The default value is: NO. 979 SOURCE_BROWSER = YES 981 # Setting the INLINE_SOURCES tag to YES will include the body of functions, 982 # classes and enums directly into the documentation. 983 # The default value is: NO. 985 INLINE_SOURCES = YES 987 # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any 988 # special comment blocks from generated source code fragments. Normal C, C++ and 989 # Fortran comments will always remain visible. 990 # The default value is: YES. 992 STRIP_CODE_COMMENTS = YES 994 # If the REFERENCED_BY_RELATION tag is set to YES then for each documented 995 # entity all documented functions referencing it will be listed. 996 # The default value is: NO. 998 REFERENCED_BY_RELATION = YES 1000 # If the REFERENCES_RELATION tag is set to YES then for each documented function 1001 # all documented entities called/used by that function will be listed. 1002 # The default value is: NO. 1004 REFERENCES_RELATION = NO 1006 # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set 1007 # to YES then the hyperlinks from functions in REFERENCES_RELATION and 1008 # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will 1009 # link to the documentation. 1010 # The default value is: YES. 1012 REFERENCES_LINK_SOURCE = YES 1014 # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the 1015 # source code will show a tooltip with additional information such as prototype, 1016 # brief description and links to the definition and documentation. Since this 1017 # will make the HTML file larger and loading of large files a bit slower, you 1018 # can opt to disable this feature. 1019 # The default value is: YES. 1020 # This tag requires that the tag SOURCE_BROWSER is set to YES. 1022 SOURCE_TOOLTIPS = YES 1024 # If the USE_HTAGS tag is set to YES then the references to source code will 1025 # point to the HTML generated by the htags(1) tool instead of doxygen built-in 1026 # source browser. The htags tool is part of GNU's global source tagging system 1027 # (see https://www.gnu.org/software/global/global.html). You will need version 1028 # 4.8.6 or higher. 1029 # 1030 # To use it do the following: 1031 # - Install the latest version of global 1032 # - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file 1033 # - Make sure the INPUT points to the root of the source tree 1034 # - Run doxygen as normal 1035 # 1036 # Doxygen will invoke htags (and that will in turn invoke gtags), so these 1037 # tools must be available from the command line (i.e. in the search path). 1038 # 1039 # The result: instead of the source browser generated by doxygen, the links to 1040 # source code will now point to the output of htags. 1041 # The default value is: NO. 1042 # This tag requires that the tag SOURCE_BROWSER is set to YES. 1044 USE_HTAGS = NO 1046 # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a 1047 # verbatim copy of the header file for each class for which an include is 1048 # specified. Set to NO to disable this. 1049 # See also: Section \class. 1050 # The default value is: YES. 1052 VERBATIM_HEADERS = YES 1054 #--------------------------------------------------------------------------- 1055 # Configuration options related to the alphabetical class index 1056 #--------------------------------------------------------------------------- 1058 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all 1059 # compounds will be generated. Enable this if the project contains a lot of 1060 # classes, structs, unions or interfaces. 1061 # The default value is: YES. 1063 ALPHABETICAL_INDEX = YES 1065 # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in 1066 # which the alphabetical index list will be split. 1067 # Minimum value: 1, maximum value: 20, default value: 5. 1068 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1070 COLS_IN_ALPHA_INDEX = 5 1072 # In case all classes in a project start with a common prefix, all classes will 1073 # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag 1074 # can be used to specify a prefix (or a list of prefixes) that should be ignored 1075 # while generating the index headers. 1076 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1078 IGNORE_PREFIX = 1080 #--------------------------------------------------------------------------- 1081 # Configuration options related to the HTML output 1082 #--------------------------------------------------------------------------- 1084 # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output 1085 # The default value is: YES. 1087 GENERATE_HTML = YES 1089 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a 1090 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1091 # it. 1092 # The default directory is: html. 1093 # This tag requires that the tag GENERATE_HTML is set to YES. 1095 HTML_OUTPUT = html 1097 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each 1098 # generated HTML page (for example: .htm, .php, .asp). 1099 # The default value is: .html. 1100 # This tag requires that the tag GENERATE_HTML is set to YES. 1102 HTML_FILE_EXTENSION = .html 1104 # The HTML_HEADER tag can be used to specify a user-defined HTML header file for 1105 # each generated HTML page. If the tag is left blank doxygen will generate a 1106 # standard header. 1107 # 1108 # To get valid HTML the header file that includes any scripts and style sheets 1109 # that doxygen needs, which is dependent on the configuration options used (e.g. 1110 # the setting GENERATE_TREEVIEW). It is highly recommended to start with a 1111 # default header using 1112 # doxygen -w html new_header.html new_footer.html new_stylesheet.css 1113 # YourConfigFile 1114 # and then modify the file new_header.html. See also section "Doxygen usage" 1115 # for information on how to generate the default header that doxygen normally 1116 # uses. 1117 # Note: The header is subject to change so you typically have to regenerate the 1118 # default header when upgrading to a newer version of doxygen. For a description 1119 # of the possible markers and block names see the documentation. 1120 # This tag requires that the tag GENERATE_HTML is set to YES. 1122 HTML_HEADER = 1124 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each 1125 # generated HTML page. If the tag is left blank doxygen will generate a standard 1126 # footer. See HTML_HEADER for more information on how to generate a default 1127 # footer and what special commands can be used inside the footer. See also 1128 # section "Doxygen usage" for information on how to generate the default footer 1129 # that doxygen normally uses. 1130 # This tag requires that the tag GENERATE_HTML is set to YES. 1132 HTML_FOOTER = 1134 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style 1135 # sheet that is used by each HTML page. It can be used to fine-tune the look of 1136 # the HTML output. If left blank doxygen will generate a default style sheet. 1137 # See also section "Doxygen usage" for information on how to generate the style 1138 # sheet that doxygen normally uses. 1139 # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as 1140 # it is more robust and this tag (HTML_STYLESHEET) will in the future become 1141 # obsolete. 1142 # This tag requires that the tag GENERATE_HTML is set to YES. 1144 HTML_STYLESHEET = 1146 # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined 1147 # cascading style sheets that are included after the standard style sheets 1148 # created by doxygen. Using this option one can overrule certain style aspects. 1149 # This is preferred over using HTML_STYLESHEET since it does not replace the 1150 # standard style sheet and is therefore more robust against future updates. 1151 # Doxygen will copy the style sheet files to the output directory. 1152 # Note: The order of the extra style sheet files is of importance (e.g. the last 1153 # style sheet in the list overrules the setting of the previous ones in the 1154 # list). For an example see the documentation. 1155 # This tag requires that the tag GENERATE_HTML is set to YES. 1157 HTML_EXTRA_STYLESHEET = 1159 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or 1160 # other source files which should be copied to the HTML output directory. Note 1161 # that these files will be copied to the base HTML output directory. Use the 1162 #$relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1163 # files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1164 # files will be copied as-is; there are no commands or markers available.
1165 # This tag requires that the tag GENERATE_HTML is set to YES.
1167 HTML_EXTRA_FILES =
1169 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
1170 # will adjust the colors in the style sheet and background images according to
1171 # this color. Hue is specified as an angle on a colorwheel, see
1173 # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
1174 # purple, and 360 is red again.
1175 # Minimum value: 0, maximum value: 359, default value: 220.
1176 # This tag requires that the tag GENERATE_HTML is set to YES.
1178 HTML_COLORSTYLE_HUE = 220
1180 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
1181 # in the HTML output. For a value of 0 the output will use grayscales only. A
1182 # value of 255 will produce the most vivid colors.
1183 # Minimum value: 0, maximum value: 255, default value: 100.
1184 # This tag requires that the tag GENERATE_HTML is set to YES.
1186 HTML_COLORSTYLE_SAT = 100
1188 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1189 # luminance component of the colors in the HTML output. Values below 100
1190 # gradually make the output lighter, whereas values above 100 make the output
1191 # darker. The value divided by 100 is the actual gamma applied, so 80 represents
1192 # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1193 # change the gamma.
1194 # Minimum value: 40, maximum value: 240, default value: 80.
1195 # This tag requires that the tag GENERATE_HTML is set to YES.
1197 HTML_COLORSTYLE_GAMMA = 80
1199 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1200 # page will contain the date and time when the page was generated. Setting this
1201 # to YES can help to show when doxygen was last run and thus if the
1202 # documentation is up to date.
1203 # The default value is: NO.
1204 # This tag requires that the tag GENERATE_HTML is set to YES.
1206 HTML_TIMESTAMP = YES
1208 # If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML
1209 # documentation will contain a main index with vertical navigation menus that
1210 # are dynamically created via Javascript. If disabled, the navigation index will
1211 # consists of multiple levels of tabs that are statically embedded in every HTML
1212 # page. Disable this option to support browsers that do not have Javascript,
1213 # like the Qt help browser.
1214 # The default value is: YES.
1215 # This tag requires that the tag GENERATE_HTML is set to YES.
1219 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1220 # documentation will contain sections that can be hidden and shown after the
1222 # The default value is: NO.
1223 # This tag requires that the tag GENERATE_HTML is set to YES.
1225 HTML_DYNAMIC_SECTIONS = NO
1227 # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
1228 # shown in the various tree structured indices initially; the user can expand
1229 # and collapse entries dynamically later on. Doxygen will expand the tree to
1230 # such a level that at most the specified number of entries are visible (unless
1231 # a fully collapsed tree already exceeds this amount). So setting the number of
1232 # entries 1 will produce a full collapsed tree by default. 0 is a special value
1233 # representing an infinite number of entries and will result in a full expanded
1234 # tree by default.
1235 # Minimum value: 0, maximum value: 9999, default value: 100.
1236 # This tag requires that the tag GENERATE_HTML is set to YES.
1238 HTML_INDEX_NUM_ENTRIES = 100
1240 # If the GENERATE_DOCSET tag is set to YES, additional index files will be
1241 # generated that can be used as input for Apple's Xcode 3 integrated development
1242 # environment (see: https://developer.apple.com/xcode/), introduced with OSX
1243 # 10.5 (Leopard). To create a documentation set, doxygen will generate a
1244 # Makefile in the HTML output directory. Running make will produce the docset in
1245 # that directory and running make install will install the docset in
1246 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1247 # startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy
1249 # The default value is: NO.
1250 # This tag requires that the tag GENERATE_HTML is set to YES.
1252 GENERATE_DOCSET = NO
1254 # This tag determines the name of the docset feed. A documentation feed provides
1255 # an umbrella under which multiple documentation sets from a single provider
1256 # (such as a company or product suite) can be grouped.
1257 # The default value is: Doxygen generated docs.
1258 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1260 DOCSET_FEEDNAME = "Doxygen generated docs"
1262 # This tag specifies a string that should uniquely identify the documentation
1263 # set bundle. This should be a reverse domain-name style string, e.g.
1264 # com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1265 # The default value is: org.doxygen.Project.
1266 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1268 DOCSET_BUNDLE_ID = org.doxygen.Project
1270 # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1271 # the documentation publisher. This should be a reverse domain-name style
1272 # string, e.g. com.mycompany.MyDocSet.documentation.
1273 # The default value is: org.doxygen.Publisher.
1274 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1276 DOCSET_PUBLISHER_ID = org.doxygen.Publisher
1278 # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1279 # The default value is: Publisher.
1280 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1282 DOCSET_PUBLISHER_NAME = Publisher
1284 # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1285 # additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1286 # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1288 # Windows.
1289 #
1290 # The HTML Help Workshop contains a compiler that can convert all HTML output
1291 # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1292 # files are now used as the Windows 98 help format, and will replace the old
1293 # Windows help format (.hlp) on all Windows platforms in the future. Compressed
1294 # HTML files also contain an index, a table of contents, and you can search for
1295 # words in the documentation. The HTML workshop also contains a viewer for
1296 # compressed HTML files.
1297 # The default value is: NO.
1298 # This tag requires that the tag GENERATE_HTML is set to YES.
1300 GENERATE_HTMLHELP = NO
1302 # The CHM_FILE tag can be used to specify the file name of the resulting .chm
1303 # file. You can add a path in front of the file if the result should not be
1304 # written to the html output directory.
1305 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1307 CHM_FILE =
1309 # The HHC_LOCATION tag can be used to specify the location (absolute path
1310 # including file name) of the HTML help compiler (hhc.exe). If non-empty,
1311 # doxygen will try to run the HTML help compiler on the generated index.hhp.
1312 # The file has to be specified with full path.
1313 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1315 HHC_LOCATION =
1317 # The GENERATE_CHI flag controls if a separate .chi index file is generated
1318 # (YES) or that it should be included in the master .chm file (NO).
1319 # The default value is: NO.
1320 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1322 GENERATE_CHI = NO
1324 # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
1325 # and project file content.
1326 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1328 CHM_INDEX_ENCODING =
1332 # enables the Previous and Next buttons.
1333 # The default value is: NO.
1334 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1336 BINARY_TOC = NO
1338 # The TOC_EXPAND flag can be set to YES to add extra items for group members to
1340 # The default value is: NO.
1341 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1343 TOC_EXPAND = NO
1345 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1346 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1347 # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1348 # (.qch) of the generated HTML documentation.
1349 # The default value is: NO.
1350 # This tag requires that the tag GENERATE_HTML is set to YES.
1352 GENERATE_QHP = NO
1354 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1355 # the file name of the resulting .qch file. The path specified is relative to
1356 # the HTML output folder.
1357 # This tag requires that the tag GENERATE_QHP is set to YES.
1359 QCH_FILE =
1361 # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1363 # (see: http://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace).
1364 # The default value is: org.doxygen.Project.
1365 # This tag requires that the tag GENERATE_QHP is set to YES.
1367 QHP_NAMESPACE = org.doxygen.Project
1369 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1371 # Folders (see: http://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-
1372 # folders).
1373 # The default value is: doc.
1374 # This tag requires that the tag GENERATE_QHP is set to YES.
1376 QHP_VIRTUAL_FOLDER = doc
1378 # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1380 # Filters (see: http://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-
1381 # filters).
1382 # This tag requires that the tag GENERATE_QHP is set to YES.
1384 QHP_CUST_FILTER_NAME =
1386 # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
1388 # Filters (see: http://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-
1389 # filters).
1390 # This tag requires that the tag GENERATE_QHP is set to YES.
1392 QHP_CUST_FILTER_ATTRS =
1394 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1395 # project's filter section matches. Qt Help Project / Filter Attributes (see:
1396 # http://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes).
1397 # This tag requires that the tag GENERATE_QHP is set to YES.
1399 QHP_SECT_FILTER_ATTRS =
1401 # The QHG_LOCATION tag can be used to specify the location of Qt's
1402 # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
1403 # generated .qhp file.
1404 # This tag requires that the tag GENERATE_QHP is set to YES.
1406 QHG_LOCATION =
1408 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1409 # generated, together with the HTML files, they form an Eclipse help plugin. To
1410 # install this plugin and make it available under the help contents menu in
1411 # Eclipse, the contents of the directory containing the HTML and XML files needs
1412 # to be copied into the plugins directory of eclipse. The name of the directory
1413 # within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1414 # After copying Eclipse needs to be restarted before the help appears.
1415 # The default value is: NO.
1416 # This tag requires that the tag GENERATE_HTML is set to YES.
1418 GENERATE_ECLIPSEHELP = NO
1420 # A unique identifier for the Eclipse help plugin. When installing the plugin
1421 # the directory name containing the HTML and XML files should also have this
1422 # name. Each documentation set should have its own identifier.
1423 # The default value is: org.doxygen.Project.
1424 # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1426 ECLIPSE_DOC_ID = org.doxygen.Project
1428 # If you want full control over the layout of the generated HTML pages it might
1429 # be necessary to disable the index and replace it with your own. The
1430 # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1431 # of each HTML page. A value of NO enables the index and the value YES disables
1432 # it. Since the tabs in the index contain the same information as the navigation
1433 # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1434 # The default value is: NO.
1435 # This tag requires that the tag GENERATE_HTML is set to YES.
1437 DISABLE_INDEX = NO
1439 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1440 # structure should be generated to display hierarchical information. If the tag
1441 # value is set to YES, a side panel will be generated containing a tree-like
1442 # index structure (just like the one that is generated for HTML Help). For this
1443 # to work a browser that supports JavaScript, DHTML, CSS and frames is required
1444 # (i.e. any modern browser). Windows users are probably better off using the
1445 # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
1446 # further fine-tune the look of the index. As an example, the default style
1447 # sheet generated by doxygen has an example that shows how to put an image at
1448 # the root of the tree instead of the PROJECT_NAME. Since the tree basically has
1449 # the same information as the tab index, you could consider setting
1450 # DISABLE_INDEX to YES when enabling this option.
1451 # The default value is: NO.
1452 # This tag requires that the tag GENERATE_HTML is set to YES.
1454 GENERATE_TREEVIEW = YES
1456 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1457 # doxygen will group on one line in the generated HTML documentation.
1458 #
1459 # Note that a value of 0 will completely suppress the enum values from appearing
1460 # in the overview section.
1461 # Minimum value: 0, maximum value: 20, default value: 4.
1462 # This tag requires that the tag GENERATE_HTML is set to YES.
1464 ENUM_VALUES_PER_LINE = 4
1466 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1467 # to set the initial width (in pixels) of the frame in which the tree is shown.
1468 # Minimum value: 0, maximum value: 1500, default value: 250.
1469 # This tag requires that the tag GENERATE_HTML is set to YES.
1471 TREEVIEW_WIDTH = 250
1473 # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
1474 # external symbols imported via tag files in a separate window.
1475 # The default value is: NO.
1476 # This tag requires that the tag GENERATE_HTML is set to YES.
1480 # Use this tag to change the font size of LaTeX formulas included as images in
1481 # the HTML documentation. When you change the font size after a successful
1482 # doxygen run you need to manually remove any form_*.png images from the HTML
1483 # output directory to force them to be regenerated.
1484 # Minimum value: 8, maximum value: 50, default value: 10.
1485 # This tag requires that the tag GENERATE_HTML is set to YES.
1487 FORMULA_FONTSIZE = 10
1489 # Use the FORMULA_TRANSPARENT tag to determine whether or not the images
1490 # generated for formulas are transparent PNGs. Transparent PNGs are not
1491 # supported properly for IE 6.0, but are supported on all modern browsers.
1492 #
1493 # Note that when changing this option you need to delete any form_*.png files in
1494 # the HTML output directory before the changes have effect.
1495 # The default value is: YES.
1496 # This tag requires that the tag GENERATE_HTML is set to YES.
1498 FORMULA_TRANSPARENT = YES
1500 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1501 # https://www.mathjax.org) which uses client side Javascript for the rendering
1502 # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
1503 # installed or if you want to formulas look prettier in the HTML output. When
1504 # enabled you may also need to install MathJax separately and configure the path
1505 # to it using the MATHJAX_RELPATH option.
1506 # The default value is: NO.
1507 # This tag requires that the tag GENERATE_HTML is set to YES.
1509 USE_MATHJAX = NO
1511 # When MathJax is enabled you can set the default output format to be used for
1512 # the MathJax output. See the MathJax site (see:
1513 # http://docs.mathjax.org/en/latest/output.html) for more details.
1514 # Possible values are: HTML-CSS (which is slower, but has the best
1515 # compatibility), NativeMML (i.e. MathML) and SVG.
1516 # The default value is: HTML-CSS.
1517 # This tag requires that the tag USE_MATHJAX is set to YES.
1519 MATHJAX_FORMAT = HTML-CSS
1521 # When MathJax is enabled you need to specify the location relative to the HTML
1522 # output directory using the MATHJAX_RELPATH option. The destination directory
1523 # should contain the MathJax.js script. For instance, if the mathjax directory
1524 # is located at the same level as the HTML output directory, then
1525 # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1526 # Content Delivery Network so you can quickly see the result without installing
1527 # MathJax. However, it is strongly recommended to install a local copy of
1528 # MathJax from https://www.mathjax.org before deployment.
1529 # The default value is: https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/.
1530 # This tag requires that the tag USE_MATHJAX is set to YES.
1532 MATHJAX_RELPATH = https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/
1534 # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1535 # extension names that should be enabled during MathJax rendering. For example
1536 # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
1537 # This tag requires that the tag USE_MATHJAX is set to YES.
1539 MATHJAX_EXTENSIONS =
1541 # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1542 # of code that will be used on startup of the MathJax code. See the MathJax site
1543 # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
1544 # example see the documentation.
1545 # This tag requires that the tag USE_MATHJAX is set to YES.
1547 MATHJAX_CODEFILE =
1549 # When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1550 # the HTML output. The underlying search engine uses javascript and DHTML and
1551 # should work on any modern browser. Note that when using HTML help
1552 # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
1553 # there is already a search function so this one should typically be disabled.
1554 # For large projects the javascript based search engine can be slow, then
1555 # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1556 # search using the keyboard; to jump to the search box use <access key> + S
1557 # (what the <access key> is depends on the OS and browser, but it is typically
1558 # <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
1559 # key> to jump into the search results window, the results can be navigated
1560 # using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1561 # the search. The filter options can be selected when the cursor is inside the
1562 # search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
1563 # to select a filter and <Enter> or <escape> to activate or cancel the filter
1564 # option.
1565 # The default value is: YES.
1566 # This tag requires that the tag GENERATE_HTML is set to YES.
1568 SEARCHENGINE = YES
1570 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1571 # implemented using a web server instead of a web client using Javascript. There
1572 # are two flavors of web server based searching depending on the EXTERNAL_SEARCH
1573 # setting. When disabled, doxygen will generate a PHP script for searching and
1574 # an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
1575 # and searching needs to be provided by external tools. See the section
1576 # "External Indexing and Searching" for details.
1577 # The default value is: NO.
1578 # This tag requires that the tag SEARCHENGINE is set to YES.
1580 SERVER_BASED_SEARCH = YES
1582 # When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1583 # script for searching. Instead the search results are written to an XML file
1584 # which needs to be processed by an external indexer. Doxygen will invoke an
1585 # external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1586 # search results.
1587 #
1588 # Doxygen ships with an example indexer (doxyindexer) and search engine
1589 # (doxysearch.cgi) which are based on the open source search engine library
1590 # Xapian (see: https://xapian.org/).
1591 #
1592 # See the section "External Indexing and Searching" for details.
1593 # The default value is: NO.
1594 # This tag requires that the tag SEARCHENGINE is set to YES.
1596 EXTERNAL_SEARCH = YES
1598 # The SEARCHENGINE_URL should point to a search engine hosted by a web server
1599 # which will return the search results when EXTERNAL_SEARCH is enabled.
1600 #
1601 # Doxygen ships with an example indexer (doxyindexer) and search engine
1602 # (doxysearch.cgi) which are based on the open source search engine library
1603 # Xapian (see: https://xapian.org/). See the section "External Indexing and
1604 # Searching" for details.
1605 # This tag requires that the tag SEARCHENGINE is set to YES.
1607 SEARCHENGINE_URL = https://doxygen.reactos.org/doxysearch.cgi
1609 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
1610 # search data is written to a file for indexing by an external tool. With the
1611 # SEARCHDATA_FILE tag the name of this file can be specified.
1612 # The default file is: searchdata.xml.
1613 # This tag requires that the tag SEARCHENGINE is set to YES.
1615 SEARCHDATA_FILE = searchdata.xml
1617 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
1618 # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1619 # useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1620 # projects and redirect the results back to the right project.
1621 # This tag requires that the tag SEARCHENGINE is set to YES.
1623 EXTERNAL_SEARCH_ID =
1625 # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1626 # projects other than the one defined by this configuration file, but that are
1627 # all added to the same external search index. Each project needs to have a
1628 # unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
1629 # to a relative location where the documentation can be found. The format is:
1630 # EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
1631 # This tag requires that the tag SEARCHENGINE is set to YES.
1633 EXTRA_SEARCH_MAPPINGS =
1635 #---------------------------------------------------------------------------
1636 # Configuration options related to the LaTeX output
1637 #---------------------------------------------------------------------------
1639 # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
1640 # The default value is: YES.
1642 GENERATE_LATEX = NO
1644 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1645 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1646 # it.
1647 # The default directory is: latex.
1648 # This tag requires that the tag GENERATE_LATEX is set to YES.
1650 LATEX_OUTPUT = latex
1652 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1653 # invoked.
1654 #
1655 # Note that when not enabling USE_PDFLATEX the default is latex when enabling
1656 # USE_PDFLATEX the default is pdflatex and when in the later case latex is
1657 # chosen this is overwritten by pdflatex. For specific output languages the
1658 # default can have been set differently, this depends on the implementation of
1659 # the output language.
1660 # This tag requires that the tag GENERATE_LATEX is set to YES.
1662 LATEX_CMD_NAME =
1664 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
1665 # index for LaTeX.
1666 # Note: This tag is used in the Makefile / make.bat.
1667 # See also: LATEX_MAKEINDEX_CMD for the part in the generated output file
1668 # (.tex).
1669 # The default file is: makeindex.
1670 # This tag requires that the tag GENERATE_LATEX is set to YES.
1672 MAKEINDEX_CMD_NAME = makeindex
1674 # The LATEX_MAKEINDEX_CMD tag can be used to specify the command name to
1675 # generate index for LaTeX.
1676 # Note: This tag is used in the generated output file (.tex).
1677 # See also: MAKEINDEX_CMD_NAME for the part in the Makefile / make.bat.
1678 # The default value is: \makeindex.
1679 # This tag requires that the tag GENERATE_LATEX is set to YES.
1681 LATEX_MAKEINDEX_CMD = \makeindex
1683 # If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
1684 # documents. This may be useful for small projects and may help to save some
1685 # trees in general.
1686 # The default value is: NO.
1687 # This tag requires that the tag GENERATE_LATEX is set to YES.
1689 COMPACT_LATEX = NO
1691 # The PAPER_TYPE tag can be used to set the paper type that is used by the
1692 # printer.
1693 # Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
1694 # 14 inches) and executive (7.25 x 10.5 inches).
1695 # The default value is: a4.
1696 # This tag requires that the tag GENERATE_LATEX is set to YES.
1698 PAPER_TYPE = a4
1700 # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
1701 # that should be included in the LaTeX output. The package can be specified just
1702 # by its name or with the correct syntax as to be used with the LaTeX
1703 # \usepackage command. To get the times font for instance you can specify :
1704 # EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}
1705 # To use the option intlimits with the amsmath package you can specify:
1706 # EXTRA_PACKAGES=[intlimits]{amsmath}
1707 # If left blank no extra packages will be included.
1708 # This tag requires that the tag GENERATE_LATEX is set to YES.
1710 EXTRA_PACKAGES =
1712 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
1713 # generated LaTeX document. The header should contain everything until the first
1714 # chapter. If it is left blank doxygen will generate a standard header. See
1715 # section "Doxygen usage" for information on how to let doxygen write the
1716 # default header to a separate file.
1717 #
1718 # Note: Only use a user-defined header if you know what you are doing! The
1719 # following commands have a special meaning inside the header: $title, 1720 #$datetime, $date,$doxygenversion, $projectname,$projectnumber,
1721 # $projectbrief,$projectlogo. Doxygen will replace \$title with the empty
1722 # string, for the replacement values of the other commands the user is referred
1724 # This tag requires that the tag GENERATE_LATEX is set to YES.
1728 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
1729 # generated LaTeX document. The footer should contain everything after the last
1730 # chapter. If it is left blank doxygen will generate a standard footer. See
1732 # special commands can be used inside the footer.
1733 #
1734 # Note: Only use a user-defined footer if you know what you are doing!
1735 # This tag requires that the tag GENERATE_LATEX is set to YES.
1737 LATEX_FOOTER =
1739 # The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1740 # LaTeX style sheets that are included after the standard style sheets created
1741 # by doxygen. Using this option one can overrule certain style aspects. Doxygen
1742 # will copy the style sheet files to the output directory.
1743 # Note: The order of the extra style sheet files is of importance (e.g. the last
1744 # style sheet in the list overrules the setting of the previous ones in the
1745 # list).
1746 # This tag requires that the tag GENERATE_LATEX is set to YES.
1748 LATEX_EXTRA_STYLESHEET =
1750 # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
1751 # other source files which should be copied to the LATEX_OUTPUT output
1752 # directory. Note that the files will be copied as-is; there are no commands or
1753 # markers available.
1754 # This tag requires that the tag GENERATE_LATEX is set to YES.
1756 LATEX_EXTRA_FILES =
1758 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1759 # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
1760 # contain links (just like the HTML output) instead of page references. This
1761 # makes the output suitable for online browsing using a PDF viewer.
1762 # The default value is: YES.
1763 # This tag requires that the tag GENERATE_LATEX is set to YES.
1767 # If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1768 # the PDF file directly from the LaTeX files. Set this option to YES, to get a
1769 # higher quality PDF documentation.
1770 # The default value is: YES.
1771 # This tag requires that the tag GENERATE_LATEX is set to YES.
1773 USE_PDFLATEX = YES
1775 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1776 # command to the generated LaTeX files. This will instruct LaTeX to keep running
1777 # if errors occur, instead of asking the user for help. This option is also used
1778 # when generating formulas in HTML.
1779 # The default value is: NO.
1780 # This tag requires that the tag GENERATE_LATEX is set to YES.
1782 LATEX_BATCHMODE = NO
1784 # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1785 # index chapters (such as File Index, Compound Index, etc.) in the output.
1786 # The default value is: NO.
1787 # This tag requires that the tag GENERATE_LATEX is set to YES.
1789 LATEX_HIDE_INDICES = NO
1791 # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
1792 # code with syntax highlighting in the LaTeX output.
1793 #
1794 # Note that which sources are shown also depends on other settings such as
1795 # SOURCE_BROWSER.
1796 # The default value is: NO.
1797 # This tag requires that the tag GENERATE_LATEX is set to YES.
1799 LATEX_SOURCE_CODE = NO
1801 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1802 # bibliography, e.g. plainnat, or ieeetr. See
1804 # The default value is: plain.
1805 # This tag requires that the tag GENERATE_LATEX is set to YES.
1807 LATEX_BIB_STYLE = plain
1809 # If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
1810 # page will contain the date and time when the page was generated. Setting this
1811 # to NO can help when comparing the output of multiple runs.
1812 # The default value is: NO.
1813 # This tag requires that the tag GENERATE_LATEX is set to YES.
1815 LATEX_TIMESTAMP = NO
1817 # The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute)
1818 # path from which the emoji images will be read. If a relative path is entered,
1819 # it will be relative to the LATEX_OUTPUT directory. If left blank the
1820 # LATEX_OUTPUT directory will be used.
1821 # This tag requires that the tag GENERATE_LATEX is set to YES.
1823 LATEX_EMOJI_DIRECTORY =
1825 #---------------------------------------------------------------------------
1826 # Configuration options related to the RTF output
1827 #---------------------------------------------------------------------------
1829 # If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
1830 # RTF output is optimized for Word 97 and may not look too pretty with other RTF
1832 # The default value is: NO.
1834 GENERATE_RTF = NO
1836 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
1837 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1838 # it.
1839 # The default directory is: rtf.
1840 # This tag requires that the tag GENERATE_RTF is set to YES.
1842 RTF_OUTPUT = rtf
1844 # If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
1845 # documents. This may be useful for small projects and may help to save some
1846 # trees in general.
1847 # The default value is: NO.
1848 # This tag requires that the tag GENERATE_RTF is set to YES.
1850 COMPACT_RTF = NO
1852 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
1853 # contain hyperlink fields. The RTF file will contain links (just like the HTML
1854 # output) instead of page references. This makes the output suitable for online
1855 # browsing using Word or some other Word compatible readers that support those
1856 # fields.
1857 #
1859 # The default value is: NO.
1860 # This tag requires that the tag GENERATE_RTF is set to YES.
1864 # Load stylesheet definitions from file. Syntax is similar to doxygen's
1865 # configuration file, i.e. a series of assignments. You only have to provide
1866 # replacements, missing definitions are set to their default value.
1867 #
1868 # See also section "Doxygen usage" for information on how to generate the
1869 # default style sheet that doxygen normally uses.
1870 # This tag requires that the tag GENERATE_RTF is set to YES.
1872 RTF_STYLESHEET_FILE =
1874 # Set optional variables used in the generation of an RTF document. Syntax is
1875 # similar to doxygen's configuration file. A template extensions file can be
1876 # generated using doxygen -e rtf extensionFile.
1877 # This tag requires that the tag GENERATE_RTF is set to YES.
1879 RTF_EXTENSIONS_FILE =
1881 # If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
1882 # with syntax highlighting in the RTF output.
1883 #
1884 # Note that which sources are shown also depends on other settings such as
1885 # SOURCE_BROWSER.
1886 # The default value is: NO.
1887 # This tag requires that the tag GENERATE_RTF is set to YES.
1889 RTF_SOURCE_CODE = NO
1891 #---------------------------------------------------------------------------
1892 # Configuration options related to the man page output
1893 #---------------------------------------------------------------------------
1895 # If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
1896 # classes and files.
1897 # The default value is: NO.
1899 GENERATE_MAN = NO
1901 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
1902 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1903 # it. A directory man3 will be created inside the directory specified by
1904 # MAN_OUTPUT.
1905 # The default directory is: man.
1906 # This tag requires that the tag GENERATE_MAN is set to YES.
1908 MAN_OUTPUT = man
1910 # The MAN_EXTENSION tag determines the extension that is added to the generated
1911 # man pages. In case the manual section does not start with a number, the number
1912 # 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
1913 # optional.
1914 # The default value is: .3.
1915 # This tag requires that the tag GENERATE_MAN is set to YES.
1917 MAN_EXTENSION = .3
1919 # The MAN_SUBDIR tag determines the name of the directory created within
1920 # MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
1921 # MAN_EXTENSION with the initial . removed.
1922 # This tag requires that the tag GENERATE_MAN is set to YES.
1924 MAN_SUBDIR =
1926 # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
1927 # will generate one additional man file for each entity documented in the real
1928 # man page(s). These additional files only source the real man page, but without
1929 # them the man command would be unable to find the correct page.
1930 # The default value is: NO.
1931 # This tag requires that the tag GENERATE_MAN is set to YES.
1935 #---------------------------------------------------------------------------
1936 # Configuration options related to the XML output
1937 #---------------------------------------------------------------------------
1939 # If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
1940 # captures the structure of the code including all documentation.
1941 # The default value is: NO.
1943 GENERATE_XML = NO
1945 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
1946 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1947 # it.
1948 # The default directory is: xml.
1949 # This tag requires that the tag GENERATE_XML is set to YES.
1951 XML_OUTPUT = xml
1953 # If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
1954 # listings (including syntax highlighting and cross-referencing information) to
1955 # the XML output. Note that enabling this will significantly increase the size
1956 # of the XML output.
1957 # The default value is: YES.
1958 # This tag requires that the tag GENERATE_XML is set to YES.
1960 XML_PROGRAMLISTING = YES
1962 # If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include
1963 # namespace members in file scope as well, matching the HTML output.
1964 # The default value is: NO.
1965 # This tag requires that the tag GENERATE_XML is set to YES.
1967 XML_NS_MEMB_FILE_SCOPE = NO
1969 #---------------------------------------------------------------------------
1970 # Configuration options related to the DOCBOOK output
1971 #---------------------------------------------------------------------------
1973 # If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
1974 # that can be used to generate PDF.
1975 # The default value is: NO.
1977 GENERATE_DOCBOOK = NO
1979 # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
1980 # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
1981 # front of it.
1982 # The default directory is: docbook.
1983 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1985 DOCBOOK_OUTPUT = docbook
1987 # If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
1988 # program listings (including syntax highlighting and cross-referencing
1989 # information) to the DOCBOOK output. Note that enabling this will significantly
1990 # increase the size of the DOCBOOK output.
1991 # The default value is: NO.
1992 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1994 DOCBOOK_PROGRAMLISTING = NO
1996 #---------------------------------------------------------------------------
1997 # Configuration options for the AutoGen Definitions output
1998 #---------------------------------------------------------------------------
2000 # If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
2001 # AutoGen Definitions (see http://autogen.sourceforge.net/) file that captures
2002 # the structure of the code including all documentation. Note that this feature
2003 # is still experimental and incomplete at the moment.
2004 # The default value is: NO.
2006 GENERATE_AUTOGEN_DEF = NO
2008 #---------------------------------------------------------------------------
2009 # Configuration options related to the Perl module output
2010 #---------------------------------------------------------------------------
2012 # If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
2013 # file that captures the structure of the code including all documentation.
2014 #
2015 # Note that this feature is still experimental and incomplete at the moment.
2016 # The default value is: NO.
2018 GENERATE_PERLMOD = NO
2020 # If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
2021 # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
2022 # output from the Perl module output.
2023 # The default value is: NO.
2024 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2026 PERLMOD_LATEX = NO
2028 # If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
2029 # formatted so it can be parsed by a human reader. This is useful if you want to
2030 # understand what is going on. On the other hand, if this tag is set to NO, the
2031 # size of the Perl module output will be much smaller and Perl will parse it
2032 # just the same.
2033 # The default value is: YES.
2034 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2036 PERLMOD_PRETTY = YES
2038 # The names of the make variables in the generated doxyrules.make file are
2039 # prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
2040 # so different doxyrules.make files included by the same Makefile don't
2041 # overwrite each other's variables.
2042 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2044 PERLMOD_MAKEVAR_PREFIX =
2046 #---------------------------------------------------------------------------
2047 # Configuration options related to the preprocessor
2048 #---------------------------------------------------------------------------
2050 # If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
2051 # C-preprocessor directives found in the sources and include files.
2052 # The default value is: YES.
2054 ENABLE_PREPROCESSING = YES
2056 # If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
2057 # in the source code. If set to NO, only conditional compilation will be
2058 # performed. Macro expansion can be done in a controlled way by setting
2059 # EXPAND_ONLY_PREDEF to YES.
2060 # The default value is: NO.
2061 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2063 MACRO_EXPANSION = NO
2065 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
2066 # the macro expansion is limited to the macros specified with the PREDEFINED and
2067 # EXPAND_AS_DEFINED tags.
2068 # The default value is: NO.
2069 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2071 EXPAND_ONLY_PREDEF = NO
2073 # If the SEARCH_INCLUDES tag is set to YES, the include files in the
2074 # INCLUDE_PATH will be searched if a #include is found.
2075 # The default value is: YES.
2076 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2078 SEARCH_INCLUDES = NO
2080 # The INCLUDE_PATH tag can be used to specify one or more directories that
2081 # contain include files that are not input files but should be processed by the
2082 # preprocessor.
2083 # This tag requires that the tag SEARCH_INCLUDES is set to YES.
2085 INCLUDE_PATH =
2087 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
2088 # patterns (like *.h and *.hpp) to filter out the header-files in the
2089 # directories. If left blank, the patterns specified with FILE_PATTERNS will be
2090 # used.
2091 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2093 INCLUDE_FILE_PATTERNS =
2095 # The PREDEFINED tag can be used to specify one or more macro names that are
2096 # defined before the preprocessor is started (similar to the -D option of e.g.
2097 # gcc). The argument of the tag is a list of macros of the form: name or
2098 # name=definition (no spaces). If the definition and the "=" are omitted, "=1"
2099 # is assumed. To prevent a macro definition from being undefined via #undef or
2100 # recursively expanded use the := operator instead of the = operator.
2101 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2103 PREDEFINED =
2105 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
2106 # tag can be used to specify a list of macro names that should be expanded. The
2107 # macro definition that is found in the sources will be used. Use the PREDEFINED
2108 # tag if you want to use a different macro definition that overrules the
2109 # definition found in the source code.
2110 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2112 EXPAND_AS_DEFINED =
2114 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
2115 # remove all references to function-like macros that are alone on a line, have
2116 # an all uppercase name, and do not end with a semicolon. Such function macros
2117 # are typically used for boiler-plate code, and will confuse the parser if not
2118 # removed.
2119 # The default value is: YES.
2120 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2122 SKIP_FUNCTION_MACROS = YES
2124 #---------------------------------------------------------------------------
2125 # Configuration options related to external references
2126 #---------------------------------------------------------------------------
2128 # The TAGFILES tag can be used to specify one or more tag files. For each tag
2129 # file the location of the external documentation should be added. The format of
2130 # a tag file without this location is as follows:
2131 # TAGFILES = file1 file2 ...
2132 # Adding location for the tag files is done as follows:
2133 # TAGFILES = file1=loc1 "file2 = loc2" ...
2134 # where loc1 and loc2 can be relative or absolute paths or URLs. See the
2136 # of tag files.
2137 # Note: Each tag file must have a unique name (where the name does NOT include
2138 # the path). If a tag file is not located in the directory in which doxygen is
2139 # run, you must also specify the path to the tagfile here.
2141 TAGFILES =
2143 # When a file name is specified after GENERATE_TAGFILE, doxygen will create a
2144 # tag file that is based on the input files it reads. See section "Linking to
2147 GENERATE_TAGFILE =
2149 # If the ALLEXTERNALS tag is set to YES, all external class will be listed in
2150 # the class index. If set to NO, only the inherited external classes will be
2151 # listed.
2152 # The default value is: NO.
2154 ALLEXTERNALS = NO
2156 # If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
2157 # in the modules index. If set to NO, only the current project's groups will be
2158 # listed.
2159 # The default value is: YES.
2161 EXTERNAL_GROUPS = YES
2163 # If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
2164 # the related pages index. If set to NO, only the current project's pages will
2165 # be listed.
2166 # The default value is: YES.
2168 EXTERNAL_PAGES = YES
2170 # The PERL_PATH should be the absolute path and name of the perl script
2171 # interpreter (i.e. the result of 'which perl').
2172 # The default file (with absolute path) is: /usr/bin/perl.
2174 PERL_PATH = /usr/bin/perl
2176 #---------------------------------------------------------------------------
2177 # Configuration options related to the dot tool
2178 #---------------------------------------------------------------------------
2180 # If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
2181 # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
2182 # NO turns the diagrams off. Note that this option also works with HAVE_DOT
2183 # disabled, but it is recommended to install and use dot, since it yields more
2184 # powerful graphs.
2185 # The default value is: YES.
2187 CLASS_DIAGRAMS = YES
2189 # You can define message sequence charts within doxygen comments using the \msc
2190 # command. Doxygen will then run the mscgen tool (see:
2191 # http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
2192 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
2193 # the mscgen tool resides. If left empty the tool is assumed to be found in the
2194 # default search path.
2196 MSCGEN_PATH =
2198 # You can include diagrams made with dia in doxygen documentation. Doxygen will
2199 # then run dia to produce the diagram and insert it in the documentation. The
2200 # DIA_PATH tag allows you to specify the directory where the dia binary resides.
2201 # If left empty dia is assumed to be found in the default search path.
2203 DIA_PATH =
2205 # If set to YES the inheritance and collaboration graphs will hide inheritance
2206 # and usage relations if the target is undocumented or is not a class.
2207 # The default value is: YES.
2209 HIDE_UNDOC_RELATIONS = YES
2211 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2212 # available from the path. This tool is part of Graphviz (see:
2213 # http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
2214 # Bell Labs. The other options in this section have no effect if this option is
2215 # set to NO
2216 # The default value is: NO.
2218 HAVE_DOT = YES
2220 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2221 # to run in parallel. When set to 0 doxygen will base this on the number of
2222 # processors available in the system. You can set it explicitly to a value
2223 # larger than 0 to get control over the balance between CPU load and processing
2224 # speed.
2225 # Minimum value: 0, maximum value: 32, default value: 0.
2226 # This tag requires that the tag HAVE_DOT is set to YES.
2230 # When you want a differently looking font in the dot files that doxygen
2231 # generates you can specify the font name using DOT_FONTNAME. You need to make
2232 # sure dot is able to find the font, which can be done by putting it in a
2233 # standard location or by setting the DOTFONTPATH environment variable or by
2234 # setting DOT_FONTPATH to the directory containing the font.
2235 # The default value is: Helvetica.
2236 # This tag requires that the tag HAVE_DOT is set to YES.
2238 DOT_FONTNAME = Helvetica
2240 # The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
2241 # dot graphs.
2242 # Minimum value: 4, maximum value: 24, default value: 10.
2243 # This tag requires that the tag HAVE_DOT is set to YES.
2245 DOT_FONTSIZE = 10
2247 # By default doxygen will tell dot to use the default font as specified with
2248 # DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
2249 # the path where dot can find it using this tag.
2250 # This tag requires that the tag HAVE_DOT is set to YES.
2252 DOT_FONTPATH =
2254 # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2255 # each documented class showing the direct and indirect inheritance relations.
2256 # Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
2257 # The default value is: YES.
2258 # This tag requires that the tag HAVE_DOT is set to YES.
2260 CLASS_GRAPH = YES
2262 # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2263 # graph for each documented class showing the direct and indirect implementation
2264 # dependencies (inheritance, containment, and class references variables) of the
2265 # class with other documented classes.
2266 # The default value is: YES.
2267 # This tag requires that the tag HAVE_DOT is set to YES.
2269 COLLABORATION_GRAPH = YES
2271 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2272 # groups, showing the direct groups dependencies.
2273 # The default value is: YES.
2274 # This tag requires that the tag HAVE_DOT is set to YES.
2276 GROUP_GRAPHS = YES
2278 # If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
2279 # collaboration diagrams in a style similar to the OMG's Unified Modeling
2280 # Language.
2281 # The default value is: NO.
2282 # This tag requires that the tag HAVE_DOT is set to YES.
2284 UML_LOOK = NO
2286 # If the UML_LOOK tag is enabled, the fields and methods are shown inside the
2287 # class node. If there are many fields or methods and many nodes the graph may
2288 # become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2289 # number of items for each type to make the size more manageable. Set this to 0
2290 # for no limit. Note that the threshold may be exceeded by 50% before the limit
2291 # is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2292 # but if the number exceeds 15, the total amount of fields shown is limited to
2293 # 10.
2294 # Minimum value: 0, maximum value: 100, default value: 10.
2295 # This tag requires that the tag HAVE_DOT is set to YES.
2297 UML_LIMIT_NUM_FIELDS = 10
2299 # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2300 # collaboration graphs will show the relations between templates and their
2301 # instances.
2302 # The default value is: NO.
2303 # This tag requires that the tag HAVE_DOT is set to YES.
2305 TEMPLATE_RELATIONS = NO
2307 # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2308 # YES then doxygen will generate a graph for each documented file showing the
2309 # direct and indirect include dependencies of the file with other documented
2310 # files.
2311 # The default value is: YES.
2312 # This tag requires that the tag HAVE_DOT is set to YES.
2314 INCLUDE_GRAPH = YES
2316 # If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
2317 # set to YES then doxygen will generate a graph for each documented file showing
2318 # the direct and indirect include dependencies of the file with other documented
2319 # files.
2320 # The default value is: YES.
2321 # This tag requires that the tag HAVE_DOT is set to YES.
2323 INCLUDED_BY_GRAPH = YES
2325 # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2326 # dependency graph for every global function or class method.
2327 #
2328 # Note that enabling this option will significantly increase the time of a run.
2329 # So in most cases it will be better to enable call graphs for selected
2330 # functions only using the \callgraph command. Disabling a call graph can be
2331 # accomplished by means of the command \hidecallgraph.
2332 # The default value is: NO.
2333 # This tag requires that the tag HAVE_DOT is set to YES.
2335 CALL_GRAPH = NO
2337 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2338 # dependency graph for every global function or class method.
2339 #
2340 # Note that enabling this option will significantly increase the time of a run.
2341 # So in most cases it will be better to enable caller graphs for selected
2342 # functions only using the \callergraph command. Disabling a caller graph can be
2343 # accomplished by means of the command \hidecallergraph.
2344 # The default value is: NO.
2345 # This tag requires that the tag HAVE_DOT is set to YES.
2347 CALLER_GRAPH = NO
2349 # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2350 # hierarchy of all classes instead of a textual one.
2351 # The default value is: YES.
2352 # This tag requires that the tag HAVE_DOT is set to YES.
2354 GRAPHICAL_HIERARCHY = YES
2356 # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2357 # dependencies a directory has on other directories in a graphical way. The
2358 # dependency relations are determined by the #include relations between the
2359 # files in the directories.
2360 # The default value is: YES.
2361 # This tag requires that the tag HAVE_DOT is set to YES.
2363 DIRECTORY_GRAPH = YES
2365 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2366 # generated by dot. For an explanation of the image formats see the section
2367 # output formats in the documentation of the dot tool (Graphviz (see:
2368 # http://www.graphviz.org/)).
2369 # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2370 # to make the SVG files visible in IE 9+ (other browsers do not have this
2371 # requirement).
2372 # Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo,
2373 # png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
2374 # png:gdiplus:gdiplus.
2375 # The default value is: png.
2376 # This tag requires that the tag HAVE_DOT is set to YES.
2378 DOT_IMAGE_FORMAT = png
2380 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2381 # enable generation of interactive SVG images that allow zooming and panning.
2382 #
2383 # Note that this requires a modern browser other than Internet Explorer. Tested
2384 # and working are Firefox, Chrome, Safari, and Opera.
2385 # Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2386 # the SVG files visible. Older versions of IE do not have SVG support.
2387 # The default value is: NO.
2388 # This tag requires that the tag HAVE_DOT is set to YES.
2390 INTERACTIVE_SVG = NO
2392 # The DOT_PATH tag can be used to specify the path where the dot tool can be
2393 # found. If left blank, it is assumed the dot tool can be found in the path.
2394 # This tag requires that the tag HAVE_DOT is set to YES.
2396 DOT_PATH =
2398 # The DOTFILE_DIRS tag can be used to specify one or more directories that
2399 # contain dot files that are included in the documentation (see the \dotfile
2400 # command).
2401 # This tag requires that the tag HAVE_DOT is set to YES.
2403 DOTFILE_DIRS =
2405 # The MSCFILE_DIRS tag can be used to specify one or more directories that
2406 # contain msc files that are included in the documentation (see the \mscfile
2407 # command).
2409 MSCFILE_DIRS =
2411 # The DIAFILE_DIRS tag can be used to specify one or more directories that
2412 # contain dia files that are included in the documentation (see the \diafile
2413 # command).
2415 DIAFILE_DIRS =
2417 # When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
2418 # path where java can find the plantuml.jar file. If left blank, it is assumed
2419 # PlantUML is not used or called during a preprocessing step. Doxygen will
2420 # generate a warning when it encounters a \startuml command in this case and
2421 # will not generate output for the diagram.
2423 PLANTUML_JAR_PATH =
2425 # When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a
2426 # configuration file for plantuml.
2428 PLANTUML_CFG_FILE =
2430 # When using plantuml, the specified paths are searched for files specified by
2431 # the !include statement in a plantuml block.
2433 PLANTUML_INCLUDE_PATH =
2435 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2436 # that will be shown in the graph. If the number of nodes in a graph becomes
2437 # larger than this value, doxygen will truncate the graph, which is visualized
2438 # by representing a node as a red box. Note that doxygen if the number of direct
2439 # children of the root node in a graph is already larger than
2440 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2441 # the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2442 # Minimum value: 0, maximum value: 10000, default value: 50.
2443 # This tag requires that the tag HAVE_DOT is set to YES.
2445 DOT_GRAPH_MAX_NODES = 50
2447 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2448 # generated by dot. A depth value of 3 means that only nodes reachable from the
2449 # root by following a path via at most 3 edges will be shown. Nodes that lay
2450 # further from the root node will be omitted. Note that setting this option to 1
2451 # or 2 may greatly reduce the computation time needed for large code bases. Also
2452 # note that the size of a graph can be further restricted by
2453 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
2454 # Minimum value: 0, maximum value: 1000, default value: 0.
2455 # This tag requires that the tag HAVE_DOT is set to YES.
2457 MAX_DOT_GRAPH_DEPTH = 0
2459 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2460 # background. This is disabled by default, because dot on Windows does not seem
2461 # to support this out of the box.
2462 #
2463 # Warning: Depending on the platform used, enabling this option may lead to
2464 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2466 # The default value is: NO.
2467 # This tag requires that the tag HAVE_DOT is set to YES.
2469 DOT_TRANSPARENT = NO
2471 # Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
2472 # files in one run (i.e. multiple -o and -T options on the command line). This
2473 # makes dot run faster, but since only newer versions of dot (>1.8.10) support
2474 # this, this feature is disabled by default.
2475 # The default value is: NO.
2476 # This tag requires that the tag HAVE_DOT is set to YES.
2478 DOT_MULTI_TARGETS = YES
2480 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2481 # explaining the meaning of the various boxes and arrows in the dot generated
2482 # graphs.
2483 # The default value is: YES.
2484 # This tag requires that the tag HAVE_DOT is set to YES.
2486 GENERATE_LEGEND = YES
2488 # If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
2489 # files that are used to generate the various graphs.
2490 # The default value is: YES.
2491 # This tag requires that the tag HAVE_DOT is set to YES.
2493 DOT_CLEANUP = YES