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