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