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