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