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