# source:XIOS/trunk/Doxyfile@1533

Last change on this file since 1533 was 1140, checked in by yushan, 4 years ago

test_remap back to work

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