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