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