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