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