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