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