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