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