| Doxyfile (9264:1607119c36bb) | Doxyfile (9277:25c6a7bab5af) |
|---|---|
| 1# Doxyfile 1.3.6 | 1# Doxyfile 1.6.3 |
| 2 3# This file describes the settings to be used by the documentation system 4# doxygen (www.doxygen.org) for a project 5# 6# All text after a hash (#) is considered a comment and will be ignored 7# The format is: 8# TAG = value [value, ...] 9# For lists items can also be appended using: 10# TAG += value [value, ...] 11# Values that contain spaces should be placed between quotes (" ") 12 13#--------------------------------------------------------------------------- 14# Project related configuration options 15#--------------------------------------------------------------------------- 16 | 2 3# This file describes the settings to be used by the documentation system 4# doxygen (www.doxygen.org) for a project 5# 6# All text after a hash (#) is considered a comment and will be ignored 7# The format is: 8# TAG = value [value, ...] 9# For lists items can also be appended using: 10# TAG += value [value, ...] 11# Values that contain spaces should be placed between quotes (" ") 12 13#--------------------------------------------------------------------------- 14# Project related configuration options 15#--------------------------------------------------------------------------- 16 |
| 17# This tag specifies the encoding used for all characters in the config file 18# that follow. The default is UTF-8 which is also the encoding used for all 19# text before the first occurrence of this tag. Doxygen uses libiconv (or the 20# iconv built into libc) for the transcoding. See 21# http://www.gnu.org/software/libiconv for the list of possible encodings. 22 23DOXYFILE_ENCODING = UTF-8 24 |
|
| 17# The PROJECT_NAME tag is a single word (or a sequence of words surrounded 18# by quotes) that should identify the project. 19 | 25# The PROJECT_NAME tag is a single word (or a sequence of words surrounded 26# by quotes) that should identify the project. 27 |
| 20PROJECT_NAME = M5 | 28PROJECT_NAME = gem5 |
| 21 22# The PROJECT_NUMBER tag can be used to enter a project or revision number. 23# This could be handy for archiving the generated documentation or 24# if some version control system is used. 25 26PROJECT_NUMBER = 27 28# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 29# base path where the generated documentation will be put. 30# If a relative path is entered, it will be relative to the location 31# where doxygen was started. If left blank the current directory will be used. 32 33OUTPUT_DIRECTORY = doxygen 34 | 29 30# The PROJECT_NUMBER tag can be used to enter a project or revision number. 31# This could be handy for archiving the generated documentation or 32# if some version control system is used. 33 34PROJECT_NUMBER = 35 36# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 37# base path where the generated documentation will be put. 38# If a relative path is entered, it will be relative to the location 39# where doxygen was started. If left blank the current directory will be used. 40 41OUTPUT_DIRECTORY = doxygen 42 |
| 43# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 44# 4096 sub-directories (in 2 levels) under the output directory of each output 45# format and will distribute the generated files over these directories. 46# Enabling this option can be useful when feeding doxygen a huge amount of 47# source files, where putting all generated files in the same directory would 48# otherwise cause performance problems for the file system. 49 50CREATE_SUBDIRS = NO 51 |
|
| 35# The OUTPUT_LANGUAGE tag is used to specify the language in which all 36# documentation generated by doxygen is written. Doxygen will use this 37# information to generate all constant output in the proper language. 38# The default language is English, other supported languages are: 39# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, 40# Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en 41# (Japanese with English messages), Korean, Korean-en, Norwegian, Polish, Portuguese, 42# Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian. 43 44OUTPUT_LANGUAGE = English 45 | 52# The OUTPUT_LANGUAGE tag is used to specify the language in which all 53# documentation generated by doxygen is written. Doxygen will use this 54# information to generate all constant output in the proper language. 55# The default language is English, other supported languages are: 56# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, 57# Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en 58# (Japanese with English messages), Korean, Korean-en, Norwegian, Polish, Portuguese, 59# Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian. 60 61OUTPUT_LANGUAGE = English 62 |
| 46# This tag can be used to specify the encoding used in the generated output. 47# The encoding is not always determined by the language that is chosen, 48# but also whether or not the output is meant for Windows or non-Windows users. 49# In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES 50# forces the Windows encoding (this is the default for the Windows binary), 51# whereas setting the tag to NO uses a Unix-style encoding (the default for 52# all platforms other than Windows). 53 54USE_WINDOWS_ENCODING = NO 55 | |
| 56# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 57# include brief member descriptions after the members that are listed in 58# the file and class documentation (similar to JavaDoc). 59# Set to NO to disable this. 60 61BRIEF_MEMBER_DESC = YES 62 | 63# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 64# include brief member descriptions after the members that are listed in 65# the file and class documentation (similar to JavaDoc). 66# Set to NO to disable this. 67 68BRIEF_MEMBER_DESC = YES 69 |
| 63# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 64# the brief description of a member or function before the detailed description. 65# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the | 70# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 71# the brief description of a member or function before the detailed description. 72# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the |
| 66# brief descriptions will be completely suppressed. 67 68REPEAT_BRIEF = YES 69 | 73# brief descriptions will be completely suppressed. 74 75REPEAT_BRIEF = YES 76 |
| 70# This tag implements a quasi-intelligent brief description abbreviator 71# that is used to form the text in various listings. Each string 72# in this list, if found as the leading text of the brief description, will be 73# stripped from the text and the result after processing the whole list, is used 74# as the annotated text. Otherwise, the brief description is used as-is. If left 75# blank, the following values are used ("$name" is automatically replaced with the 76# name of the entity): "The $name class" "The $name widget" "The $name file" 77# "is" "provides" "specifies" "contains" "represents" "a" "an" "the" | 77# This tag implements a quasi-intelligent brief description abbreviator 78# that is used to form the text in various listings. Each string 79# in this list, if found as the leading text of the brief description, will be 80# stripped from the text and the result after processing the whole list, is 81# used as the annotated text. Otherwise, the brief description is used as-is. 82# If left blank, the following values are used ("$name" is automatically 83# replaced with the name of the entity): "The $name class" "The $name widget" 84# "The $name file" "is" "provides" "specifies" "contains" 85# "represents" "a" "an" "the" |
| 78 | 86 |
| 79ABBREVIATE_BRIEF = | 87ABBREVIATE_BRIEF = |
| 80 81# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 82# Doxygen will generate a detailed section even if there is only a brief 83# description. 84 85ALWAYS_DETAILED_SEC = YES 86 | 88 89# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 90# Doxygen will generate a detailed section even if there is only a brief 91# description. 92 93ALWAYS_DETAILED_SEC = YES 94 |
| 87# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited 88# members of a class in the documentation of that class as if those members were 89# ordinary class members. Constructors, destructors and assignment operators of 90# the base classes will not be shown. | 95# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 96# inherited members of a class in the documentation of that class as if those 97# members were ordinary class members. Constructors, destructors and assignment 98# operators of the base classes will not be shown. |
| 91 92INLINE_INHERITED_MEMB = NO 93 94# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 95# path before files name in the file list and in the header files. If set 96# to NO the shortest path that makes the file name unique will be used. 97 98FULL_PATH_NAMES = YES 99 100# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 101# can be used to strip a user-defined part of the path. Stripping is 102# only done if one of the specified strings matches the left-hand part of 103# the path. It is allowed to use relative paths in the argument list. 104# If left blank the directory from which doxygen is run is used as the 105# path to strip. 106 107STRIP_FROM_PATH = . 108 | 99 100INLINE_INHERITED_MEMB = NO 101 102# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 103# path before files name in the file list and in the header files. If set 104# to NO the shortest path that makes the file name unique will be used. 105 106FULL_PATH_NAMES = YES 107 108# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 109# can be used to strip a user-defined part of the path. Stripping is 110# only done if one of the specified strings matches the left-hand part of 111# the path. It is allowed to use relative paths in the argument list. 112# If left blank the directory from which doxygen is run is used as the 113# path to strip. 114 115STRIP_FROM_PATH = . 116 |
| 117# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 118# the path mentioned in the documentation of a class, which tells 119# the reader which header file to include in order to use a class. 120# If left blank only the name of the header file containing the class 121# definition is used. Otherwise one should specify the include paths that 122# are normally passed to the compiler using the -I flag. 123 124STRIP_FROM_INC_PATH = 125 |
|
| 109# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 110# (but less readable) file names. This can be useful is your file systems 111# doesn't support long names like on DOS, Mac, or CD-ROM. 112 113SHORT_NAMES = NO 114 115# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 116# will interpret the first line (until the first dot) of a JavaDoc-style 117# comment as the brief description. If set to NO, the JavaDoc 118# comments will behave just like the Qt-style comments (thus requiring an 119# explicit @brief command for a brief description. 120 121JAVADOC_AUTOBRIEF = YES 122 | 126# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 127# (but less readable) file names. This can be useful is your file systems 128# doesn't support long names like on DOS, Mac, or CD-ROM. 129 130SHORT_NAMES = NO 131 132# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 133# will interpret the first line (until the first dot) of a JavaDoc-style 134# comment as the brief description. If set to NO, the JavaDoc 135# comments will behave just like the Qt-style comments (thus requiring an 136# explicit @brief command for a brief description. 137 138JAVADOC_AUTOBRIEF = YES 139 |
| 140# If the QT_AUTOBRIEF tag is set to YES then Doxygen will 141# interpret the first line (until the first dot) of a Qt-style 142# comment as the brief description. If set to NO, the comments 143# will behave just like regular Qt-style comments (thus requiring 144# an explicit \brief command for a brief description.) 145 146QT_AUTOBRIEF = YES 147 |
|
| 123# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 124# treat a multi-line C++ special comment block (i.e. a block of //! or /// 125# comments) as a brief description. This used to be the default behaviour. 126# The new default is to treat a multi-line C++ comment block as a detailed 127# description. Set this tag to YES if you prefer the old behaviour instead. 128 129MULTILINE_CPP_IS_BRIEF = NO 130 | 148# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 149# treat a multi-line C++ special comment block (i.e. a block of //! or /// 150# comments) as a brief description. This used to be the default behaviour. 151# The new default is to treat a multi-line C++ comment block as a detailed 152# description. Set this tag to YES if you prefer the old behaviour instead. 153 154MULTILINE_CPP_IS_BRIEF = NO 155 |
| 131# If the DETAILS_AT_TOP tag is set to YES then Doxygen 132# will output the detailed description near the top, like JavaDoc. 133# If set to NO, the detailed description appears after the member 134# documentation. 135 136DETAILS_AT_TOP = NO 137 | |
| 138# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 139# member inherits the documentation from any documented member that it 140# re-implements. 141 142INHERIT_DOCS = YES 143 144# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 145# tag is set to YES, then doxygen will reuse the documentation of the first --- 18 unchanged lines hidden (view full) --- 164 165# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources 166# only. Doxygen will then generate output that is more tailored for C. 167# For instance, some of the names that are used will be different. The list 168# of all members will be omitted, etc. 169 170OPTIMIZE_OUTPUT_FOR_C = NO 171 | 156# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 157# member inherits the documentation from any documented member that it 158# re-implements. 159 160INHERIT_DOCS = YES 161 162# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 163# tag is set to YES, then doxygen will reuse the documentation of the first --- 18 unchanged lines hidden (view full) --- 182 183# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources 184# only. Doxygen will then generate output that is more tailored for C. 185# For instance, some of the names that are used will be different. The list 186# of all members will be omitted, etc. 187 188OPTIMIZE_OUTPUT_FOR_C = NO 189 |
| 172# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources 173# only. Doxygen will then generate output that is more tailored for Java. 174# For instance, namespaces will be presented as packages, qualified scopes 175# will look different, etc. | 190# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java 191# sources only. Doxygen will then generate output that is more tailored for 192# Java. For instance, namespaces will be presented as packages, qualified 193# scopes will look different, etc. |
| 176 177OPTIMIZE_OUTPUT_JAVA = NO 178 | 194 195OPTIMIZE_OUTPUT_JAVA = NO 196 |
| 197# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 198# sources only. Doxygen will then generate output that is more tailored for 199# Fortran. 200 201OPTIMIZE_FOR_FORTRAN = NO 202 203# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 204# sources. Doxygen will then generate output that is tailored for 205# VHDL. 206 207OPTIMIZE_OUTPUT_VHDL = NO 208 209# Doxygen selects the parser to use depending on the extension of the files it parses. 210# With this tag you can assign which parser to use for a given extension. 211# Doxygen has a built-in mapping, but you can override or extend it using this tag. 212# The format is ext=language, where ext is a file extension, and language is one of 213# the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP, 214# Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat 215# .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran), 216# use: inc=Fortran f=C. Note that for custom extensions you also need to set FILE_PATTERNS otherwise the files are not read by doxygen. 217 218EXTENSION_MAPPING = 219 220# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 221# to include (a tag file for) the STL sources as input, then you should 222# set this tag to YES in order to let doxygen match functions declarations and 223# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. 224# func(std::string) {}). This also make the inheritance and collaboration 225# diagrams that involve STL classes more complete and accurate. 226 227BUILTIN_STL_SUPPORT = NO 228 229# If you use Microsoft's C++/CLI language, you should set this option to YES to 230# enable parsing support. 231 232CPP_CLI_SUPPORT = NO 233 234# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. 235# Doxygen will parse them like normal C++ but will assume all classes use public 236# instead of private inheritance when no explicit protection keyword is present. 237 238SIP_SUPPORT = NO 239 240# For Microsoft's IDL there are propget and propput attributes to indicate getter 241# and setter methods for a property. Setting this option to YES (the default) 242# will make doxygen to replace the get and set methods by a property in the 243# documentation. This will only work if the methods are indeed getting or 244# setting a simple type. If this is not the case, or you want to show the 245# methods anyway, you should set this option to NO. 246 247IDL_PROPERTY_SUPPORT = YES 248 249# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 250# tag is set to YES, then doxygen will reuse the documentation of the first 251# member in the group (if any) for the other members of the group. By default 252# all members of a group must be documented explicitly. 253 254DISTRIBUTE_GROUP_DOC = NO 255 |
|
| 179# Set the SUBGROUPING tag to YES (the default) to allow class member groups of 180# the same type (for instance a group of public functions) to be put as a 181# subgroup of that type (e.g. under the Public Functions section). Set it to 182# NO to prevent subgrouping. Alternatively, this can be done per class using 183# the \nosubgrouping command. 184 185SUBGROUPING = YES 186 | 256# Set the SUBGROUPING tag to YES (the default) to allow class member groups of 257# the same type (for instance a group of public functions) to be put as a 258# subgroup of that type (e.g. under the Public Functions section). Set it to 259# NO to prevent subgrouping. Alternatively, this can be done per class using 260# the \nosubgrouping command. 261 262SUBGROUPING = YES 263 |
| 264 265# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum 266# is documented as struct, union, or enum with the name of the typedef. So 267# typedef struct TypeS {} TypeT, will appear in the documentation as a struct 268# with name TypeT. When disabled the typedef will appear as a member of a file, 269# namespace, or class. And the struct will be named TypeS. This can typically 270# be useful for C code in case the coding convention dictates that all compound 271# types are typedef'ed and only the typedef is referenced, never the tag name. 272 273TYPEDEF_HIDES_STRUCT = NO 274 275# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to 276# determine which symbols to keep in memory and which to flush to disk. 277# When the cache is full, less often used symbols will be written to disk. 278# For small to medium size projects (<1000 input files) the default value is 279# probably good enough. For larger projects a too small cache size can cause 280# doxygen to be busy swapping symbols to and from disk most of the time 281# causing a significant performance penality. 282# If the system has enough physical memory increasing the cache will improve the 283# performance by keeping more symbols in memory. Note that the value works on 284# a logarithmic scale so increasing the size by one will rougly double the 285# memory usage. The cache size is given by this formula: 286# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, 287# corresponding to a cache size of 2^16 = 65536 symbols 288 289SYMBOL_CACHE_SIZE = 0 290 |
|
| 187#--------------------------------------------------------------------------- 188# Build related configuration options 189#--------------------------------------------------------------------------- 190 191# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 192# documentation are documented, even if no documentation was available. 193# Private class members and static file members will be hidden unless 194# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES --- 11 unchanged lines hidden (view full) --- 206EXTRACT_STATIC = YES 207 208# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 209# defined locally in source files will be included in the documentation. 210# If set to NO only classes defined in header files are included. 211 212EXTRACT_LOCAL_CLASSES = YES 213 | 291#--------------------------------------------------------------------------- 292# Build related configuration options 293#--------------------------------------------------------------------------- 294 295# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 296# documentation are documented, even if no documentation was available. 297# Private class members and static file members will be hidden unless 298# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES --- 11 unchanged lines hidden (view full) --- 310EXTRACT_STATIC = YES 311 312# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 313# defined locally in source files will be included in the documentation. 314# If set to NO only classes defined in header files are included. 315 316EXTRACT_LOCAL_CLASSES = YES 317 |
| 318# This flag is only useful for Objective-C code. When set to YES local 319# methods, which are defined in the implementation section but not in 320# the interface are included in the documentation. 321# If set to NO (the default) only methods in the interface are included. 322 323EXTRACT_LOCAL_METHODS = NO 324 325# If this flag is set to YES, the members of anonymous namespaces will be 326# extracted and appear in the documentation as a namespace called 327# 'anonymous_namespace{file}', where file will be replaced with the base 328# name of the file that contains the anonymous namespace. By default 329# anonymous namespace are hidden. 330 331EXTRACT_ANON_NSPACES = NO 332 |
|
| 214# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 215# undocumented members of documented classes, files or namespaces. 216# If set to NO (the default) these members will be included in the 217# various overviews, but no documentation section is generated. 218# This option has no effect if EXTRACT_ALL is enabled. 219 220HIDE_UNDOC_MEMBERS = NO 221 --- 59 unchanged lines hidden (view full) --- 281 282# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 283# brief documentation of file, namespace and class members alphabetically 284# by member name. If set to NO (the default) the members will appear in 285# declaration order. 286 287SORT_BRIEF_DOCS = NO 288 | 333# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 334# undocumented members of documented classes, files or namespaces. 335# If set to NO (the default) these members will be included in the 336# various overviews, but no documentation section is generated. 337# This option has no effect if EXTRACT_ALL is enabled. 338 339HIDE_UNDOC_MEMBERS = NO 340 --- 59 unchanged lines hidden (view full) --- 400 401# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 402# brief documentation of file, namespace and class members alphabetically 403# by member name. If set to NO (the default) the members will appear in 404# declaration order. 405 406SORT_BRIEF_DOCS = NO 407 |
| 408# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the (brief and detailed) documentation of class members so that constructors and destructors are listed first. If set to NO (the default) the constructors will appear in the respective orders defined by SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. 409 410SORT_MEMBERS_CTORS_1ST = NO 411 412# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the 413# hierarchy of group names into alphabetical order. If set to NO (the default) 414# the group names will appear in their defined order. 415 416SORT_GROUP_NAMES = NO 417 |
|
| 289# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 290# sorted by fully-qualified names, including namespaces. If set to 291# NO (the default), the class list will be sorted only by class name, 292# not including the namespace part. 293# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 294# Note: This option applies only to the class list, not to the 295# alphabetical list. 296 --- 39 unchanged lines hidden (view full) --- 336MAX_INITIALIZER_LINES = 30 337 338# Set the SHOW_USED_FILES tag to NO to disable the list of files generated 339# at the bottom of the documentation of classes and structs. If set to YES the 340# list will mention the files that were used to generate the documentation. 341 342SHOW_USED_FILES = YES 343 | 418# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 419# sorted by fully-qualified names, including namespaces. If set to 420# NO (the default), the class list will be sorted only by class name, 421# not including the namespace part. 422# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 423# Note: This option applies only to the class list, not to the 424# alphabetical list. 425 --- 39 unchanged lines hidden (view full) --- 465MAX_INITIALIZER_LINES = 30 466 467# Set the SHOW_USED_FILES tag to NO to disable the list of files generated 468# at the bottom of the documentation of classes and structs. If set to YES the 469# list will mention the files that were used to generate the documentation. 470 471SHOW_USED_FILES = YES 472 |
| 473# If the sources in your project are distributed over multiple directories 474# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy 475# in the documentation. The default is NO. 476 477SHOW_DIRECTORIES = NO 478 479# Set the SHOW_FILES tag to NO to disable the generation of the Files page. 480# This will remove the Files entry from the Quick Index and from the 481# Folder Tree View (if specified). The default is YES. 482 483SHOW_FILES = YES 484 485# Set the SHOW_NAMESPACES tag to NO to disable the generation of the 486# Namespaces page. 487# This will remove the Namespaces entry from the Quick Index 488# and from the Folder Tree View (if specified). The default is YES. 489 490SHOW_NAMESPACES = YES 491 492# The FILE_VERSION_FILTER tag can be used to specify a program or script that 493# doxygen should invoke to get the current version for each file (typically from 494# the version control system). Doxygen will invoke the program by executing (via 495# popen()) the command <command> <input-file>, where <command> is the value of 496# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file 497# provided by doxygen. Whatever the program writes to standard output 498# is used as the file version. See the manual for examples. 499 500FILE_VERSION_FILTER = 501 502# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by 503# doxygen. The layout file controls the global structure of the generated output files 504# in an output format independent way. The create the layout file that represents 505# doxygen's defaults, run doxygen with the -l option. You can optionally specify a 506# file name after the option, if omitted DoxygenLayout.xml will be used as the name 507# of the layout file. 508 509LAYOUT_FILE = 510 511 |
|
| 344#--------------------------------------------------------------------------- 345# configuration options related to warning and progress messages 346#--------------------------------------------------------------------------- 347 348# The QUIET tag can be used to turn on/off the messages that are generated 349# by doxygen. Possible values are YES and NO. If left blank NO is used. 350 351QUIET = YES --- 12 unchanged lines hidden (view full) --- 364 365# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 366# potential errors in the documentation, such as not documenting some 367# parameters in a documented function, or documenting parameters that 368# don't exist or using markup commands wrongly. 369 370WARN_IF_DOC_ERROR = YES 371 | 512#--------------------------------------------------------------------------- 513# configuration options related to warning and progress messages 514#--------------------------------------------------------------------------- 515 516# The QUIET tag can be used to turn on/off the messages that are generated 517# by doxygen. Possible values are YES and NO. If left blank NO is used. 518 519QUIET = YES --- 12 unchanged lines hidden (view full) --- 532 533# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 534# potential errors in the documentation, such as not documenting some 535# parameters in a documented function, or documenting parameters that 536# don't exist or using markup commands wrongly. 537 538WARN_IF_DOC_ERROR = YES 539 |
| 540# This WARN_NO_PARAMDOC option can be abled to get warnings for 541# functions that are documented, but have no documentation for their parameters 542# or return value. If set to NO (the default) doxygen will only warn about 543# wrong or incomplete parameter documentation, but not about the absence of 544# documentation. 545 546WARN_NO_PARAMDOC = NO 547 |
|
| 372# The WARN_FORMAT tag determines the format of the warning messages that 373# doxygen can produce. The string should contain the $file, $line, and $text 374# tags, which will be replaced by the file and line number from which the 375# warning originated and the warning text. 376 377WARN_FORMAT = "$file:$line: $text" 378 379# The WARN_LOGFILE tag can be used to specify a file to which warning --- 8 unchanged lines hidden (view full) --- 388 389# The INPUT tag can be used to specify the files and/or directories that contain 390# documented source files. You may enter file names like "myfile.cpp" or 391# directories like "/usr/src/myproject". Separate the files or directories 392# with spaces. 393 394INPUT = . 395 | 548# The WARN_FORMAT tag determines the format of the warning messages that 549# doxygen can produce. The string should contain the $file, $line, and $text 550# tags, which will be replaced by the file and line number from which the 551# warning originated and the warning text. 552 553WARN_FORMAT = "$file:$line: $text" 554 555# The WARN_LOGFILE tag can be used to specify a file to which warning --- 8 unchanged lines hidden (view full) --- 564 565# The INPUT tag can be used to specify the files and/or directories that contain 566# documented source files. You may enter file names like "myfile.cpp" or 567# directories like "/usr/src/myproject". Separate the files or directories 568# with spaces. 569 570INPUT = . 571 |
| 572# This tag can be used to specify the character encoding of the source files 573# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is 574# also the default input encoding. Doxygen uses libiconv (or the iconv built 575# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for 576# the list of possible encodings. 577 578INPUT_ENCODING = UTF-8 579 |
|
| 396# If the value of the INPUT tag contains directories, you can use the 397# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 398# and *.h) to filter out the source-files in the directories. If left 399# blank the following patterns are tested: 400# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp 401# *.h++ *.idl *.odl *.cs *.php *.php3 *.inc 402 403FILE_PATTERNS = *.c \ --- 26 unchanged lines hidden (view full) --- 430# If the value of the INPUT tag contains directories, you can use the 431# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 432# certain files from those directories. 433 434EXCLUDE_PATTERNS = */BitKeeper/* \ 435 */Attic/* \ 436 */SCCS/* 437 | 580# If the value of the INPUT tag contains directories, you can use the 581# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 582# and *.h) to filter out the source-files in the directories. If left 583# blank the following patterns are tested: 584# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp 585# *.h++ *.idl *.odl *.cs *.php *.php3 *.inc 586 587FILE_PATTERNS = *.c \ --- 26 unchanged lines hidden (view full) --- 614# If the value of the INPUT tag contains directories, you can use the 615# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 616# certain files from those directories. 617 618EXCLUDE_PATTERNS = */BitKeeper/* \ 619 */Attic/* \ 620 */SCCS/* 621 |
| 622# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 623# (namespaces, classes, functions, etc.) that should be excluded from the 624# output. The symbol name can be a fully qualified name, a word, or if the 625# wildcard * is used, a substring. Examples: ANamespace, AClass, 626# AClass::ANamespace, ANamespace::*Test 627 628EXCLUDE_SYMBOLS = 629 |
|
| 438# The EXAMPLE_PATH tag can be used to specify one or more files or 439# directories that contain example code fragments that are included (see 440# the \include command). 441 442EXAMPLE_PATH = 443 444# If the value of the EXAMPLE_PATH tag contains directories, you can use the 445# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp --- 19 unchanged lines hidden (view full) --- 465# invoke to filter for each input file. Doxygen will invoke the filter program 466# by executing (via popen()) the command <filter> <input-file>, where <filter> 467# is the value of the INPUT_FILTER tag, and <input-file> is the name of an 468# input file. Doxygen will then use the output that the filter program writes 469# to standard output. 470 471INPUT_FILTER = 472 | 630# The EXAMPLE_PATH tag can be used to specify one or more files or 631# directories that contain example code fragments that are included (see 632# the \include command). 633 634EXAMPLE_PATH = 635 636# If the value of the EXAMPLE_PATH tag contains directories, you can use the 637# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp --- 19 unchanged lines hidden (view full) --- 657# invoke to filter for each input file. Doxygen will invoke the filter program 658# by executing (via popen()) the command <filter> <input-file>, where <filter> 659# is the value of the INPUT_FILTER tag, and <input-file> is the name of an 660# input file. Doxygen will then use the output that the filter program writes 661# to standard output. 662 663INPUT_FILTER = 664 |
| 665# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 666# basis. 667# Doxygen will compare the file name with each pattern and apply the 668# filter if there is a match. 669# The filters are a list of the form: 670# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 671# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER 672# is applied to all files. 673 674FILTER_PATTERNS = 675 |
|
| 473# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 474# INPUT_FILTER) will be used to filter the input files when producing source 475# files to browse (i.e. when SOURCE_BROWSER is set to YES). 476 477FILTER_SOURCE_FILES = NO 478 479#--------------------------------------------------------------------------- 480# configuration options related to source browsing --- 24 unchanged lines hidden (view full) --- 505REFERENCED_BY_RELATION = YES 506 507# If the REFERENCES_RELATION tag is set to YES (the default) 508# then for each documented function all documented entities 509# called/used by that function will be listed. 510 511REFERENCES_RELATION = YES 512 | 676# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 677# INPUT_FILTER) will be used to filter the input files when producing source 678# files to browse (i.e. when SOURCE_BROWSER is set to YES). 679 680FILTER_SOURCE_FILES = NO 681 682#--------------------------------------------------------------------------- 683# configuration options related to source browsing --- 24 unchanged lines hidden (view full) --- 708REFERENCED_BY_RELATION = YES 709 710# If the REFERENCES_RELATION tag is set to YES (the default) 711# then for each documented function all documented entities 712# called/used by that function will be listed. 713 714REFERENCES_RELATION = YES 715 |
| 716# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) 717# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from 718# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will 719# link to the source code. 720# Otherwise they will link to the documentation. 721 722REFERENCES_LINK_SOURCE = YES 723 724# If the USE_HTAGS tag is set to YES then the references to source code 725# will point to the HTML generated by the htags(1) tool instead of doxygen 726# built-in source browser. The htags tool is part of GNU's global source 727# tagging system (see http://www.gnu.org/software/global/global.html). You 728# will need version 4.8.6 or higher. 729 730USE_HTAGS = NO 731 |
|
| 513# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 514# will generate a verbatim copy of the header file for each class for 515# which an include is specified. Set to NO to disable this. 516 517VERBATIM_HEADERS = YES 518 519#--------------------------------------------------------------------------- 520# configuration options related to the alphabetical class index --- 55 unchanged lines hidden (view full) --- 576# style sheet that is used by each HTML page. It can be used to 577# fine-tune the look of the HTML output. If the tag is left blank doxygen 578# will generate a default style sheet. Note that doxygen will try to copy 579# the style sheet file to the HTML output directory, so don't put your own 580# stylesheet in the HTML output directory as well, or it will be erased! 581 582HTML_STYLESHEET = 583 | 732# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 733# will generate a verbatim copy of the header file for each class for 734# which an include is specified. Set to NO to disable this. 735 736VERBATIM_HEADERS = YES 737 738#--------------------------------------------------------------------------- 739# configuration options related to the alphabetical class index --- 55 unchanged lines hidden (view full) --- 795# style sheet that is used by each HTML page. It can be used to 796# fine-tune the look of the HTML output. If the tag is left blank doxygen 797# will generate a default style sheet. Note that doxygen will try to copy 798# the style sheet file to the HTML output directory, so don't put your own 799# stylesheet in the HTML output directory as well, or it will be erased! 800 801HTML_STYLESHEET = 802 |
| 803# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML 804# page will contain the date and time when the page was generated. Setting 805# this to NO can help when comparing the output of multiple runs. 806 807HTML_TIMESTAMP = YES 808 |
|
| 584# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 585# files or namespaces will be aligned in HTML using tables. If set to 586# NO a bullet list will be used. 587 588HTML_ALIGN_MEMBERS = YES 589 | 809# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 810# files or namespaces will be aligned in HTML using tables. If set to 811# NO a bullet list will be used. 812 813HTML_ALIGN_MEMBERS = YES 814 |
| 815# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 816# documentation will contain sections that can be hidden and shown after the 817# page has loaded. For this to work a browser that supports 818# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox 819# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). 820 821HTML_DYNAMIC_SECTIONS = NO 822 823# If the GENERATE_DOCSET tag is set to YES, additional index files 824# will be generated that can be used as input for Apple's Xcode 3 825# integrated development environment, introduced with OSX 10.5 (Leopard). 826# To create a documentation set, doxygen will generate a Makefile in the 827# HTML output directory. Running make will produce the docset in that 828# directory and running "make install" will install the docset in 829# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find 830# it at startup. 831# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information. 832 833GENERATE_DOCSET = NO 834 835# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the 836# feed. A documentation feed provides an umbrella under which multiple 837# documentation sets from a single provider (such as a company or product suite) 838# can be grouped. 839 840DOCSET_FEEDNAME = "Doxygen generated docs" 841 842# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that 843# should uniquely identify the documentation set bundle. This should be a 844# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen 845# will append .docset to the name. 846 847DOCSET_BUNDLE_ID = org.doxygen.Project 848 |
|
| 590# If the GENERATE_HTMLHELP tag is set to YES, additional index files 591# will be generated that can be used as input for tools like the 592# Microsoft HTML help workshop to generate a compressed HTML help file (.chm) 593# of the generated HTML documentation. 594 595GENERATE_HTMLHELP = NO 596 597# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can --- 11 unchanged lines hidden (view full) --- 609HHC_LOCATION = 610 611# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 612# controls if a separate .chi index file is generated (YES) or that 613# it should be included in the master .chm file (NO). 614 615GENERATE_CHI = NO 616 | 849# If the GENERATE_HTMLHELP tag is set to YES, additional index files 850# will be generated that can be used as input for tools like the 851# Microsoft HTML help workshop to generate a compressed HTML help file (.chm) 852# of the generated HTML documentation. 853 854GENERATE_HTMLHELP = NO 855 856# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can --- 11 unchanged lines hidden (view full) --- 868HHC_LOCATION = 869 870# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 871# controls if a separate .chi index file is generated (YES) or that 872# it should be included in the master .chm file (NO). 873 874GENERATE_CHI = NO 875 |
| 876# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING 877# is used to encode HtmlHelp index (hhk), content (hhc) and project file 878# content. 879 880CHM_INDEX_ENCODING = 881 |
|
| 617# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 618# controls whether a binary table of contents is generated (YES) or a 619# normal table of contents (NO) in the .chm file. 620 621BINARY_TOC = NO 622 623# The TOC_EXPAND flag can be set to YES to add extra items for group members 624# to the contents of the HTML help documentation and to the tree view. 625 626TOC_EXPAND = NO 627 | 882# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 883# controls whether a binary table of contents is generated (YES) or a 884# normal table of contents (NO) in the .chm file. 885 886BINARY_TOC = NO 887 888# The TOC_EXPAND flag can be set to YES to add extra items for group members 889# to the contents of the HTML help documentation and to the tree view. 890 891TOC_EXPAND = NO 892 |
| 893# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER 894# are set, an additional index file will be generated that can be used as input for 895# Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated 896# HTML documentation. 897 898GENERATE_QHP = NO 899 900# If the QHG_LOCATION tag is specified, the QCH_FILE tag can 901# be used to specify the file name of the resulting .qch file. 902# The path specified is relative to the HTML output folder. 903 904QCH_FILE = 905 906# The QHP_NAMESPACE tag specifies the namespace to use when generating 907# Qt Help Project output. For more information please see 908# http://doc.trolltech.com/qthelpproject.html#namespace 909 910QHP_NAMESPACE = org.doxygen.Project 911 912# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating 913# Qt Help Project output. For more information please see 914# http://doc.trolltech.com/qthelpproject.html#virtual-folders 915 916QHP_VIRTUAL_FOLDER = doc 917 918# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add. 919# For more information please see 920# http://doc.trolltech.com/qthelpproject.html#custom-filters 921 922QHP_CUST_FILTER_NAME = 923 924# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see 925# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>. 926 927QHP_CUST_FILTER_ATTRS = 928 929# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's 930# filter section matches. 931# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>. 932 933QHP_SECT_FILTER_ATTRS = 934 935# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can 936# be used to specify the location of Qt's qhelpgenerator. 937# If non-empty doxygen will try to run qhelpgenerator on the generated 938# .qhp file. 939 940QHG_LOCATION = 941 942# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files 943# will be generated, which together with the HTML files, form an Eclipse help 944# plugin. To install this plugin and make it available under the help contents 945# menu in Eclipse, the contents of the directory containing the HTML and XML 946# files needs to be copied into the plugins directory of eclipse. The name of 947# the directory within the plugins directory should be the same as 948# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before the help appears. 949 950GENERATE_ECLIPSEHELP = NO 951 952# A unique identifier for the eclipse help plugin. When installing the plugin 953# the directory name containing the HTML and XML files should also have 954# this name. 955 956ECLIPSE_DOC_ID = org.doxygen.Project 957 |
|
| 628# The DISABLE_INDEX tag can be used to turn on/off the condensed index at 629# top of each HTML page. The value NO (the default) enables the index and 630# the value YES disables it. 631 632DISABLE_INDEX = NO 633 634# This tag can be used to set the number of enum values (range [1..20]) 635# that doxygen will group on one line in the generated HTML documentation. --- 4 unchanged lines hidden (view full) --- 640# generated containing a tree-like index structure (just like the one that 641# is generated for HTML Help). For this to work a browser that supports 642# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, 643# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are 644# probably better off using the HTML help feature. 645 646GENERATE_TREEVIEW = NO 647 | 958# The DISABLE_INDEX tag can be used to turn on/off the condensed index at 959# top of each HTML page. The value NO (the default) enables the index and 960# the value YES disables it. 961 962DISABLE_INDEX = NO 963 964# This tag can be used to set the number of enum values (range [1..20]) 965# that doxygen will group on one line in the generated HTML documentation. --- 4 unchanged lines hidden (view full) --- 970# generated containing a tree-like index structure (just like the one that 971# is generated for HTML Help). For this to work a browser that supports 972# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, 973# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are 974# probably better off using the HTML help feature. 975 976GENERATE_TREEVIEW = NO 977 |
| 978# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories, 979# and Class Hierarchy pages using a tree view instead of an ordered list. 980 981USE_INLINE_TREES = NO 982 |
|
| 648# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 649# used to set the initial width (in pixels) of the frame in which the tree 650# is shown. 651 652TREEVIEW_WIDTH = 250 653 | 983# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 984# used to set the initial width (in pixels) of the frame in which the tree 985# is shown. 986 987TREEVIEW_WIDTH = 250 988 |
| 989# Use this tag to change the font size of Latex formulas included 990# as images in the HTML documentation. The default is 10. Note that 991# when you change the font size after a successful doxygen run you need 992# to manually remove any form_*.png images from the HTML output directory 993# to force them to be regenerated. 994 995FORMULA_FONTSIZE = 10 996 997# When the SEARCHENGINE tag is enabled doxygen will generate a search box for the HTML output. The underlying search engine uses javascript 998# and DHTML and should work on any modern browser. Note that when using HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) there is already a search function so this one should 999# typically be disabled. For large projects the javascript based search engine 1000# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. 1001 1002SEARCHENGINE = YES 1003 1004# When the SERVER_BASED_SEARCH tag is enabled the search engine will be implemented using a PHP enabled web server instead of at the web client using Javascript. Doxygen will generate the search PHP script and index 1005# file to put on the web server. The advantage of the server based approach is that it scales better to large projects and allows full text search. The disadvances is that it is more difficult to setup 1006# and does not have live searching capabilities. 1007 1008SERVER_BASED_SEARCH = NO 1009 |
|
| 654#--------------------------------------------------------------------------- 655# configuration options related to the LaTeX output 656#--------------------------------------------------------------------------- 657 658# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 659# generate Latex output. 660 661GENERATE_LATEX = NO --- 60 unchanged lines hidden (view full) --- 722LATEX_BATCHMODE = NO 723 724# If LATEX_HIDE_INDICES is set to YES then doxygen will not 725# include the index chapters (such as File Index, Compound Index, etc.) 726# in the output. 727 728LATEX_HIDE_INDICES = NO 729 | 1010#--------------------------------------------------------------------------- 1011# configuration options related to the LaTeX output 1012#--------------------------------------------------------------------------- 1013 1014# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 1015# generate Latex output. 1016 1017GENERATE_LATEX = NO --- 60 unchanged lines hidden (view full) --- 1078LATEX_BATCHMODE = NO 1079 1080# If LATEX_HIDE_INDICES is set to YES then doxygen will not 1081# include the index chapters (such as File Index, Compound Index, etc.) 1082# in the output. 1083 1084LATEX_HIDE_INDICES = NO 1085 |
| 1086# If LATEX_SOURCE_CODE is set to YES then doxygen will include source code with syntax highlighting in the LaTeX output. Note that which sources are shown also depends on other settings such as SOURCE_BROWSER. 1087 1088LATEX_SOURCE_CODE = NO 1089 |
|
| 730#--------------------------------------------------------------------------- 731# configuration options related to the RTF output 732#--------------------------------------------------------------------------- 733 734# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 735# The RTF output is optimized for Word 97 and may not look very pretty with 736# other RTF readers or editors. 737 --- 190 unchanged lines hidden (view full) --- 928 929# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 930# this tag can be used to specify a list of macro names that should be expanded. 931# The macro definition that is found in the sources will be used. 932# Use the PREDEFINED tag if you want to use a different macro definition. 933 934EXPAND_AS_DEFINED = 935 | 1090#--------------------------------------------------------------------------- 1091# configuration options related to the RTF output 1092#--------------------------------------------------------------------------- 1093 1094# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 1095# The RTF output is optimized for Word 97 and may not look very pretty with 1096# other RTF readers or editors. 1097 --- 190 unchanged lines hidden (view full) --- 1288 1289# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 1290# this tag can be used to specify a list of macro names that should be expanded. 1291# The macro definition that is found in the sources will be used. 1292# Use the PREDEFINED tag if you want to use a different macro definition. 1293 1294EXPAND_AS_DEFINED = 1295 |
| 936# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 937# doxygen's preprocessor will remove all function-like macros that are alone 938# on a line, have an all uppercase name, and do not end with a semicolon. Such 939# function macros are typically used for boiler-plate code, and will confuse the 940# parser if not removed. | 1296# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 1297# doxygen's preprocessor will remove all function-like macros that are alone 1298# on a line, have an all uppercase name, and do not end with a semicolon. Such 1299# function macros are typically used for boiler-plate code, and will confuse 1300# the parser if not removed. |
| 941 942SKIP_FUNCTION_MACROS = YES 943 944#--------------------------------------------------------------------------- 945# Configuration::additions related to external references 946#--------------------------------------------------------------------------- 947 948# The TAGFILES option can be used to specify one or more tagfiles. --- 34 unchanged lines hidden (view full) --- 983# interpreter (i.e. the result of `which perl'). 984 985PERL_PATH = /usr/bin/perl 986 987#--------------------------------------------------------------------------- 988# Configuration options related to the dot tool 989#--------------------------------------------------------------------------- 990 | 1301 1302SKIP_FUNCTION_MACROS = YES 1303 1304#--------------------------------------------------------------------------- 1305# Configuration::additions related to external references 1306#--------------------------------------------------------------------------- 1307 1308# The TAGFILES option can be used to specify one or more tagfiles. --- 34 unchanged lines hidden (view full) --- 1343# interpreter (i.e. the result of `which perl'). 1344 1345PERL_PATH = /usr/bin/perl 1346 1347#--------------------------------------------------------------------------- 1348# Configuration options related to the dot tool 1349#--------------------------------------------------------------------------- 1350 |
| 991# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 992# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or 993# super classes. Setting the tag to NO turns the diagrams off. Note that this 994# option is superseded by the HAVE_DOT option below. This is only a fallback. It is 995# recommended to install and use dot, since it yields more powerful graphs. | 1351# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 1352# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base 1353# or super classes. Setting the tag to NO turns the diagrams off. Note that 1354# this option is superseded by the HAVE_DOT option below. This is only a 1355# fallback. It is recommended to install and use dot, since it yields more 1356# powerful graphs. |
| 996 997CLASS_DIAGRAMS = YES 998 | 1357 1358CLASS_DIAGRAMS = YES 1359 |
| 1360# You can define message sequence charts within doxygen comments using the \msc 1361# command. Doxygen will then run the mscgen tool (see 1362# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the 1363# documentation. The MSCGEN_PATH tag allows you to specify the directory where 1364# the mscgen tool resides. If left empty the tool is assumed to be found in the 1365# default search path. 1366 1367MSCGEN_PATH = 1368 |
|
| 999# If set to YES, the inheritance and collaboration graphs will hide 1000# inheritance and usage relations if the target is undocumented 1001# or is not a class. 1002 1003HIDE_UNDOC_RELATIONS = YES 1004 1005# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 1006# available from the path. This tool is part of Graphviz, a graph visualization 1007# toolkit from AT&T and Lucent Bell Labs. The other options in this section 1008# have no effect if this option is set to NO (the default) 1009 1010HAVE_DOT = NO 1011 | 1369# If set to YES, the inheritance and collaboration graphs will hide 1370# inheritance and usage relations if the target is undocumented 1371# or is not a class. 1372 1373HIDE_UNDOC_RELATIONS = YES 1374 1375# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 1376# available from the path. This tool is part of Graphviz, a graph visualization 1377# toolkit from AT&T and Lucent Bell Labs. The other options in this section 1378# have no effect if this option is set to NO (the default) 1379 1380HAVE_DOT = NO 1381 |
| 1382# By default doxygen will write a font called FreeSans.ttf to the output 1383# directory and reference it in all dot files that doxygen generates. This 1384# font does not include all possible unicode characters however, so when you need 1385# these (or just want a differently looking font) you can specify the font name 1386# using DOT_FONTNAME. You need need to make sure dot is able to find the font, 1387# which can be done by putting it in a standard location or by setting the 1388# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory 1389# containing the font. 1390 1391DOT_FONTNAME = FreeSans 1392 1393# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. 1394# The default size is 10pt. 1395 1396DOT_FONTSIZE = 10 1397 1398# By default doxygen will tell dot to use the output directory to look for the 1399# FreeSans.ttf font (which doxygen will put there itself). If you specify a 1400# different font using DOT_FONTNAME you can set the path where dot 1401# can find it using this tag. 1402 1403DOT_FONTPATH = 1404 |
|
| 1012# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 1013# will generate a graph for each documented class showing the direct and 1014# indirect inheritance relations. Setting this tag to YES will force the 1015# the CLASS_DIAGRAMS tag to NO. 1016 1017CLASS_GRAPH = YES 1018 1019# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 1020# will generate a graph for each documented class showing the direct and 1021# indirect implementation dependencies (inheritance, containment, and 1022# class references variables) of the class with other documented classes. 1023 1024COLLABORATION_GRAPH = YES 1025 | 1405# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 1406# will generate a graph for each documented class showing the direct and 1407# indirect inheritance relations. Setting this tag to YES will force the 1408# the CLASS_DIAGRAMS tag to NO. 1409 1410CLASS_GRAPH = YES 1411 1412# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 1413# will generate a graph for each documented class showing the direct and 1414# indirect implementation dependencies (inheritance, containment, and 1415# class references variables) of the class with other documented classes. 1416 1417COLLABORATION_GRAPH = YES 1418 |
| 1419# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen 1420# will generate a graph for groups, showing the direct groups dependencies 1421 1422GROUP_GRAPHS = YES 1423 |
|
| 1026# If the UML_LOOK tag is set to YES doxygen will generate inheritance and 1027# collaboration diagrams in a style similar to the OMG's Unified Modeling 1028# Language. 1029 1030UML_LOOK = NO 1031 1032# If set to YES, the inheritance and collaboration graphs will show the 1033# relations between templates and their instances. --- 17 unchanged lines hidden (view full) --- 1051# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will 1052# generate a call dependency graph for every global function or class method. 1053# Note that enabling this option will significantly increase the time of a run. 1054# So in most cases it will be better to enable call graphs for selected 1055# functions only using the \callgraph command. 1056 1057CALL_GRAPH = YES 1058 | 1424# If the UML_LOOK tag is set to YES doxygen will generate inheritance and 1425# collaboration diagrams in a style similar to the OMG's Unified Modeling 1426# Language. 1427 1428UML_LOOK = NO 1429 1430# If set to YES, the inheritance and collaboration graphs will show the 1431# relations between templates and their instances. --- 17 unchanged lines hidden (view full) --- 1449# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will 1450# generate a call dependency graph for every global function or class method. 1451# Note that enabling this option will significantly increase the time of a run. 1452# So in most cases it will be better to enable call graphs for selected 1453# functions only using the \callgraph command. 1454 1455CALL_GRAPH = YES 1456 |
| 1457# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then 1458# doxygen will generate a caller dependency graph for every global function 1459# or class method. Note that enabling this option will significantly increase 1460# the time of a run. So in most cases it will be better to enable caller 1461# graphs for selected functions only using the \callergraph command. 1462 1463CALLER_GRAPH = NO 1464 |
|
| 1059# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 1060# will graphical hierarchy of all classes instead of a textual one. 1061 1062GRAPHICAL_HIERARCHY = YES 1063 | 1465# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 1466# will graphical hierarchy of all classes instead of a textual one. 1467 1468GRAPHICAL_HIERARCHY = YES 1469 |
| 1470# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES 1471# then doxygen will show the dependencies a directory has on other directories 1472# in a graphical way. The dependency relations are determined by the #include 1473# relations between the files in the directories. 1474 1475DIRECTORY_GRAPH = YES 1476 |
|
| 1064# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 1065# generated by dot. Possible values are png, jpg, or gif 1066# If left blank png will be used. 1067 1068DOT_IMAGE_FORMAT = png 1069 1070# The tag DOT_PATH can be used to specify the path where the dot tool can be 1071# found. If left blank, it is assumed the dot tool can be found on the path. 1072 1073DOT_PATH = 1074 1075# The DOTFILE_DIRS tag can be used to specify one or more directories that 1076# contain dot files that are included in the documentation (see the 1077# \dotfile command). 1078 1079DOTFILE_DIRS = | 1477# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 1478# generated by dot. Possible values are png, jpg, or gif 1479# If left blank png will be used. 1480 1481DOT_IMAGE_FORMAT = png 1482 1483# The tag DOT_PATH can be used to specify the path where the dot tool can be 1484# found. If left blank, it is assumed the dot tool can be found on the path. 1485 1486DOT_PATH = 1487 1488# The DOTFILE_DIRS tag can be used to specify one or more directories that 1489# contain dot files that are included in the documentation (see the 1490# \dotfile command). 1491 1492DOTFILE_DIRS = |
| 1493# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of 1494# nodes that will be shown in the graph. If the number of nodes in a graph 1495# becomes larger than this value, doxygen will truncate the graph, which is 1496# visualized by representing a node as a red box. Note that doxygen if the 1497# number of direct children of the root node in a graph is already larger than 1498# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note 1499# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. |
|
| 1080 | 1500 |
| 1081# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width 1082# (in pixels) of the graphs generated by dot. If a graph becomes larger than 1083# this value, doxygen will try to truncate the graph, so that it fits within 1084# the specified constraint. Beware that most browsers cannot cope with very 1085# large images. | 1501DOT_GRAPH_MAX_NODES = 50 |
| 1086 | 1502 |
| 1087MAX_DOT_GRAPH_WIDTH = 1024 | 1503# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 1504# graphs generated by dot. A depth value of 3 means that only nodes reachable 1505# from the root by following a path via at most 3 edges will be shown. Nodes 1506# that lay further from the root node will be omitted. Note that setting this 1507# option to 1 or 2 may greatly reduce the computation time needed for large 1508# code bases. Also note that the size of a graph can be further restricted by 1509# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. |
| 1088 | 1510 |
| 1089# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height 1090# (in pixels) of the graphs generated by dot. If a graph becomes larger than 1091# this value, doxygen will try to truncate the graph, so that it fits within 1092# the specified constraint. Beware that most browsers cannot cope with very 1093# large images. | 1511MAX_DOT_GRAPH_DEPTH = 0 |
| 1094 | 1512 |
| 1095MAX_DOT_GRAPH_HEIGHT = 1024 | 1513# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 1514# background. This is disabled by default, because dot on Windows does not 1515# seem to support this out of the box. Warning: Depending on the platform used, 1516# enabling this option may lead to badly anti-aliased labels on the edges of 1517# a graph (i.e. they become hard to read). |
| 1096 | 1518 |
| 1097# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 1098# graphs generated by dot. A depth value of 3 means that only nodes reachable 1099# from the root by following a path via at most 3 edges will be shown. Nodes that 1100# lay further from the root node will be omitted. Note that setting this option to 1101# 1 or 2 may greatly reduce the computation time needed for large code bases. Also 1102# note that a graph may be further truncated if the graph's image dimensions are 1103# not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT). 1104# If 0 is used for the depth value (the default), the graph is not depth-constrained. | 1519DOT_TRANSPARENT = NO |
| 1105 | 1520 |
| 1106MAX_DOT_GRAPH_DEPTH = 0 | 1521# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output 1522# files in one run (i.e. multiple -o and -T options on the command line). This 1523# makes dot run faster, but since only newer versions of dot (>1.8.10) 1524# support this, this feature is disabled by default. |
| 1107 | 1525 |
| 1526DOT_MULTI_TARGETS = YES 1527 |
|
| 1108# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 1109# generate a legend page explaining the meaning of the various boxes and 1110# arrows in the dot generated graphs. 1111 1112GENERATE_LEGEND = YES 1113 1114# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 1115# remove the intermediate dot files that are used to generate 1116# the various graphs. 1117 1118DOT_CLEANUP = YES | 1528# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 1529# generate a legend page explaining the meaning of the various boxes and 1530# arrows in the dot generated graphs. 1531 1532GENERATE_LEGEND = YES 1533 1534# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 1535# remove the intermediate dot files that are used to generate 1536# the various graphs. 1537 1538DOT_CLEANUP = YES |
| 1119 1120#--------------------------------------------------------------------------- 1121# Configuration::additions related to the search engine 1122#--------------------------------------------------------------------------- 1123 1124# The SEARCHENGINE tag specifies whether or not a search engine should be 1125# used. If set to NO the values of all tags below this one will be ignored. 1126 1127SEARCHENGINE = NO | |