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