1# Doxyfile 1.8.1.2 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 hash (#) is considered a comment and will be ignored. 7# The format is: 8# TAG = value [value, ...] 9# For lists items can also be appended using: 10# TAG += value [value, ...] 11# Values that contain spaces should be placed between quotes (" "). 12 13#--------------------------------------------------------------------------- 14# Project related configuration options 15#--------------------------------------------------------------------------- 16 17# This tag specifies the encoding used for all characters in the config file 18# that follow. The default is UTF-8 which is also the encoding used for all 19# text before the first occurrence of this tag. Doxygen uses libiconv (or the 20# iconv built into libc) for the transcoding. See 21# http://www.gnu.org/software/libiconv for the list of possible encodings. 22 23DOXYFILE_ENCODING = UTF-8 24 25# The PROJECT_NAME tag is a single word (or sequence of words) that should 26# identify the project. Note that if you do not use Doxywizard you need 27# to put quotes around the project name if it contains spaces. 28 29PROJECT_NAME = Pioneers 30 31# The PROJECT_NUMBER tag can be used to enter a project or revision number. 32# This could be handy for archiving the generated documentation or 33# if some version control system is used. 34 35PROJECT_NUMBER = 15.6 36 37# Using the PROJECT_BRIEF tag one can provide an optional one line description 38# for a project that appears at the top of each page and should give viewer 39# a quick idea about the purpose of the project. Keep the description short. 40 41PROJECT_BRIEF = 42 43# With the PROJECT_LOGO tag one can specify an logo or icon that is 44# included in the documentation. The maximum height of the logo should not 45# exceed 55 pixels and the maximum width should not exceed 200 pixels. 46# Doxygen will copy the logo to the output directory. 47 48PROJECT_LOGO = client/gtk/data/pioneers.48x48_apps.png 49 50# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 51# base path where the generated documentation will be put. 52# If a relative path is entered, it will be relative to the location 53# where doxygen was started. If left blank the current directory will be used. 54 55OUTPUT_DIRECTORY = 56 57# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 58# 4096 sub-directories (in 2 levels) under the output directory of each output 59# format and will distribute the generated files over these directories. 60# Enabling this option can be useful when feeding doxygen a huge amount of 61# source files, where putting all generated files in the same directory would 62# otherwise cause performance problems for the file system. 63 64CREATE_SUBDIRS = NO 65 66# The OUTPUT_LANGUAGE tag is used to specify the language in which all 67# documentation generated by doxygen is written. Doxygen will use this 68# information to generate all constant output in the proper language. 69# The default language is English, other supported languages are: 70# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, 71# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, 72# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English 73# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, 74# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, 75# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. 76 77OUTPUT_LANGUAGE = English 78 79# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 80# include brief member descriptions after the members that are listed in 81# the file and class documentation (similar to JavaDoc). 82# Set to NO to disable this. 83 84BRIEF_MEMBER_DESC = YES 85 86# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 87# the brief description of a member or function before the detailed description. 88# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 89# brief descriptions will be completely suppressed. 90 91REPEAT_BRIEF = YES 92 93# This tag implements a quasi-intelligent brief description abbreviator 94# that is used to form the text in various listings. Each string 95# in this list, if found as the leading text of the brief description, will be 96# stripped from the text and the result after processing the whole list, is 97# used as the annotated text. Otherwise, the brief description is used as-is. 98# If left blank, the following values are used ("$name" is automatically 99# replaced with the name of the entity): "The $name class" "The $name widget" 100# "The $name file" "is" "provides" "specifies" "contains" 101# "represents" "a" "an" "the" 102 103ABBREVIATE_BRIEF = "The $name class" \ 104 "The $name widget" \ 105 "The $name file" \ 106 is \ 107 provides \ 108 specifies \ 109 contains \ 110 represents \ 111 a \ 112 an \ 113 the 114 115# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 116# Doxygen will generate a detailed section even if there is only a brief 117# description. 118 119ALWAYS_DETAILED_SEC = NO 120 121# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 122# inherited members of a class in the documentation of that class as if those 123# members were ordinary class members. Constructors, destructors and assignment 124# operators of the base classes will not be shown. 125 126INLINE_INHERITED_MEMB = NO 127 128# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 129# path before files name in the file list and in the header files. If set 130# to NO the shortest path that makes the file name unique will be used. 131 132FULL_PATH_NAMES = YES 133 134# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 135# can be used to strip a user-defined part of the path. Stripping is 136# only done if one of the specified strings matches the left-hand part of 137# the path. The tag can be used to show relative paths in the file list. 138# If left blank the directory from which doxygen is run is used as the 139# path to strip. 140 141STRIP_FROM_PATH = 142 143# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 144# the path mentioned in the documentation of a class, which tells 145# the reader which header file to include in order to use a class. 146# If left blank only the name of the header file containing the class 147# definition is used. Otherwise one should specify the include paths that 148# are normally passed to the compiler using the -I flag. 149 150STRIP_FROM_INC_PATH = 151 152# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 153# (but less readable) file names. This can be useful if your file system 154# doesn't support long names like on DOS, Mac, or CD-ROM. 155 156SHORT_NAMES = NO 157 158# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 159# will interpret the first line (until the first dot) of a JavaDoc-style 160# comment as the brief description. If set to NO, the JavaDoc 161# comments will behave just like regular Qt-style comments 162# (thus requiring an explicit @brief command for a brief description.) 163 164JAVADOC_AUTOBRIEF = YES 165 166# If the QT_AUTOBRIEF tag is set to YES then Doxygen will 167# interpret the first line (until the first dot) of a Qt-style 168# comment as the brief description. If set to NO, the comments 169# will behave just like regular Qt-style comments (thus requiring 170# an explicit \brief command for a brief description.) 171 172QT_AUTOBRIEF = NO 173 174# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 175# treat a multi-line C++ special comment block (i.e. a block of //! or /// 176# comments) as a brief description. This used to be the default behaviour. 177# The new default is to treat a multi-line C++ comment block as a detailed 178# description. Set this tag to YES if you prefer the old behaviour instead. 179 180MULTILINE_CPP_IS_BRIEF = NO 181 182# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 183# member inherits the documentation from any documented member that it 184# re-implements. 185 186INHERIT_DOCS = YES 187 188# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce 189# a new page for each member. If set to NO, the documentation of a member will 190# be part of the file/class/namespace that contains it. 191 192SEPARATE_MEMBER_PAGES = NO 193 194# The TAB_SIZE tag can be used to set the number of spaces in a tab. 195# Doxygen uses this value to replace tabs by spaces in code fragments. 196 197TAB_SIZE = 8 198 199# This tag can be used to specify a number of aliases that acts 200# as commands in the documentation. An alias has the form "name=value". 201# For example adding "sideeffect=\par Side Effects:\n" will allow you to 202# put the command \sideeffect (or @sideeffect) in the documentation, which 203# will result in a user-defined paragraph with heading "Side Effects:". 204# You can put \n's in the value part of an alias to insert newlines. 205 206ALIASES = 207 208# This tag can be used to specify a number of word-keyword mappings (TCL only). 209# A mapping has the form "name=value". For example adding 210# "class=itcl::class" will allow you to use the command class in the 211# itcl::class meaning. 212 213TCL_SUBST = 214 215# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 216# sources only. Doxygen will then generate output that is more tailored for C. 217# For instance, some of the names that are used will be different. The list 218# of all members will be omitted, etc. 219 220OPTIMIZE_OUTPUT_FOR_C = YES 221 222# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java 223# sources only. Doxygen will then generate output that is more tailored for 224# Java. For instance, namespaces will be presented as packages, qualified 225# scopes will look different, etc. 226 227OPTIMIZE_OUTPUT_JAVA = NO 228 229# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 230# sources only. Doxygen will then generate output that is more tailored for 231# Fortran. 232 233OPTIMIZE_FOR_FORTRAN = NO 234 235# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 236# sources. Doxygen will then generate output that is tailored for 237# VHDL. 238 239OPTIMIZE_OUTPUT_VHDL = NO 240 241# Doxygen selects the parser to use depending on the extension of the files it 242# parses. With this tag you can assign which parser to use for a given extension. 243# Doxygen has a built-in mapping, but you can override or extend it using this 244# tag. The format is ext=language, where ext is a file extension, and language 245# is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C, 246# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make 247# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C 248# (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions 249# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen. 250 251EXTENSION_MAPPING = 252 253# If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all 254# comments according to the Markdown format, which allows for more readable 255# documentation. See http://daringfireball.net/projects/markdown/ for details. 256# The output of markdown processing is further processed by doxygen, so you 257# can mix doxygen, HTML, and XML commands with Markdown formatting. 258# Disable only in case of backward compatibilities issues. 259 260MARKDOWN_SUPPORT = YES 261 262# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 263# to include (a tag file for) the STL sources as input, then you should 264# set this tag to YES in order to let doxygen match functions declarations and 265# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. 266# func(std::string) {}). This also makes the inheritance and collaboration 267# diagrams that involve STL classes more complete and accurate. 268 269BUILTIN_STL_SUPPORT = NO 270 271# If you use Microsoft's C++/CLI language, you should set this option to YES to 272# enable parsing support. 273 274CPP_CLI_SUPPORT = NO 275 276# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. 277# Doxygen will parse them like normal C++ but will assume all classes use public 278# instead of private inheritance when no explicit protection keyword is present. 279 280SIP_SUPPORT = NO 281 282# For Microsoft's IDL there are propget and propput attributes to indicate getter 283# and setter methods for a property. Setting this option to YES (the default) 284# will make doxygen replace the get and set methods by a property in the 285# documentation. This will only work if the methods are indeed getting or 286# setting a simple type. If this is not the case, or you want to show the 287# methods anyway, you should set this option to NO. 288 289IDL_PROPERTY_SUPPORT = YES 290 291# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 292# tag is set to YES, then doxygen will reuse the documentation of the first 293# member in the group (if any) for the other members of the group. By default 294# all members of a group must be documented explicitly. 295 296DISTRIBUTE_GROUP_DOC = NO 297 298# Set the SUBGROUPING tag to YES (the default) to allow class member groups of 299# the same type (for instance a group of public functions) to be put as a 300# subgroup of that type (e.g. under the Public Functions section). Set it to 301# NO to prevent subgrouping. Alternatively, this can be done per class using 302# the \nosubgrouping command. 303 304SUBGROUPING = YES 305 306# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and 307# unions are shown inside the group in which they are included (e.g. using 308# @ingroup) instead of on a separate page (for HTML and Man pages) or 309# section (for LaTeX and RTF). 310 311INLINE_GROUPED_CLASSES = NO 312 313# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and 314# unions with only public data fields will be shown inline in the documentation 315# of the scope in which they are defined (i.e. file, namespace, or group 316# documentation), provided this scope is documented. If set to NO (the default), 317# structs, classes, and unions are shown on a separate page (for HTML and Man 318# pages) or section (for LaTeX and RTF). 319 320INLINE_SIMPLE_STRUCTS = NO 321 322# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum 323# is documented as struct, union, or enum with the name of the typedef. So 324# typedef struct TypeS {} TypeT, will appear in the documentation as a struct 325# with name TypeT. When disabled the typedef will appear as a member of a file, 326# namespace, or class. And the struct will be named TypeS. This can typically 327# be useful for C code in case the coding convention dictates that all compound 328# types are typedef'ed and only the typedef is referenced, never the tag name. 329 330TYPEDEF_HIDES_STRUCT = YES 331 332# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to 333# determine which symbols to keep in memory and which to flush to disk. 334# When the cache is full, less often used symbols will be written to disk. 335# For small to medium size projects (<1000 input files) the default value is 336# probably good enough. For larger projects a too small cache size can cause 337# doxygen to be busy swapping symbols to and from disk most of the time 338# causing a significant performance penalty. 339# If the system has enough physical memory increasing the cache will improve the 340# performance by keeping more symbols in memory. Note that the value works on 341# a logarithmic scale so increasing the size by one will roughly double the 342# memory usage. The cache size is given by this formula: 343# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, 344# corresponding to a cache size of 2^16 = 65536 symbols. 345 346SYMBOL_CACHE_SIZE = 0 347 348# Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be 349# set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given 350# their name and scope. Since this can be an expensive process and often the 351# same symbol appear multiple times in the code, doxygen keeps a cache of 352# pre-resolved symbols. If the cache is too small doxygen will become slower. 353# If the cache is too large, memory is wasted. The cache size is given by this 354# formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0, 355# corresponding to a cache size of 2^16 = 65536 symbols. 356 357LOOKUP_CACHE_SIZE = 0 358 359#--------------------------------------------------------------------------- 360# Build related configuration options 361#--------------------------------------------------------------------------- 362 363# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 364# documentation are documented, even if no documentation was available. 365# Private class members and static file members will be hidden unless 366# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES 367 368EXTRACT_ALL = NO 369 370# If the EXTRACT_PRIVATE tag is set to YES all private members of a class 371# will be included in the documentation. 372 373EXTRACT_PRIVATE = YES 374 375# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal scope will be included in the documentation. 376 377EXTRACT_PACKAGE = NO 378 379# If the EXTRACT_STATIC tag is set to YES all static members of a file 380# will be included in the documentation. 381 382EXTRACT_STATIC = NO 383 384# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 385# defined locally in source files will be included in the documentation. 386# If set to NO only classes defined in header files are included. 387 388EXTRACT_LOCAL_CLASSES = YES 389 390# This flag is only useful for Objective-C code. When set to YES local 391# methods, which are defined in the implementation section but not in 392# the interface are included in the documentation. 393# If set to NO (the default) only methods in the interface are included. 394 395EXTRACT_LOCAL_METHODS = NO 396 397# If this flag is set to YES, the members of anonymous namespaces will be 398# extracted and appear in the documentation as a namespace called 399# 'anonymous_namespace{file}', where file will be replaced with the base 400# name of the file that contains the anonymous namespace. By default 401# anonymous namespaces are hidden. 402 403EXTRACT_ANON_NSPACES = NO 404 405# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 406# undocumented members of documented classes, files or namespaces. 407# If set to NO (the default) these members will be included in the 408# various overviews, but no documentation section is generated. 409# This option has no effect if EXTRACT_ALL is enabled. 410 411HIDE_UNDOC_MEMBERS = NO 412 413# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 414# undocumented classes that are normally visible in the class hierarchy. 415# If set to NO (the default) these classes will be included in the various 416# overviews. This option has no effect if EXTRACT_ALL is enabled. 417 418HIDE_UNDOC_CLASSES = NO 419 420# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 421# friend (class|struct|union) declarations. 422# If set to NO (the default) these declarations will be included in the 423# documentation. 424 425HIDE_FRIEND_COMPOUNDS = NO 426 427# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 428# documentation blocks found inside the body of a function. 429# If set to NO (the default) these blocks will be appended to the 430# function's detailed documentation block. 431 432HIDE_IN_BODY_DOCS = NO 433 434# The INTERNAL_DOCS tag determines if documentation 435# that is typed after a \internal command is included. If the tag is set 436# to NO (the default) then the documentation will be excluded. 437# Set it to YES to include the internal documentation. 438 439INTERNAL_DOCS = YES 440 441# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 442# file names in lower-case letters. If set to YES upper-case letters are also 443# allowed. This is useful if you have classes or files whose names only differ 444# in case and if your file system supports case sensitive file names. Windows 445# and Mac users are advised to set this option to NO. 446 447CASE_SENSE_NAMES = YES 448 449# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 450# will show members with their full class and namespace scopes in the 451# documentation. If set to YES the scope will be hidden. 452 453HIDE_SCOPE_NAMES = NO 454 455# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 456# will put a list of the files that are included by a file in the documentation 457# of that file. 458 459SHOW_INCLUDE_FILES = YES 460 461# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen 462# will list include files with double quotes in the documentation 463# rather than with sharp brackets. 464 465FORCE_LOCAL_INCLUDES = NO 466 467# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 468# is inserted in the documentation for inline members. 469 470INLINE_INFO = YES 471 472# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 473# will sort the (detailed) documentation of file and class members 474# alphabetically by member name. If set to NO the members will appear in 475# declaration order. 476 477SORT_MEMBER_DOCS = YES 478 479# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 480# brief documentation of file, namespace and class members alphabetically 481# by member name. If set to NO (the default) the members will appear in 482# declaration order. 483 484SORT_BRIEF_DOCS = NO 485 486# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen 487# will sort the (brief and detailed) documentation of class members so that 488# constructors and destructors are listed first. If set to NO (the default) 489# the constructors will appear in the respective orders defined by 490# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. 491# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO 492# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. 493 494SORT_MEMBERS_CTORS_1ST = NO 495 496# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the 497# hierarchy of group names into alphabetical order. If set to NO (the default) 498# the group names will appear in their defined order. 499 500SORT_GROUP_NAMES = NO 501 502# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 503# sorted by fully-qualified names, including namespaces. If set to 504# NO (the default), the class list will be sorted only by class name, 505# not including the namespace part. 506# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 507# Note: This option applies only to the class list, not to the 508# alphabetical list. 509 510SORT_BY_SCOPE_NAME = NO 511 512# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to 513# do proper type resolution of all parameters of a function it will reject a 514# match between the prototype and the implementation of a member function even 515# if there is only one candidate or it is obvious which candidate to choose 516# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen 517# will still accept a match between prototype and implementation in such cases. 518 519STRICT_PROTO_MATCHING = NO 520 521# The GENERATE_TODOLIST tag can be used to enable (YES) or 522# disable (NO) the todo list. This list is created by putting \todo 523# commands in the documentation. 524 525GENERATE_TODOLIST = YES 526 527# The GENERATE_TESTLIST tag can be used to enable (YES) or 528# disable (NO) the test list. This list is created by putting \test 529# commands in the documentation. 530 531GENERATE_TESTLIST = YES 532 533# The GENERATE_BUGLIST tag can be used to enable (YES) or 534# disable (NO) the bug list. This list is created by putting \bug 535# commands in the documentation. 536 537GENERATE_BUGLIST = YES 538 539# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 540# disable (NO) the deprecated list. This list is created by putting 541# \deprecated commands in the documentation. 542 543GENERATE_DEPRECATEDLIST= YES 544 545# The ENABLED_SECTIONS tag can be used to enable conditional 546# documentation sections, marked by \if sectionname ... \endif. 547 548ENABLED_SECTIONS = 549 550# The MAX_INITIALIZER_LINES tag determines the maximum number of lines 551# the initial value of a variable or macro consists of for it to appear in 552# the documentation. If the initializer consists of more lines than specified 553# here it will be hidden. Use a value of 0 to hide initializers completely. 554# The appearance of the initializer of individual variables and macros in the 555# documentation can be controlled using \showinitializer or \hideinitializer 556# command in the documentation regardless of this setting. 557 558MAX_INITIALIZER_LINES = 30 559 560# Set the SHOW_USED_FILES tag to NO to disable the list of files generated 561# at the bottom of the documentation of classes and structs. If set to YES the 562# list will mention the files that were used to generate the documentation. 563 564SHOW_USED_FILES = YES 565 566# Set the SHOW_FILES tag to NO to disable the generation of the Files page. 567# This will remove the Files entry from the Quick Index and from the 568# Folder Tree View (if specified). The default is YES. 569 570SHOW_FILES = YES 571 572# Set the SHOW_NAMESPACES tag to NO to disable the generation of the 573# Namespaces page. 574# This will remove the Namespaces entry from the Quick Index 575# and from the Folder Tree View (if specified). The default is YES. 576 577SHOW_NAMESPACES = YES 578 579# The FILE_VERSION_FILTER tag can be used to specify a program or script that 580# doxygen should invoke to get the current version for each file (typically from 581# the version control system). Doxygen will invoke the program by executing (via 582# popen()) the command <command> <input-file>, where <command> is the value of 583# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file 584# provided by doxygen. Whatever the program writes to standard output 585# is used as the file version. See the manual for examples. 586 587FILE_VERSION_FILTER = 588 589# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed 590# by doxygen. The layout file controls the global structure of the generated 591# output files in an output format independent way. To create the layout file 592# that represents doxygen's defaults, run doxygen with the -l option. 593# You can optionally specify a file name after the option, if omitted 594# DoxygenLayout.xml will be used as the name of the layout file. 595 596LAYOUT_FILE = 597 598# The CITE_BIB_FILES tag can be used to specify one or more bib files 599# containing the references data. This must be a list of .bib files. The 600# .bib extension is automatically appended if omitted. Using this command 601# requires the bibtex tool to be installed. See also 602# http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style 603# of the bibliography can be controlled using LATEX_BIB_STYLE. To use this 604# feature you need bibtex and perl available in the search path. 605 606CITE_BIB_FILES = 607 608#--------------------------------------------------------------------------- 609# configuration options related to warning and progress messages 610#--------------------------------------------------------------------------- 611 612# The QUIET tag can be used to turn on/off the messages that are generated 613# by doxygen. Possible values are YES and NO. If left blank NO is used. 614 615QUIET = NO 616 617# The WARNINGS tag can be used to turn on/off the warning messages that are 618# generated by doxygen. Possible values are YES and NO. If left blank 619# NO is used. 620 621WARNINGS = YES 622 623# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 624# for undocumented members. If EXTRACT_ALL is set to YES then this flag will 625# automatically be disabled. 626 627WARN_IF_UNDOCUMENTED = YES 628 629# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 630# potential errors in the documentation, such as not documenting some 631# parameters in a documented function, or documenting parameters that 632# don't exist or using markup commands wrongly. 633 634WARN_IF_DOC_ERROR = YES 635 636# The WARN_NO_PARAMDOC option can be enabled to get warnings for 637# functions that are documented, but have no documentation for their parameters 638# or return value. If set to NO (the default) doxygen will only warn about 639# wrong or incomplete parameter documentation, but not about the absence of 640# documentation. 641 642WARN_NO_PARAMDOC = NO 643 644# The WARN_FORMAT tag determines the format of the warning messages that 645# doxygen can produce. The string should contain the $file, $line, and $text 646# tags, which will be replaced by the file and line number from which the 647# warning originated and the warning text. Optionally the format may contain 648# $version, which will be replaced by the version of the file (if it could 649# be obtained via FILE_VERSION_FILTER) 650 651WARN_FORMAT = "$file:$line: $text" 652 653# The WARN_LOGFILE tag can be used to specify a file to which warning 654# and error messages should be written. If left blank the output is written 655# to stderr. 656 657WARN_LOGFILE = 658 659#--------------------------------------------------------------------------- 660# configuration options related to the input files 661#--------------------------------------------------------------------------- 662 663# The INPUT tag can be used to specify the files and/or directories that contain 664# documented source files. You may enter file names like "myfile.cpp" or 665# directories like "/usr/src/myproject". Separate the files or directories 666# with spaces. 667 668INPUT = 669 670# This tag can be used to specify the character encoding of the source files 671# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is 672# also the default input encoding. Doxygen uses libiconv (or the iconv built 673# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for 674# the list of possible encodings. 675 676INPUT_ENCODING = UTF-8 677 678# If the value of the INPUT tag contains directories, you can use the 679# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 680# and *.h) to filter out the source-files in the directories. If left 681# blank the following patterns are tested: 682# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh 683# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py 684# *.f90 *.f *.for *.vhd *.vhdl 685 686FILE_PATTERNS = *.c \ 687 *.h 688 689# The RECURSIVE tag can be used to turn specify whether or not subdirectories 690# should be searched for input files as well. Possible values are YES and NO. 691# If left blank NO is used. 692 693RECURSIVE = yes 694 695# The EXCLUDE tag can be used to specify files and/or directories that should be 696# excluded from the INPUT source files. This way you can easily exclude a 697# subdirectory from a directory tree whose root is specified with the INPUT tag. 698# Note that relative paths are relative to the directory from which doxygen is 699# run. 700 701EXCLUDE = 702 703# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or 704# directories that are symbolic links (a Unix file system feature) are excluded 705# from the input. 706 707EXCLUDE_SYMLINKS = NO 708 709# If the value of the INPUT tag contains directories, you can use the 710# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 711# certain files from those directories. Note that the wildcards are matched 712# against the file with absolute path, so to exclude all test directories 713# for example use the pattern */test/* 714 715EXCLUDE_PATTERNS = 716 717# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 718# (namespaces, classes, functions, etc.) that should be excluded from the 719# output. The symbol name can be a fully qualified name, a word, or if the 720# wildcard * is used, a substring. Examples: ANamespace, AClass, 721# AClass::ANamespace, ANamespace::*Test 722 723EXCLUDE_SYMBOLS = 724 725# The EXAMPLE_PATH tag can be used to specify one or more files or 726# directories that contain example code fragments that are included (see 727# the \include command). 728 729EXAMPLE_PATH = 730 731# If the value of the EXAMPLE_PATH tag contains directories, you can use the 732# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 733# and *.h) to filter out the source-files in the directories. If left 734# blank all files are included. 735 736EXAMPLE_PATTERNS = * 737 738# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 739# searched for input files to be used with the \include or \dontinclude 740# commands irrespective of the value of the RECURSIVE tag. 741# Possible values are YES and NO. If left blank NO is used. 742 743EXAMPLE_RECURSIVE = NO 744 745# The IMAGE_PATH tag can be used to specify one or more files or 746# directories that contain image that are included in the documentation (see 747# the \image command). 748 749IMAGE_PATH = 750 751# The INPUT_FILTER tag can be used to specify a program that doxygen should 752# invoke to filter for each input file. Doxygen will invoke the filter program 753# by executing (via popen()) the command <filter> <input-file>, where <filter> 754# is the value of the INPUT_FILTER tag, and <input-file> is the name of an 755# input file. Doxygen will then use the output that the filter program writes 756# to standard output. 757# If FILTER_PATTERNS is specified, this tag will be 758# ignored. 759 760INPUT_FILTER = 761 762# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 763# basis. 764# Doxygen will compare the file name with each pattern and apply the 765# filter if there is a match. 766# The filters are a list of the form: 767# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 768# info on how filters are used. If FILTER_PATTERNS is empty or if 769# non of the patterns match the file name, INPUT_FILTER is applied. 770 771FILTER_PATTERNS = 772 773# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 774# INPUT_FILTER) will be used to filter the input files when producing source 775# files to browse (i.e. when SOURCE_BROWSER is set to YES). 776 777FILTER_SOURCE_FILES = NO 778 779# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file 780# pattern. A pattern will override the setting for FILTER_PATTERN (if any) 781# and it is also possible to disable source filtering for a specific pattern 782# using *.ext= (so without naming a filter). This option only has effect when 783# FILTER_SOURCE_FILES is enabled. 784 785FILTER_SOURCE_PATTERNS = 786 787#--------------------------------------------------------------------------- 788# configuration options related to source browsing 789#--------------------------------------------------------------------------- 790 791# If the SOURCE_BROWSER tag is set to YES then a list of source files will 792# be generated. Documented entities will be cross-referenced with these sources. 793# Note: To get rid of all source code in the generated output, make sure also 794# VERBATIM_HEADERS is set to NO. 795 796SOURCE_BROWSER = NO 797 798# Setting the INLINE_SOURCES tag to YES will include the body 799# of functions and classes directly in the documentation. 800 801INLINE_SOURCES = NO 802 803# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 804# doxygen to hide any special comment blocks from generated source code 805# fragments. Normal C, C++ and Fortran comments will always remain visible. 806 807STRIP_CODE_COMMENTS = YES 808 809# If the REFERENCED_BY_RELATION tag is set to YES 810# then for each documented function all documented 811# functions referencing it will be listed. 812 813REFERENCED_BY_RELATION = YES 814 815# If the REFERENCES_RELATION tag is set to YES 816# then for each documented function all documented entities 817# called/used by that function will be listed. 818 819REFERENCES_RELATION = YES 820 821# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) 822# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from 823# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will 824# link to the source code. 825# Otherwise they will link to the documentation. 826 827REFERENCES_LINK_SOURCE = YES 828 829# If the USE_HTAGS tag is set to YES then the references to source code 830# will point to the HTML generated by the htags(1) tool instead of doxygen 831# built-in source browser. The htags tool is part of GNU's global source 832# tagging system (see http://www.gnu.org/software/global/global.html). You 833# will need version 4.8.6 or higher. 834 835USE_HTAGS = NO 836 837# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 838# will generate a verbatim copy of the header file for each class for 839# which an include is specified. Set to NO to disable this. 840 841VERBATIM_HEADERS = YES 842 843#--------------------------------------------------------------------------- 844# configuration options related to the alphabetical class index 845#--------------------------------------------------------------------------- 846 847# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 848# of all compounds will be generated. Enable this if the project 849# contains a lot of classes, structs, unions or interfaces. 850 851ALPHABETICAL_INDEX = NO 852 853# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 854# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 855# in which this list will be split (can be a number in the range [1..20]) 856 857COLS_IN_ALPHA_INDEX = 5 858 859# In case all classes in a project start with a common prefix, all 860# classes will be put under the same header in the alphabetical index. 861# The IGNORE_PREFIX tag can be used to specify one or more prefixes that 862# should be ignored while generating the index headers. 863 864IGNORE_PREFIX = 865 866#--------------------------------------------------------------------------- 867# configuration options related to the HTML output 868#--------------------------------------------------------------------------- 869 870# If the GENERATE_HTML tag is set to YES (the default) Doxygen will 871# generate HTML output. 872 873GENERATE_HTML = YES 874 875# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 876# If a relative path is entered the value of OUTPUT_DIRECTORY will be 877# put in front of it. If left blank `html' will be used as the default path. 878 879HTML_OUTPUT = html 880 881# The HTML_FILE_EXTENSION tag can be used to specify the file extension for 882# each generated HTML page (for example: .htm,.php,.asp). If it is left blank 883# doxygen will generate files with .html extension. 884 885HTML_FILE_EXTENSION = .html 886 887# The HTML_HEADER tag can be used to specify a personal HTML header for 888# each generated HTML page. If it is left blank doxygen will generate a 889# standard header. Note that when using a custom header you are responsible 890# for the proper inclusion of any scripts and style sheets that doxygen 891# needs, which is dependent on the configuration options used. 892# It is advised to generate a default header using "doxygen -w html 893# header.html footer.html stylesheet.css YourConfigFile" and then modify 894# that header. Note that the header is subject to change so you typically 895# have to redo this when upgrading to a newer version of doxygen or when 896# changing the value of configuration settings such as GENERATE_TREEVIEW! 897 898HTML_HEADER = 899 900# The HTML_FOOTER tag can be used to specify a personal HTML footer for 901# each generated HTML page. If it is left blank doxygen will generate a 902# standard footer. 903 904HTML_FOOTER = 905 906# The HTML_STYLESHEET tag can be used to specify a user-defined cascading 907# style sheet that is used by each HTML page. It can be used to 908# fine-tune the look of the HTML output. If the tag is left blank doxygen 909# will generate a default style sheet. Note that doxygen will try to copy 910# the style sheet file to the HTML output directory, so don't put your own 911# style sheet in the HTML output directory as well, or it will be erased! 912 913HTML_STYLESHEET = 914 915# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or 916# other source files which should be copied to the HTML output directory. Note 917# that these files will be copied to the base HTML output directory. Use the 918# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these 919# files. In the HTML_STYLESHEET file, use the file name only. Also note that 920# the files will be copied as-is; there are no commands or markers available. 921 922HTML_EXTRA_FILES = 923 924# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. 925# Doxygen will adjust the colors in the style sheet and background images 926# according to this color. Hue is specified as an angle on a colorwheel, 927# see http://en.wikipedia.org/wiki/Hue for more information. 928# For instance the value 0 represents red, 60 is yellow, 120 is green, 929# 180 is cyan, 240 is blue, 300 purple, and 360 is red again. 930# The allowed range is 0 to 359. 931 932HTML_COLORSTYLE_HUE = 220 933 934# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of 935# the colors in the HTML output. For a value of 0 the output will use 936# grayscales only. A value of 255 will produce the most vivid colors. 937 938HTML_COLORSTYLE_SAT = 100 939 940# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to 941# the luminance component of the colors in the HTML output. Values below 942# 100 gradually make the output lighter, whereas values above 100 make 943# the output darker. The value divided by 100 is the actual gamma applied, 944# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, 945# and 100 does not change the gamma. 946 947HTML_COLORSTYLE_GAMMA = 80 948 949# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML 950# page will contain the date and time when the page was generated. Setting 951# this to NO can help when comparing the output of multiple runs. 952 953HTML_TIMESTAMP = YES 954 955# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 956# documentation will contain sections that can be hidden and shown after the 957# page has loaded. 958 959HTML_DYNAMIC_SECTIONS = NO 960 961# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of 962# entries shown in the various tree structured indices initially; the user 963# can expand and collapse entries dynamically later on. Doxygen will expand 964# the tree to such a level that at most the specified number of entries are 965# visible (unless a fully collapsed tree already exceeds this amount). 966# So setting the number of entries 1 will produce a full collapsed tree by 967# default. 0 is a special value representing an infinite number of entries 968# and will result in a full expanded tree by default. 969 970HTML_INDEX_NUM_ENTRIES = 100 971 972# If the GENERATE_DOCSET tag is set to YES, additional index files 973# will be generated that can be used as input for Apple's Xcode 3 974# integrated development environment, introduced with OSX 10.5 (Leopard). 975# To create a documentation set, doxygen will generate a Makefile in the 976# HTML output directory. Running make will produce the docset in that 977# directory and running "make install" will install the docset in 978# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find 979# it at startup. 980# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html 981# for more information. 982 983GENERATE_DOCSET = NO 984 985# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the 986# feed. A documentation feed provides an umbrella under which multiple 987# documentation sets from a single provider (such as a company or product suite) 988# can be grouped. 989 990DOCSET_FEEDNAME = "Doxygen generated docs" 991 992# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that 993# should uniquely identify the documentation set bundle. This should be a 994# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen 995# will append .docset to the name. 996 997DOCSET_BUNDLE_ID = org.doxygen.Project 998 999# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify 1000# the documentation publisher. This should be a reverse domain-name style 1001# string, e.g. com.mycompany.MyDocSet.documentation. 1002 1003DOCSET_PUBLISHER_ID = org.doxygen.Publisher 1004 1005# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. 1006 1007DOCSET_PUBLISHER_NAME = Publisher 1008 1009# If the GENERATE_HTMLHELP tag is set to YES, additional index files 1010# will be generated that can be used as input for tools like the 1011# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) 1012# of the generated HTML documentation. 1013 1014GENERATE_HTMLHELP = NO 1015 1016# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 1017# be used to specify the file name of the resulting .chm file. You 1018# can add a path in front of the file if the result should not be 1019# written to the html output directory. 1020 1021CHM_FILE = 1022 1023# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 1024# be used to specify the location (absolute path including file name) of 1025# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 1026# the HTML help compiler on the generated index.hhp. 1027 1028HHC_LOCATION = 1029 1030# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 1031# controls if a separate .chi index file is generated (YES) or that 1032# it should be included in the master .chm file (NO). 1033 1034GENERATE_CHI = NO 1035 1036# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING 1037# is used to encode HtmlHelp index (hhk), content (hhc) and project file 1038# content. 1039 1040CHM_INDEX_ENCODING = 1041 1042# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 1043# controls whether a binary table of contents is generated (YES) or a 1044# normal table of contents (NO) in the .chm file. 1045 1046BINARY_TOC = NO 1047 1048# The TOC_EXPAND flag can be set to YES to add extra items for group members 1049# to the contents of the HTML help documentation and to the tree view. 1050 1051TOC_EXPAND = NO 1052 1053# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and 1054# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated 1055# that can be used as input for Qt's qhelpgenerator to generate a 1056# Qt Compressed Help (.qch) of the generated HTML documentation. 1057 1058GENERATE_QHP = NO 1059 1060# If the QHG_LOCATION tag is specified, the QCH_FILE tag can 1061# be used to specify the file name of the resulting .qch file. 1062# The path specified is relative to the HTML output folder. 1063 1064QCH_FILE = 1065 1066# The QHP_NAMESPACE tag specifies the namespace to use when generating 1067# Qt Help Project output. For more information please see 1068# http://doc.trolltech.com/qthelpproject.html#namespace 1069 1070QHP_NAMESPACE = org.doxygen.Project 1071 1072# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating 1073# Qt Help Project output. For more information please see 1074# http://doc.trolltech.com/qthelpproject.html#virtual-folders 1075 1076QHP_VIRTUAL_FOLDER = doc 1077 1078# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to 1079# add. For more information please see 1080# http://doc.trolltech.com/qthelpproject.html#custom-filters 1081 1082QHP_CUST_FILTER_NAME = 1083 1084# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the 1085# custom filter to add. For more information please see 1086# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters"> 1087# Qt Help Project / Custom Filters</a>. 1088 1089QHP_CUST_FILTER_ATTRS = 1090 1091# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this 1092# project's 1093# filter section matches. 1094# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes"> 1095# Qt Help Project / Filter Attributes</a>. 1096 1097QHP_SECT_FILTER_ATTRS = 1098 1099# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can 1100# be used to specify the location of Qt's qhelpgenerator. 1101# If non-empty doxygen will try to run qhelpgenerator on the generated 1102# .qhp file. 1103 1104QHG_LOCATION = 1105 1106# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files 1107# will be generated, which together with the HTML files, form an Eclipse help 1108# plugin. To install this plugin and make it available under the help contents 1109# menu in Eclipse, the contents of the directory containing the HTML and XML 1110# files needs to be copied into the plugins directory of eclipse. The name of 1111# the directory within the plugins directory should be the same as 1112# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before 1113# the help appears. 1114 1115GENERATE_ECLIPSEHELP = NO 1116 1117# A unique identifier for the eclipse help plugin. When installing the plugin 1118# the directory name containing the HTML and XML files should also have 1119# this name. 1120 1121ECLIPSE_DOC_ID = org.doxygen.Project 1122 1123# The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) 1124# at top of each HTML page. The value NO (the default) enables the index and 1125# the value YES disables it. Since the tabs have the same information as the 1126# navigation tree you can set this option to NO if you already set 1127# GENERATE_TREEVIEW to YES. 1128 1129DISABLE_INDEX = NO 1130 1131# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 1132# structure should be generated to display hierarchical information. 1133# If the tag value is set to YES, a side panel will be generated 1134# containing a tree-like index structure (just like the one that 1135# is generated for HTML Help). For this to work a browser that supports 1136# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). 1137# Windows users are probably better off using the HTML help feature. 1138# Since the tree basically has the same information as the tab index you 1139# could consider to set DISABLE_INDEX to NO when enabling this option. 1140 1141GENERATE_TREEVIEW = NO 1142 1143# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values 1144# (range [0,1..20]) that doxygen will group on one line in the generated HTML 1145# documentation. Note that a value of 0 will completely suppress the enum 1146# values from appearing in the overview section. 1147 1148ENUM_VALUES_PER_LINE = 4 1149 1150# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 1151# used to set the initial width (in pixels) of the frame in which the tree 1152# is shown. 1153 1154TREEVIEW_WIDTH = 250 1155 1156# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open 1157# links to external symbols imported via tag files in a separate window. 1158 1159EXT_LINKS_IN_WINDOW = NO 1160 1161# Use this tag to change the font size of Latex formulas included 1162# as images in the HTML documentation. The default is 10. Note that 1163# when you change the font size after a successful doxygen run you need 1164# to manually remove any form_*.png images from the HTML output directory 1165# to force them to be regenerated. 1166 1167FORMULA_FONTSIZE = 10 1168 1169# Use the FORMULA_TRANPARENT tag to determine whether or not the images 1170# generated for formulas are transparent PNGs. Transparent PNGs are 1171# not supported properly for IE 6.0, but are supported on all modern browsers. 1172# Note that when changing this option you need to delete any form_*.png files 1173# in the HTML output before the changes have effect. 1174 1175FORMULA_TRANSPARENT = YES 1176 1177# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax 1178# (see http://www.mathjax.org) which uses client side Javascript for the 1179# rendering instead of using prerendered bitmaps. Use this if you do not 1180# have LaTeX installed or if you want to formulas look prettier in the HTML 1181# output. When enabled you may also need to install MathJax separately and 1182# configure the path to it using the MATHJAX_RELPATH option. 1183 1184USE_MATHJAX = NO 1185 1186# When MathJax is enabled you need to specify the location relative to the 1187# HTML output directory using the MATHJAX_RELPATH option. The destination 1188# directory should contain the MathJax.js script. For instance, if the mathjax 1189# directory is located at the same level as the HTML output directory, then 1190# MATHJAX_RELPATH should be ../mathjax. The default value points to 1191# the MathJax Content Delivery Network so you can quickly see the result without 1192# installing MathJax. 1193# However, it is strongly recommended to install a local 1194# copy of MathJax from http://www.mathjax.org before deployment. 1195 1196MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest 1197 1198# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension 1199# names that should be enabled during MathJax rendering. 1200 1201MATHJAX_EXTENSIONS = 1202 1203# When the SEARCHENGINE tag is enabled doxygen will generate a search box 1204# for the HTML output. The underlying search engine uses javascript 1205# and DHTML and should work on any modern browser. Note that when using 1206# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets 1207# (GENERATE_DOCSET) there is already a search function so this one should 1208# typically be disabled. For large projects the javascript based search engine 1209# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. 1210 1211SEARCHENGINE = NO 1212 1213# When the SERVER_BASED_SEARCH tag is enabled the search engine will be 1214# implemented using a PHP enabled web server instead of at the web client 1215# using Javascript. Doxygen will generate the search PHP script and index 1216# file to put on the web server. The advantage of the server 1217# based approach is that it scales better to large projects and allows 1218# full text search. The disadvantages are that it is more difficult to setup 1219# and does not have live searching capabilities. 1220 1221SERVER_BASED_SEARCH = NO 1222 1223#--------------------------------------------------------------------------- 1224# configuration options related to the LaTeX output 1225#--------------------------------------------------------------------------- 1226 1227# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 1228# generate Latex output. 1229 1230GENERATE_LATEX = NO 1231 1232# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 1233# If a relative path is entered the value of OUTPUT_DIRECTORY will be 1234# put in front of it. If left blank `latex' will be used as the default path. 1235 1236LATEX_OUTPUT = latex 1237 1238# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 1239# invoked. If left blank `latex' will be used as the default command name. 1240# Note that when enabling USE_PDFLATEX this option is only used for 1241# generating bitmaps for formulas in the HTML output, but not in the 1242# Makefile that is written to the output directory. 1243 1244LATEX_CMD_NAME = latex 1245 1246# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 1247# generate index for LaTeX. If left blank `makeindex' will be used as the 1248# default command name. 1249 1250MAKEINDEX_CMD_NAME = makeindex 1251 1252# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 1253# LaTeX documents. This may be useful for small projects and may help to 1254# save some trees in general. 1255 1256COMPACT_LATEX = NO 1257 1258# The PAPER_TYPE tag can be used to set the paper type that is used 1259# by the printer. Possible values are: a4, letter, legal and 1260# executive. If left blank a4wide will be used. 1261 1262PAPER_TYPE = a4wide 1263 1264# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 1265# packages that should be included in the LaTeX output. 1266 1267EXTRA_PACKAGES = 1268 1269# The LATEX_HEADER tag can be used to specify a personal LaTeX header for 1270# the generated latex document. The header should contain everything until 1271# the first chapter. If it is left blank doxygen will generate a 1272# standard header. Notice: only use this tag if you know what you are doing! 1273 1274LATEX_HEADER = 1275 1276# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for 1277# the generated latex document. The footer should contain everything after 1278# the last chapter. If it is left blank doxygen will generate a 1279# standard footer. Notice: only use this tag if you know what you are doing! 1280 1281LATEX_FOOTER = 1282 1283# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 1284# is prepared for conversion to pdf (using ps2pdf). The pdf file will 1285# contain links (just like the HTML output) instead of page references 1286# This makes the output suitable for online browsing using a pdf viewer. 1287 1288PDF_HYPERLINKS = NO 1289 1290# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 1291# plain latex in the generated Makefile. Set this option to YES to get a 1292# higher quality PDF documentation. 1293 1294USE_PDFLATEX = NO 1295 1296# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 1297# command to the generated LaTeX files. This will instruct LaTeX to keep 1298# running if errors occur, instead of asking the user for help. 1299# This option is also used when generating formulas in HTML. 1300 1301LATEX_BATCHMODE = NO 1302 1303# If LATEX_HIDE_INDICES is set to YES then doxygen will not 1304# include the index chapters (such as File Index, Compound Index, etc.) 1305# in the output. 1306 1307LATEX_HIDE_INDICES = NO 1308 1309# If LATEX_SOURCE_CODE is set to YES then doxygen will include 1310# source code with syntax highlighting in the LaTeX output. 1311# Note that which sources are shown also depends on other settings 1312# such as SOURCE_BROWSER. 1313 1314LATEX_SOURCE_CODE = NO 1315 1316# The LATEX_BIB_STYLE tag can be used to specify the style to use for the 1317# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See 1318# http://en.wikipedia.org/wiki/BibTeX for more info. 1319 1320LATEX_BIB_STYLE = plain 1321 1322#--------------------------------------------------------------------------- 1323# configuration options related to the RTF output 1324#--------------------------------------------------------------------------- 1325 1326# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 1327# The RTF output is optimized for Word 97 and may not look very pretty with 1328# other RTF readers or editors. 1329 1330GENERATE_RTF = NO 1331 1332# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 1333# If a relative path is entered the value of OUTPUT_DIRECTORY will be 1334# put in front of it. If left blank `rtf' will be used as the default path. 1335 1336RTF_OUTPUT = rtf 1337 1338# If the COMPACT_RTF tag is set to YES Doxygen generates more compact 1339# RTF documents. This may be useful for small projects and may help to 1340# save some trees in general. 1341 1342COMPACT_RTF = NO 1343 1344# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 1345# will contain hyperlink fields. The RTF file will 1346# contain links (just like the HTML output) instead of page references. 1347# This makes the output suitable for online browsing using WORD or other 1348# programs which support those fields. 1349# Note: wordpad (write) and others do not support links. 1350 1351RTF_HYPERLINKS = NO 1352 1353# Load style sheet definitions from file. Syntax is similar to doxygen's 1354# config file, i.e. a series of assignments. You only have to provide 1355# replacements, missing definitions are set to their default value. 1356 1357RTF_STYLESHEET_FILE = 1358 1359# Set optional variables used in the generation of an rtf document. 1360# Syntax is similar to doxygen's config file. 1361 1362RTF_EXTENSIONS_FILE = 1363 1364#--------------------------------------------------------------------------- 1365# configuration options related to the man page output 1366#--------------------------------------------------------------------------- 1367 1368# If the GENERATE_MAN tag is set to YES (the default) Doxygen will 1369# generate man pages 1370 1371GENERATE_MAN = NO 1372 1373# The MAN_OUTPUT tag is used to specify where the man pages will be put. 1374# If a relative path is entered the value of OUTPUT_DIRECTORY will be 1375# put in front of it. If left blank `man' will be used as the default path. 1376 1377MAN_OUTPUT = man 1378 1379# The MAN_EXTENSION tag determines the extension that is added to 1380# the generated man pages (default is the subroutine's section .3) 1381 1382MAN_EXTENSION = .3 1383 1384# If the MAN_LINKS tag is set to YES and Doxygen generates man output, 1385# then it will generate one additional man file for each entity 1386# documented in the real man page(s). These additional files 1387# only source the real man page, but without them the man command 1388# would be unable to find the correct page. The default is NO. 1389 1390MAN_LINKS = NO 1391 1392#--------------------------------------------------------------------------- 1393# configuration options related to the XML output 1394#--------------------------------------------------------------------------- 1395 1396# If the GENERATE_XML tag is set to YES Doxygen will 1397# generate an XML file that captures the structure of 1398# the code including all documentation. 1399 1400GENERATE_XML = NO 1401 1402# The XML_OUTPUT tag is used to specify where the XML pages will be put. 1403# If a relative path is entered the value of OUTPUT_DIRECTORY will be 1404# put in front of it. If left blank `xml' will be used as the default path. 1405 1406XML_OUTPUT = xml 1407 1408# The XML_SCHEMA tag can be used to specify an XML schema, 1409# which can be used by a validating XML parser to check the 1410# syntax of the XML files. 1411 1412XML_SCHEMA = 1413 1414# The XML_DTD tag can be used to specify an XML DTD, 1415# which can be used by a validating XML parser to check the 1416# syntax of the XML files. 1417 1418XML_DTD = 1419 1420# If the XML_PROGRAMLISTING tag is set to YES Doxygen will 1421# dump the program listings (including syntax highlighting 1422# and cross-referencing information) to the XML output. Note that 1423# enabling this will significantly increase the size of the XML output. 1424 1425XML_PROGRAMLISTING = YES 1426 1427#--------------------------------------------------------------------------- 1428# configuration options for the AutoGen Definitions output 1429#--------------------------------------------------------------------------- 1430 1431# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 1432# generate an AutoGen Definitions (see autogen.sf.net) file 1433# that captures the structure of the code including all 1434# documentation. Note that this feature is still experimental 1435# and incomplete at the moment. 1436 1437GENERATE_AUTOGEN_DEF = NO 1438 1439#--------------------------------------------------------------------------- 1440# configuration options related to the Perl module output 1441#--------------------------------------------------------------------------- 1442 1443# If the GENERATE_PERLMOD tag is set to YES Doxygen will 1444# generate a Perl module file that captures the structure of 1445# the code including all documentation. Note that this 1446# feature is still experimental and incomplete at the 1447# moment. 1448 1449GENERATE_PERLMOD = NO 1450 1451# If the PERLMOD_LATEX tag is set to YES Doxygen will generate 1452# the necessary Makefile rules, Perl scripts and LaTeX code to be able 1453# to generate PDF and DVI output from the Perl module output. 1454 1455PERLMOD_LATEX = NO 1456 1457# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 1458# nicely formatted so it can be parsed by a human reader. 1459# This is useful 1460# if you want to understand what is going on. 1461# On the other hand, if this 1462# tag is set to NO the size of the Perl module output will be much smaller 1463# and Perl will parse it just the same. 1464 1465PERLMOD_PRETTY = YES 1466 1467# The names of the make variables in the generated doxyrules.make file 1468# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 1469# This is useful so different doxyrules.make files included by the same 1470# Makefile don't overwrite each other's variables. 1471 1472PERLMOD_MAKEVAR_PREFIX = 1473 1474#--------------------------------------------------------------------------- 1475# Configuration options related to the preprocessor 1476#--------------------------------------------------------------------------- 1477 1478# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 1479# evaluate all C-preprocessor directives found in the sources and include 1480# files. 1481 1482ENABLE_PREPROCESSING = YES 1483 1484# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 1485# names in the source code. If set to NO (the default) only conditional 1486# compilation will be performed. Macro expansion can be done in a controlled 1487# way by setting EXPAND_ONLY_PREDEF to YES. 1488 1489MACRO_EXPANSION = NO 1490 1491# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 1492# then the macro expansion is limited to the macros specified with the 1493# PREDEFINED and EXPAND_AS_DEFINED tags. 1494 1495EXPAND_ONLY_PREDEF = NO 1496 1497# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 1498# pointed to by INCLUDE_PATH will be searched when a #include is found. 1499 1500SEARCH_INCLUDES = YES 1501 1502# The INCLUDE_PATH tag can be used to specify one or more directories that 1503# contain include files that are not input files but should be processed by 1504# the preprocessor. 1505 1506INCLUDE_PATH = 1507 1508# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 1509# patterns (like *.h and *.hpp) to filter out the header-files in the 1510# directories. If left blank, the patterns specified with FILE_PATTERNS will 1511# be used. 1512 1513INCLUDE_FILE_PATTERNS = 1514 1515# The PREDEFINED tag can be used to specify one or more macro names that 1516# are defined before the preprocessor is started (similar to the -D option of 1517# gcc). The argument of the tag is a list of macros of the form: name 1518# or name=definition (no spaces). If the definition and the = are 1519# omitted =1 is assumed. To prevent a macro definition from being 1520# undefined via #undef or recursively expanded use the := operator 1521# instead of the = operator. 1522 1523PREDEFINED = 1524 1525# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 1526# this tag can be used to specify a list of macro names that should be expanded. 1527# The macro definition that is found in the sources will be used. 1528# Use the PREDEFINED tag if you want to use a different macro definition that 1529# overrules the definition found in the source code. 1530 1531EXPAND_AS_DEFINED = 1532 1533# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 1534# doxygen's preprocessor will remove all references to function-like macros 1535# that are alone on a line, have an all uppercase name, and do not end with a 1536# semicolon, because these will confuse the parser if not removed. 1537 1538SKIP_FUNCTION_MACROS = YES 1539 1540#--------------------------------------------------------------------------- 1541# Configuration::additions related to external references 1542#--------------------------------------------------------------------------- 1543 1544# The TAGFILES option can be used to specify one or more tagfiles. For each 1545# tag file the location of the external documentation should be added. The 1546# format of a tag file without this location is as follows: 1547# 1548# TAGFILES = file1 file2 ... 1549# Adding location for the tag files is done as follows: 1550# 1551# TAGFILES = file1=loc1 "file2 = loc2" ... 1552# where "loc1" and "loc2" can be relative or absolute paths 1553# or URLs. Note that each tag file must have a unique name (where the name does 1554# NOT include the path). If a tag file is not located in the directory in which 1555# doxygen is run, you must also specify the path to the tagfile here. 1556 1557TAGFILES = 1558 1559# When a file name is specified after GENERATE_TAGFILE, doxygen will create 1560# a tag file that is based on the input files it reads. 1561 1562GENERATE_TAGFILE = 1563 1564# If the ALLEXTERNALS tag is set to YES all external classes will be listed 1565# in the class index. If set to NO only the inherited external classes 1566# will be listed. 1567 1568ALLEXTERNALS = NO 1569 1570# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 1571# in the modules index. If set to NO, only the current project's groups will 1572# be listed. 1573 1574EXTERNAL_GROUPS = YES 1575 1576# The PERL_PATH should be the absolute path and name of the perl script 1577# interpreter (i.e. the result of `which perl'). 1578 1579PERL_PATH = /usr/bin/perl 1580 1581#--------------------------------------------------------------------------- 1582# Configuration options related to the dot tool 1583#--------------------------------------------------------------------------- 1584 1585# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 1586# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base 1587# or super classes. Setting the tag to NO turns the diagrams off. Note that 1588# this option also works with HAVE_DOT disabled, but it is recommended to 1589# install and use dot, since it yields more powerful graphs. 1590 1591CLASS_DIAGRAMS = YES 1592 1593# You can define message sequence charts within doxygen comments using the \msc 1594# command. Doxygen will then run the mscgen tool (see 1595# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the 1596# documentation. The MSCGEN_PATH tag allows you to specify the directory where 1597# the mscgen tool resides. If left empty the tool is assumed to be found in the 1598# default search path. 1599 1600MSCGEN_PATH = 1601 1602# If set to YES, the inheritance and collaboration graphs will hide 1603# inheritance and usage relations if the target is undocumented 1604# or is not a class. 1605 1606HIDE_UNDOC_RELATIONS = YES 1607 1608# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 1609# available from the path. This tool is part of Graphviz, a graph visualization 1610# toolkit from AT&T and Lucent Bell Labs. The other options in this section 1611# have no effect if this option is set to NO (the default) 1612 1613HAVE_DOT = NO 1614 1615# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is 1616# allowed to run in parallel. When set to 0 (the default) doxygen will 1617# base this on the number of processors available in the system. You can set it 1618# explicitly to a value larger than 0 to get control over the balance 1619# between CPU load and processing speed. 1620 1621DOT_NUM_THREADS = 0 1622 1623# By default doxygen will use the Helvetica font for all dot files that 1624# doxygen generates. When you want a differently looking font you can specify 1625# the font name using DOT_FONTNAME. You need to make sure dot is able to find 1626# the font, which can be done by putting it in a standard location or by setting 1627# the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the 1628# directory containing the font. 1629 1630DOT_FONTNAME = FreeSans 1631 1632# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. 1633# The default size is 10pt. 1634 1635DOT_FONTSIZE = 10 1636 1637# By default doxygen will tell dot to use the Helvetica font. 1638# If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to 1639# set the path where dot can find it. 1640 1641DOT_FONTPATH = 1642 1643# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 1644# will generate a graph for each documented class showing the direct and 1645# indirect inheritance relations. Setting this tag to YES will force the 1646# CLASS_DIAGRAMS tag to NO. 1647 1648CLASS_GRAPH = YES 1649 1650# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 1651# will generate a graph for each documented class showing the direct and 1652# indirect implementation dependencies (inheritance, containment, and 1653# class references variables) of the class with other documented classes. 1654 1655COLLABORATION_GRAPH = YES 1656 1657# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen 1658# will generate a graph for groups, showing the direct groups dependencies 1659 1660GROUP_GRAPHS = YES 1661 1662# If the UML_LOOK tag is set to YES doxygen will generate inheritance and 1663# collaboration diagrams in a style similar to the OMG's Unified Modeling 1664# Language. 1665 1666UML_LOOK = NO 1667 1668# If the UML_LOOK tag is enabled, the fields and methods are shown inside 1669# the class node. If there are many fields or methods and many nodes the 1670# graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS 1671# threshold limits the number of items for each type to make the size more 1672# manageable. Set this to 0 for no limit. Note that the threshold may be 1673# exceeded by 50% before the limit is enforced. 1674 1675UML_LIMIT_NUM_FIELDS = 10 1676 1677# If set to YES, the inheritance and collaboration graphs will show the 1678# relations between templates and their instances. 1679 1680TEMPLATE_RELATIONS = NO 1681 1682# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 1683# tags are set to YES then doxygen will generate a graph for each documented 1684# file showing the direct and indirect include dependencies of the file with 1685# other documented files. 1686 1687INCLUDE_GRAPH = YES 1688 1689# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 1690# HAVE_DOT tags are set to YES then doxygen will generate a graph for each 1691# documented header file showing the documented files that directly or 1692# indirectly include this file. 1693 1694INCLUDED_BY_GRAPH = YES 1695 1696# If the CALL_GRAPH and HAVE_DOT options are set to YES then 1697# doxygen will generate a call dependency graph for every global function 1698# or class method. Note that enabling this option will significantly increase 1699# the time of a run. So in most cases it will be better to enable call graphs 1700# for selected functions only using the \callgraph command. 1701 1702CALL_GRAPH = NO 1703 1704# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then 1705# doxygen will generate a caller dependency graph for every global function 1706# or class method. Note that enabling this option will significantly increase 1707# the time of a run. So in most cases it will be better to enable caller 1708# graphs for selected functions only using the \callergraph command. 1709 1710CALLER_GRAPH = NO 1711 1712# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 1713# will generate a graphical hierarchy of all classes instead of a textual one. 1714 1715GRAPHICAL_HIERARCHY = YES 1716 1717# If the DIRECTORY_GRAPH and HAVE_DOT tags are set to YES 1718# then doxygen will show the dependencies a directory has on other directories 1719# in a graphical way. The dependency relations are determined by the #include 1720# relations between the files in the directories. 1721 1722DIRECTORY_GRAPH = YES 1723 1724# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 1725# generated by dot. Possible values are svg, png, jpg, or gif. 1726# If left blank png will be used. If you choose svg you need to set 1727# HTML_FILE_EXTENSION to xhtml in order to make the SVG files 1728# visible in IE 9+ (other browsers do not have this requirement). 1729 1730DOT_IMAGE_FORMAT = png 1731 1732# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to 1733# enable generation of interactive SVG images that allow zooming and panning. 1734# Note that this requires a modern browser other than Internet Explorer. 1735# Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you 1736# need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files 1737# visible. Older versions of IE do not have SVG support. 1738 1739INTERACTIVE_SVG = NO 1740 1741# The tag DOT_PATH can be used to specify the path where the dot tool can be 1742# found. If left blank, it is assumed the dot tool can be found in the path. 1743 1744DOT_PATH = 1745 1746# The DOTFILE_DIRS tag can be used to specify one or more directories that 1747# contain dot files that are included in the documentation (see the 1748# \dotfile command). 1749 1750DOTFILE_DIRS = 1751 1752# The MSCFILE_DIRS tag can be used to specify one or more directories that 1753# contain msc files that are included in the documentation (see the 1754# \mscfile command). 1755 1756MSCFILE_DIRS = 1757 1758# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of 1759# nodes that will be shown in the graph. If the number of nodes in a graph 1760# becomes larger than this value, doxygen will truncate the graph, which is 1761# visualized by representing a node as a red box. Note that doxygen if the 1762# number of direct children of the root node in a graph is already larger than 1763# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note 1764# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. 1765 1766DOT_GRAPH_MAX_NODES = 50 1767 1768# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 1769# graphs generated by dot. A depth value of 3 means that only nodes reachable 1770# from the root by following a path via at most 3 edges will be shown. Nodes 1771# that lay further from the root node will be omitted. Note that setting this 1772# option to 1 or 2 may greatly reduce the computation time needed for large 1773# code bases. Also note that the size of a graph can be further restricted by 1774# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. 1775 1776MAX_DOT_GRAPH_DEPTH = 1000 1777 1778# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 1779# background. This is disabled by default, because dot on Windows does not 1780# seem to support this out of the box. Warning: Depending on the platform used, 1781# enabling this option may lead to badly anti-aliased labels on the edges of 1782# a graph (i.e. they become hard to read). 1783 1784DOT_TRANSPARENT = NO 1785 1786# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output 1787# files in one run (i.e. multiple -o and -T options on the command line). This 1788# makes dot run faster, but since only newer versions of dot (>1.8.10) 1789# support this, this feature is disabled by default. 1790 1791DOT_MULTI_TARGETS = NO 1792 1793# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 1794# generate a legend page explaining the meaning of the various boxes and 1795# arrows in the dot generated graphs. 1796 1797GENERATE_LEGEND = YES 1798 1799# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 1800# remove the intermediate dot files that are used to generate 1801# the various graphs. 1802 1803DOT_CLEANUP = YES 1804
