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