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