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