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