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