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