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