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