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