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 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 25# The PROJECT_NAME tag is a single word (or a sequence of words surrounded 26# by quotes) that should identify the project. 27 28PROJECT_NAME = "path_utils" 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 = @PACKAGE_VERSION@ 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 = doc 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 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# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, 57# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, 58# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English 59# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, 60# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak, 61# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. 62 63OUTPUT_LANGUAGE = English 64 65# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 66# include brief member descriptions after the members that are listed in 67# the file and class documentation (similar to JavaDoc). 68# Set to NO to disable this. 69 70BRIEF_MEMBER_DESC = YES 71 72# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 73# the brief description of a member or function before the detailed description. 74# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 75# brief descriptions will be completely suppressed. 76 77REPEAT_BRIEF = YES 78 79# This tag implements a quasi-intelligent brief description abbreviator 80# that is used to form the text in various listings. Each string 81# in this list, if found as the leading text of the brief description, will be 82# stripped from the text and the result after processing the whole list, is 83# used as the annotated text. Otherwise, the brief description is used as-is. 84# If left blank, the following values are used ("$name" is automatically 85# replaced with the name of the entity): "The $name class" "The $name widget" 86# "The $name file" "is" "provides" "specifies" "contains" 87# "represents" "a" "an" "the" 88 89ABBREVIATE_BRIEF = "The $name class" \ 90 "The $name widget" \ 91 "The $name file" \ 92 is \ 93 provides \ 94 specifies \ 95 contains \ 96 represents \ 97 a \ 98 an \ 99 the 100 101# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 102# Doxygen will generate a detailed section even if there is only a brief 103# description. 104 105ALWAYS_DETAILED_SEC = NO 106 107# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 108# inherited members of a class in the documentation of that class as if those 109# members were ordinary class members. Constructors, destructors and assignment 110# operators of the base classes will not be shown. 111 112INLINE_INHERITED_MEMB = NO 113 114# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 115# path before files name in the file list and in the header files. If set 116# to NO the shortest path that makes the file name unique will be used. 117 118FULL_PATH_NAMES = YES 119 120# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 121# can be used to strip a user-defined part of the path. Stripping is 122# only done if one of the specified strings matches the left-hand part of 123# the path. The tag can be used to show relative paths in the file list. 124# If left blank the directory from which doxygen is run is used as the 125# path to strip. 126 127STRIP_FROM_PATH = 128 129# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 130# the path mentioned in the documentation of a class, which tells 131# the reader which header file to include in order to use a class. 132# If left blank only the name of the header file containing the class 133# definition is used. Otherwise one should specify the include paths that 134# are normally passed to the compiler using the -I flag. 135 136STRIP_FROM_INC_PATH = 137 138# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 139# (but less readable) file names. This can be useful is your file systems 140# doesn't support long names like on DOS, Mac, or CD-ROM. 141 142SHORT_NAMES = NO 143 144# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 145# will interpret the first line (until the first dot) of a JavaDoc-style 146# comment as the brief description. If set to NO, the JavaDoc 147# comments will behave just like regular Qt-style comments 148# (thus requiring an explicit @brief command for a brief description.) 149 150JAVADOC_AUTOBRIEF = NO 151 152# If the QT_AUTOBRIEF tag is set to YES then Doxygen will 153# interpret the first line (until the first dot) of a Qt-style 154# comment as the brief description. If set to NO, the comments 155# will behave just like regular Qt-style comments (thus requiring 156# an explicit \brief command for a brief description.) 157 158QT_AUTOBRIEF = NO 159 160# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 161# treat a multi-line C++ special comment block (i.e. a block of //! or /// 162# comments) as a brief description. This used to be the default behaviour. 163# The new default is to treat a multi-line C++ comment block as a detailed 164# description. Set this tag to YES if you prefer the old behaviour instead. 165 166MULTILINE_CPP_IS_BRIEF = NO 167 168# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 169# member inherits the documentation from any documented member that it 170# re-implements. 171 172INHERIT_DOCS = YES 173 174# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce 175# a new page for each member. If set to NO, the documentation of a member will 176# be part of the file/class/namespace that contains it. 177 178SEPARATE_MEMBER_PAGES = NO 179 180# The TAB_SIZE tag can be used to set the number of spaces in a tab. 181# Doxygen uses this value to replace tabs by spaces in code fragments. 182 183TAB_SIZE = 4 184 185# This tag can be used to specify a number of aliases that acts 186# as commands in the documentation. An alias has the form "name=value". 187# For example adding "sideeffect=\par Side Effects:\n" will allow you to 188# put the command \sideeffect (or @sideeffect) in the documentation, which 189# will result in a user-defined paragraph with heading "Side Effects:". 190# You can put \n's in the value part of an alias to insert newlines. 191 192ALIASES = 193 194# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 195# sources only. Doxygen will then generate output that is more tailored for C. 196# For instance, some of the names that are used will be different. The list 197# of all members will be omitted, etc. 198 199OPTIMIZE_OUTPUT_FOR_C = YES 200 201# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java 202# sources only. Doxygen will then generate output that is more tailored for 203# Java. For instance, namespaces will be presented as packages, qualified 204# scopes will look different, etc. 205 206OPTIMIZE_OUTPUT_JAVA = NO 207 208# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 209# sources only. Doxygen will then generate output that is more tailored for 210# Fortran. 211 212OPTIMIZE_FOR_FORTRAN = NO 213 214# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 215# sources. Doxygen will then generate output that is tailored for 216# VHDL. 217 218OPTIMIZE_OUTPUT_VHDL = NO 219 220# Doxygen selects the parser to use depending on the extension of the files it parses. 221# With this tag you can assign which parser to use for a given extension. 222# Doxygen has a built-in mapping, but you can override or extend it using this tag. 223# The format is ext=language, where ext is a file extension, and language is one of 224# the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP, 225# Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat 226# .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran), 227# 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. 228 229EXTENSION_MAPPING = 230 231# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 232# to include (a tag file for) the STL sources as input, then you should 233# set this tag to YES in order to let doxygen match functions declarations and 234# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. 235# func(std::string) {}). This also make the inheritance and collaboration 236# diagrams that involve STL classes more complete and accurate. 237 238BUILTIN_STL_SUPPORT = NO 239 240# If you use Microsoft's C++/CLI language, you should set this option to YES to 241# enable parsing support. 242 243CPP_CLI_SUPPORT = NO 244 245# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. 246# Doxygen will parse them like normal C++ but will assume all classes use public 247# instead of private inheritance when no explicit protection keyword is present. 248 249SIP_SUPPORT = NO 250 251# For Microsoft's IDL there are propget and propput attributes to indicate getter 252# and setter methods for a property. Setting this option to YES (the default) 253# will make doxygen to replace the get and set methods by a property in the 254# documentation. This will only work if the methods are indeed getting or 255# setting a simple type. If this is not the case, or you want to show the 256# methods anyway, you should set this option to NO. 257 258IDL_PROPERTY_SUPPORT = YES 259 260# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 261# tag is set to YES, then doxygen will reuse the documentation of the first 262# member in the group (if any) for the other members of the group. By default 263# all members of a group must be documented explicitly. 264 265DISTRIBUTE_GROUP_DOC = NO 266 267# Set the SUBGROUPING tag to YES (the default) to allow class member groups of 268# the same type (for instance a group of public functions) to be put as a 269# subgroup of that type (e.g. under the Public Functions section). Set it to 270# NO to prevent subgrouping. Alternatively, this can be done per class using 271# the \nosubgrouping command. 272 273SUBGROUPING = YES 274 275# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum 276# is documented as struct, union, or enum with the name of the typedef. So 277# typedef struct TypeS {} TypeT, will appear in the documentation as a struct 278# with name TypeT. When disabled the typedef will appear as a member of a file, 279# namespace, or class. And the struct will be named TypeS. This can typically 280# be useful for C code in case the coding convention dictates that all compound 281# types are typedef'ed and only the typedef is referenced, never the tag name. 282 283TYPEDEF_HIDES_STRUCT = NO 284 285# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to 286# determine which symbols to keep in memory and which to flush to disk. 287# When the cache is full, less often used symbols will be written to disk. 288# For small to medium size projects (<1000 input files) the default value is 289# probably good enough. For larger projects a too small cache size can cause 290# doxygen to be busy swapping symbols to and from disk most of the time 291# causing a significant performance penality. 292# If the system has enough physical memory increasing the cache will improve the 293# performance by keeping more symbols in memory. Note that the value works on 294# a logarithmic scale so increasing the size by one will rougly double the 295# memory usage. The cache size is given by this formula: 296# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, 297# corresponding to a cache size of 2^16 = 65536 symbols 298 299SYMBOL_CACHE_SIZE = 0 300 301#--------------------------------------------------------------------------- 302# Build related configuration options 303#--------------------------------------------------------------------------- 304 305# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 306# documentation are documented, even if no documentation was available. 307# Private class members and static file members will be hidden unless 308# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES 309 310EXTRACT_ALL = NO 311 312# If the EXTRACT_PRIVATE tag is set to YES all private members of a class 313# will be included in the documentation. 314 315EXTRACT_PRIVATE = NO 316 317# If the EXTRACT_STATIC tag is set to YES all static members of a file 318# will be included in the documentation. 319 320EXTRACT_STATIC = NO 321 322# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 323# defined locally in source files will be included in the documentation. 324# If set to NO only classes defined in header files are included. 325 326EXTRACT_LOCAL_CLASSES = NO 327 328# This flag is only useful for Objective-C code. When set to YES local 329# methods, which are defined in the implementation section but not in 330# the interface are included in the documentation. 331# If set to NO (the default) only methods in the interface are included. 332 333EXTRACT_LOCAL_METHODS = NO 334 335# If this flag is set to YES, the members of anonymous namespaces will be 336# extracted and appear in the documentation as a namespace called 337# 'anonymous_namespace{file}', where file will be replaced with the base 338# name of the file that contains the anonymous namespace. By default 339# anonymous namespace are hidden. 340 341EXTRACT_ANON_NSPACES = NO 342 343# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 344# undocumented members of documented classes, files or namespaces. 345# If set to NO (the default) these members will be included in the 346# various overviews, but no documentation section is generated. 347# This option has no effect if EXTRACT_ALL is enabled. 348 349HIDE_UNDOC_MEMBERS = YES 350 351# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 352# undocumented classes that are normally visible in the class hierarchy. 353# If set to NO (the default) these classes will be included in the various 354# overviews. This option has no effect if EXTRACT_ALL is enabled. 355 356HIDE_UNDOC_CLASSES = YES 357 358# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 359# friend (class|struct|union) declarations. 360# If set to NO (the default) these declarations will be included in the 361# documentation. 362 363HIDE_FRIEND_COMPOUNDS = NO 364 365# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 366# documentation blocks found inside the body of a function. 367# If set to NO (the default) these blocks will be appended to the 368# function's detailed documentation block. 369 370HIDE_IN_BODY_DOCS = NO 371 372# The INTERNAL_DOCS tag determines if documentation 373# that is typed after a \internal command is included. If the tag is set 374# to NO (the default) then the documentation will be excluded. 375# Set it to YES to include the internal documentation. 376 377INTERNAL_DOCS = NO 378 379# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 380# file names in lower-case letters. If set to YES upper-case letters are also 381# allowed. This is useful if you have classes or files whose names only differ 382# in case and if your file system supports case sensitive file names. Windows 383# and Mac users are advised to set this option to NO. 384 385CASE_SENSE_NAMES = YES 386 387# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 388# will show members with their full class and namespace scopes in the 389# documentation. If set to YES the scope will be hidden. 390 391HIDE_SCOPE_NAMES = NO 392 393# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 394# will put a list of the files that are included by a file in the documentation 395# of that file. 396 397SHOW_INCLUDE_FILES = YES 398 399# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 400# is inserted in the documentation for inline members. 401 402INLINE_INFO = YES 403 404# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 405# will sort the (detailed) documentation of file and class members 406# alphabetically by member name. If set to NO the members will appear in 407# declaration order. 408 409SORT_MEMBER_DOCS = NO 410 411# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 412# brief documentation of file, namespace and class members alphabetically 413# by member name. If set to NO (the default) the members will appear in 414# declaration order. 415 416SORT_BRIEF_DOCS = NO 417 418# 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. 419 420SORT_MEMBERS_CTORS_1ST = NO 421 422# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the 423# hierarchy of group names into alphabetical order. If set to NO (the default) 424# the group names will appear in their defined order. 425 426SORT_GROUP_NAMES = NO 427 428# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 429# sorted by fully-qualified names, including namespaces. If set to 430# NO (the default), the class list will be sorted only by class name, 431# not including the namespace part. 432# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 433# Note: This option applies only to the class list, not to the 434# alphabetical list. 435 436SORT_BY_SCOPE_NAME = NO 437 438# The GENERATE_TODOLIST tag can be used to enable (YES) or 439# disable (NO) the todo list. This list is created by putting \todo 440# commands in the documentation. 441 442GENERATE_TODOLIST = YES 443 444# The GENERATE_TESTLIST tag can be used to enable (YES) or 445# disable (NO) the test list. This list is created by putting \test 446# commands in the documentation. 447 448GENERATE_TESTLIST = YES 449 450# The GENERATE_BUGLIST tag can be used to enable (YES) or 451# disable (NO) the bug list. This list is created by putting \bug 452# commands in the documentation. 453 454GENERATE_BUGLIST = YES 455 456# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 457# disable (NO) the deprecated list. This list is created by putting 458# \deprecated commands in the documentation. 459 460GENERATE_DEPRECATEDLIST= YES 461 462# The ENABLED_SECTIONS tag can be used to enable conditional 463# documentation sections, marked by \if sectionname ... \endif. 464 465ENABLED_SECTIONS = 466 467# The MAX_INITIALIZER_LINES tag determines the maximum number of lines 468# the initial value of a variable or define consists of for it to appear in 469# the documentation. If the initializer consists of more lines than specified 470# here it will be hidden. Use a value of 0 to hide initializers completely. 471# The appearance of the initializer of individual variables and defines in the 472# documentation can be controlled using \showinitializer or \hideinitializer 473# command in the documentation regardless of this setting. 474 475MAX_INITIALIZER_LINES = 30 476 477# Set the SHOW_USED_FILES tag to NO to disable the list of files generated 478# at the bottom of the documentation of classes and structs. If set to YES the 479# list will mention the files that were used to generate the documentation. 480 481SHOW_USED_FILES = YES 482 483# If the sources in your project are distributed over multiple directories 484# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy 485# in the documentation. The default is NO. 486 487SHOW_DIRECTORIES = NO 488 489# Set the SHOW_FILES tag to NO to disable the generation of the Files page. 490# This will remove the Files entry from the Quick Index and from the 491# Folder Tree View (if specified). The default is YES. 492 493SHOW_FILES = YES 494 495# Set the SHOW_NAMESPACES tag to NO to disable the generation of the 496# Namespaces page. 497# This will remove the Namespaces entry from the Quick Index 498# and from the Folder Tree View (if specified). The default is YES. 499 500SHOW_NAMESPACES = YES 501 502# The FILE_VERSION_FILTER tag can be used to specify a program or script that 503# doxygen should invoke to get the current version for each file (typically from 504# the version control system). Doxygen will invoke the program by executing (via 505# popen()) the command <command> <input-file>, where <command> is the value of 506# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file 507# provided by doxygen. Whatever the program writes to standard output 508# is used as the file version. See the manual for examples. 509 510FILE_VERSION_FILTER = 511 512# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by 513# doxygen. The layout file controls the global structure of the generated output files 514# in an output format independent way. The create the layout file that represents 515# doxygen's defaults, run doxygen with the -l option. You can optionally specify a 516# file name after the option, if omitted DoxygenLayout.xml will be used as the name 517# of the layout file. 518 519LAYOUT_FILE = 520 521#--------------------------------------------------------------------------- 522# configuration options related to warning and progress messages 523#--------------------------------------------------------------------------- 524 525# The QUIET tag can be used to turn on/off the messages that are generated 526# by doxygen. Possible values are YES and NO. If left blank NO is used. 527 528QUIET = NO 529 530# The WARNINGS tag can be used to turn on/off the warning messages that are 531# generated by doxygen. Possible values are YES and NO. If left blank 532# NO is used. 533 534WARNINGS = YES 535 536# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 537# for undocumented members. If EXTRACT_ALL is set to YES then this flag will 538# automatically be disabled. 539 540WARN_IF_UNDOCUMENTED = YES 541 542# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 543# potential errors in the documentation, such as not documenting some 544# parameters in a documented function, or documenting parameters that 545# don't exist or using markup commands wrongly. 546 547WARN_IF_DOC_ERROR = YES 548 549# This WARN_NO_PARAMDOC option can be abled to get warnings for 550# functions that are documented, but have no documentation for their parameters 551# or return value. If set to NO (the default) doxygen will only warn about 552# wrong or incomplete parameter documentation, but not about the absence of 553# documentation. 554 555WARN_NO_PARAMDOC = NO 556 557# The WARN_FORMAT tag determines the format of the warning messages that 558# doxygen can produce. The string should contain the $file, $line, and $text 559# tags, which will be replaced by the file and line number from which the 560# warning originated and the warning text. Optionally the format may contain 561# $version, which will be replaced by the version of the file (if it could 562# be obtained via FILE_VERSION_FILTER) 563 564WARN_FORMAT = "$file:$line: $text" 565 566# The WARN_LOGFILE tag can be used to specify a file to which warning 567# and error messages should be written. If left blank the output is written 568# to stderr. 569 570WARN_LOGFILE = 571 572#--------------------------------------------------------------------------- 573# configuration options related to the input files 574#--------------------------------------------------------------------------- 575 576# The INPUT tag can be used to specify the files and/or directories that contain 577# documented source files. You may enter file names like "myfile.cpp" or 578# directories like "/usr/src/myproject". Separate the files or directories 579# with spaces. 580 581INPUT = @srcdir@ 582 583# This tag can be used to specify the character encoding of the source files 584# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is 585# also the default input encoding. Doxygen uses libiconv (or the iconv built 586# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for 587# the list of possible encodings. 588 589INPUT_ENCODING = UTF-8 590 591# If the value of the INPUT tag contains directories, you can use the 592# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 593# and *.h) to filter out the source-files in the directories. If left 594# blank the following patterns are tested: 595# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx 596# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 597 598FILE_PATTERNS = *.c *.h 599 600# The RECURSIVE tag can be used to turn specify whether or not subdirectories 601# should be searched for input files as well. Possible values are YES and NO. 602# If left blank NO is used. 603 604RECURSIVE = NO 605 606# The EXCLUDE tag can be used to specify files and/or directories that should 607# excluded from the INPUT source files. This way you can easily exclude a 608# subdirectory from a directory tree whose root is specified with the INPUT tag. 609 610EXCLUDE = 611 612# The EXCLUDE_SYMLINKS tag can be used select whether or not files or 613# directories that are symbolic links (a Unix filesystem feature) are excluded 614# from the input. 615 616EXCLUDE_SYMLINKS = NO 617 618# If the value of the INPUT tag contains directories, you can use the 619# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 620# certain files from those directories. Note that the wildcards are matched 621# against the file with absolute path, so to exclude all test directories 622# for example use the pattern */test/* 623 624EXCLUDE_PATTERNS = *_ut.c config.h 625 626# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 627# (namespaces, classes, functions, etc.) that should be excluded from the 628# output. The symbol name can be a fully qualified name, a word, or if the 629# wildcard * is used, a substring. Examples: ANamespace, AClass, 630# AClass::ANamespace, ANamespace::*Test 631 632EXCLUDE_SYMBOLS = 633 634# The EXAMPLE_PATH tag can be used to specify one or more files or 635# directories that contain example code fragments that are included (see 636# the \include command). 637 638EXAMPLE_PATH = 639 640# If the value of the EXAMPLE_PATH tag contains directories, you can use the 641# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 642# and *.h) to filter out the source-files in the directories. If left 643# blank all files are included. 644 645EXAMPLE_PATTERNS = 646 647# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 648# searched for input files to be used with the \include or \dontinclude 649# commands irrespective of the value of the RECURSIVE tag. 650# Possible values are YES and NO. If left blank NO is used. 651 652EXAMPLE_RECURSIVE = NO 653 654# The IMAGE_PATH tag can be used to specify one or more files or 655# directories that contain image that are included in the documentation (see 656# the \image command). 657 658IMAGE_PATH = 659 660# The INPUT_FILTER tag can be used to specify a program that doxygen should 661# invoke to filter for each input file. Doxygen will invoke the filter program 662# by executing (via popen()) the command <filter> <input-file>, where <filter> 663# is the value of the INPUT_FILTER tag, and <input-file> is the name of an 664# input file. Doxygen will then use the output that the filter program writes 665# to standard output. 666# If FILTER_PATTERNS is specified, this tag will be 667# ignored. 668 669INPUT_FILTER = 670 671# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 672# basis. 673# Doxygen will compare the file name with each pattern and apply the 674# filter if there is a match. 675# The filters are a list of the form: 676# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 677# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER 678# is applied to all files. 679 680FILTER_PATTERNS = 681 682# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 683# INPUT_FILTER) will be used to filter the input files when producing source 684# files to browse (i.e. when SOURCE_BROWSER is set to YES). 685 686FILTER_SOURCE_FILES = NO 687 688#--------------------------------------------------------------------------- 689# configuration options related to source browsing 690#--------------------------------------------------------------------------- 691 692# If the SOURCE_BROWSER tag is set to YES then a list of source files will 693# be generated. Documented entities will be cross-referenced with these sources. 694# Note: To get rid of all source code in the generated output, make sure also 695# VERBATIM_HEADERS is set to NO. 696 697SOURCE_BROWSER = NO 698 699# Setting the INLINE_SOURCES tag to YES will include the body 700# of functions and classes directly in the documentation. 701 702INLINE_SOURCES = NO 703 704# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 705# doxygen to hide any special comment blocks from generated source code 706# fragments. Normal C and C++ comments will always remain visible. 707 708STRIP_CODE_COMMENTS = YES 709 710# If the REFERENCED_BY_RELATION tag is set to YES 711# then for each documented function all documented 712# functions referencing it will be listed. 713 714REFERENCED_BY_RELATION = NO 715 716# If the REFERENCES_RELATION tag is set to YES 717# then for each documented function all documented entities 718# called/used by that function will be listed. 719 720REFERENCES_RELATION = NO 721 722# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) 723# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from 724# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will 725# link to the source code. 726# Otherwise they will link to the documentation. 727 728REFERENCES_LINK_SOURCE = YES 729 730# If the USE_HTAGS tag is set to YES then the references to source code 731# will point to the HTML generated by the htags(1) tool instead of doxygen 732# built-in source browser. The htags tool is part of GNU's global source 733# tagging system (see http://www.gnu.org/software/global/global.html). You 734# will need version 4.8.6 or higher. 735 736USE_HTAGS = NO 737 738# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 739# will generate a verbatim copy of the header file for each class for 740# which an include is specified. Set to NO to disable this. 741 742VERBATIM_HEADERS = YES 743 744#--------------------------------------------------------------------------- 745# configuration options related to the alphabetical class index 746#--------------------------------------------------------------------------- 747 748# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 749# of all compounds will be generated. Enable this if the project 750# contains a lot of classes, structs, unions or interfaces. 751 752ALPHABETICAL_INDEX = NO 753 754# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 755# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 756# in which this list will be split (can be a number in the range [1..20]) 757 758COLS_IN_ALPHA_INDEX = 5 759 760# In case all classes in a project start with a common prefix, all 761# classes will be put under the same header in the alphabetical index. 762# The IGNORE_PREFIX tag can be used to specify one or more prefixes that 763# should be ignored while generating the index headers. 764 765IGNORE_PREFIX = 766 767#--------------------------------------------------------------------------- 768# configuration options related to the HTML output 769#--------------------------------------------------------------------------- 770 771# If the GENERATE_HTML tag is set to YES (the default) Doxygen will 772# generate HTML output. 773 774GENERATE_HTML = YES 775 776# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 777# If a relative path is entered the value of OUTPUT_DIRECTORY will be 778# put in front of it. If left blank `html' will be used as the default path. 779 780HTML_OUTPUT = html 781 782# The HTML_FILE_EXTENSION tag can be used to specify the file extension for 783# each generated HTML page (for example: .htm,.php,.asp). If it is left blank 784# doxygen will generate files with .html extension. 785 786HTML_FILE_EXTENSION = .html 787 788# The HTML_HEADER tag can be used to specify a personal HTML header for 789# each generated HTML page. If it is left blank doxygen will generate a 790# standard header. 791 792HTML_HEADER = 793 794# The HTML_FOOTER tag can be used to specify a personal HTML footer for 795# each generated HTML page. If it is left blank doxygen will generate a 796# standard footer. 797 798HTML_FOOTER = 799 800# The HTML_STYLESHEET tag can be used to specify a user-defined cascading 801# style sheet that is used by each HTML page. It can be used to 802# fine-tune the look of the HTML output. If the tag is left blank doxygen 803# will generate a default style sheet. Note that doxygen will try to copy 804# the style sheet file to the HTML output directory, so don't put your own 805# stylesheet in the HTML output directory as well, or it will be erased! 806 807HTML_STYLESHEET = 808 809# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML 810# page will contain the date and time when the page was generated. Setting 811# this to NO can help when comparing the output of multiple runs. 812 813HTML_TIMESTAMP = NO 814 815# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 816# files or namespaces will be aligned in HTML using tables. If set to 817# NO a bullet list will be used. 818 819HTML_ALIGN_MEMBERS = YES 820 821# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 822# documentation will contain sections that can be hidden and shown after the 823# page has loaded. For this to work a browser that supports 824# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox 825# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). 826 827HTML_DYNAMIC_SECTIONS = NO 828 829# If the GENERATE_DOCSET tag is set to YES, additional index files 830# will be generated that can be used as input for Apple's Xcode 3 831# integrated development environment, introduced with OSX 10.5 (Leopard). 832# To create a documentation set, doxygen will generate a Makefile in the 833# HTML output directory. Running make will produce the docset in that 834# directory and running "make install" will install the docset in 835# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find 836# it at startup. 837# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information. 838 839GENERATE_DOCSET = NO 840 841# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the 842# feed. A documentation feed provides an umbrella under which multiple 843# documentation sets from a single provider (such as a company or product suite) 844# can be grouped. 845 846DOCSET_FEEDNAME = "Doxygen generated docs" 847 848# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that 849# should uniquely identify the documentation set bundle. This should be a 850# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen 851# will append .docset to the name. 852 853DOCSET_BUNDLE_ID = org.doxygen.Project 854 855# If the GENERATE_HTMLHELP tag is set to YES, additional index files 856# will be generated that can be used as input for tools like the 857# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) 858# of the generated HTML documentation. 859 860GENERATE_HTMLHELP = NO 861 862# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 863# be used to specify the file name of the resulting .chm file. You 864# can add a path in front of the file if the result should not be 865# written to the html output directory. 866 867CHM_FILE = 868 869# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 870# be used to specify the location (absolute path including file name) of 871# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 872# the HTML help compiler on the generated index.hhp. 873 874HHC_LOCATION = 875 876# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 877# controls if a separate .chi index file is generated (YES) or that 878# it should be included in the master .chm file (NO). 879 880GENERATE_CHI = NO 881 882# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING 883# is used to encode HtmlHelp index (hhk), content (hhc) and project file 884# content. 885 886CHM_INDEX_ENCODING = 887 888# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 889# controls whether a binary table of contents is generated (YES) or a 890# normal table of contents (NO) in the .chm file. 891 892BINARY_TOC = NO 893 894# The TOC_EXPAND flag can be set to YES to add extra items for group members 895# to the contents of the HTML help documentation and to the tree view. 896 897TOC_EXPAND = NO 898 899# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER 900# are set, an additional index file will be generated that can be used as input for 901# Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated 902# HTML documentation. 903 904GENERATE_QHP = NO 905 906# If the QHG_LOCATION tag is specified, the QCH_FILE tag can 907# be used to specify the file name of the resulting .qch file. 908# The path specified is relative to the HTML output folder. 909 910QCH_FILE = 911 912# The QHP_NAMESPACE 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#namespace 915 916QHP_NAMESPACE = 917 918# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating 919# Qt Help Project output. For more information please see 920# http://doc.trolltech.com/qthelpproject.html#virtual-folders 921 922QHP_VIRTUAL_FOLDER = doc 923 924# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add. 925# For more information please see 926# http://doc.trolltech.com/qthelpproject.html#custom-filters 927 928QHP_CUST_FILTER_NAME = 929 930# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see 931# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>. 932 933QHP_CUST_FILTER_ATTRS = 934 935# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's 936# filter section matches. 937# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>. 938 939QHP_SECT_FILTER_ATTRS = 940 941# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can 942# be used to specify the location of Qt's qhelpgenerator. 943# If non-empty doxygen will try to run qhelpgenerator on the generated 944# .qhp file. 945 946QHG_LOCATION = 947 948# The DISABLE_INDEX tag can be used to turn on/off the condensed index at 949# top of each HTML page. The value NO (the default) enables the index and 950# the value YES disables it. 951 952DISABLE_INDEX = NO 953 954# This tag can be used to set the number of enum values (range [1..20]) 955# that doxygen will group on one line in the generated HTML documentation. 956 957ENUM_VALUES_PER_LINE = 4 958 959# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 960# structure should be generated to display hierarchical information. 961# If the tag value is set to YES, a side panel will be generated 962# containing a tree-like index structure (just like the one that 963# is generated for HTML Help). For this to work a browser that supports 964# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). 965# Windows users are probably better off using the HTML help feature. 966 967GENERATE_TREEVIEW = NO 968 969# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories, 970# and Class Hierarchy pages using a tree view instead of an ordered list. 971 972USE_INLINE_TREES = NO 973 974# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 975# used to set the initial width (in pixels) of the frame in which the tree 976# is shown. 977 978TREEVIEW_WIDTH = 250 979 980# Use this tag to change the font size of Latex formulas included 981# as images in the HTML documentation. The default is 10. Note that 982# when you change the font size after a successful doxygen run you need 983# to manually remove any form_*.png images from the HTML output directory 984# to force them to be regenerated. 985 986FORMULA_FONTSIZE = 10 987 988# When the SEARCHENGINE tag is enabled doxygen will generate a search box for the HTML output. The underlying search engine uses javascript 989# 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 990# typically be disabled. For large projects the javascript based search engine 991# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. 992 993SEARCHENGINE = YES 994 995#--------------------------------------------------------------------------- 996# configuration options related to the LaTeX output 997#--------------------------------------------------------------------------- 998 999# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 1000# generate Latex output. 1001 1002GENERATE_LATEX = NO 1003 1004# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 1005# If a relative path is entered the value of OUTPUT_DIRECTORY will be 1006# put in front of it. If left blank `latex' will be used as the default path. 1007 1008LATEX_OUTPUT = latex 1009 1010# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 1011# invoked. If left blank `latex' will be used as the default command name. 1012# Note that when enabling USE_PDFLATEX this option is only used for 1013# generating bitmaps for formulas in the HTML output, but not in the 1014# Makefile that is written to the output directory. 1015 1016LATEX_CMD_NAME = latex 1017 1018# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 1019# generate index for LaTeX. If left blank `makeindex' will be used as the 1020# default command name. 1021 1022MAKEINDEX_CMD_NAME = makeindex 1023 1024# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 1025# LaTeX documents. This may be useful for small projects and may help to 1026# save some trees in general. 1027 1028COMPACT_LATEX = NO 1029 1030# The PAPER_TYPE tag can be used to set the paper type that is used 1031# by the printer. Possible values are: a4, a4wide, letter, legal and 1032# executive. If left blank a4wide will be used. 1033 1034PAPER_TYPE = a4wide 1035 1036# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 1037# packages that should be included in the LaTeX output. 1038 1039EXTRA_PACKAGES = 1040 1041# The LATEX_HEADER tag can be used to specify a personal LaTeX header for 1042# the generated latex document. The header should contain everything until 1043# the first chapter. If it is left blank doxygen will generate a 1044# standard header. Notice: only use this tag if you know what you are doing! 1045 1046LATEX_HEADER = 1047 1048# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 1049# is prepared for conversion to pdf (using ps2pdf). The pdf file will 1050# contain links (just like the HTML output) instead of page references 1051# This makes the output suitable for online browsing using a pdf viewer. 1052 1053PDF_HYPERLINKS = YES 1054 1055# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 1056# plain latex in the generated Makefile. Set this option to YES to get a 1057# higher quality PDF documentation. 1058 1059USE_PDFLATEX = YES 1060 1061# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 1062# command to the generated LaTeX files. This will instruct LaTeX to keep 1063# running if errors occur, instead of asking the user for help. 1064# This option is also used when generating formulas in HTML. 1065 1066LATEX_BATCHMODE = NO 1067 1068# If LATEX_HIDE_INDICES is set to YES then doxygen will not 1069# include the index chapters (such as File Index, Compound Index, etc.) 1070# in the output. 1071 1072LATEX_HIDE_INDICES = NO 1073 1074# 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. 1075 1076LATEX_SOURCE_CODE = NO 1077 1078#--------------------------------------------------------------------------- 1079# configuration options related to the RTF output 1080#--------------------------------------------------------------------------- 1081 1082# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 1083# The RTF output is optimized for Word 97 and may not look very pretty with 1084# other RTF readers or editors. 1085 1086GENERATE_RTF = NO 1087 1088# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 1089# If a relative path is entered the value of OUTPUT_DIRECTORY will be 1090# put in front of it. If left blank `rtf' will be used as the default path. 1091 1092RTF_OUTPUT = rtf 1093 1094# If the COMPACT_RTF tag is set to YES Doxygen generates more compact 1095# RTF documents. This may be useful for small projects and may help to 1096# save some trees in general. 1097 1098COMPACT_RTF = NO 1099 1100# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 1101# will contain hyperlink fields. The RTF file will 1102# contain links (just like the HTML output) instead of page references. 1103# This makes the output suitable for online browsing using WORD or other 1104# programs which support those fields. 1105# Note: wordpad (write) and others do not support links. 1106 1107RTF_HYPERLINKS = NO 1108 1109# Load stylesheet definitions from file. Syntax is similar to doxygen's 1110# config file, i.e. a series of assignments. You only have to provide 1111# replacements, missing definitions are set to their default value. 1112 1113RTF_STYLESHEET_FILE = 1114 1115# Set optional variables used in the generation of an rtf document. 1116# Syntax is similar to doxygen's config file. 1117 1118RTF_EXTENSIONS_FILE = 1119 1120#--------------------------------------------------------------------------- 1121# configuration options related to the man page output 1122#--------------------------------------------------------------------------- 1123 1124# If the GENERATE_MAN tag is set to YES (the default) Doxygen will 1125# generate man pages 1126 1127GENERATE_MAN = NO 1128 1129# The MAN_OUTPUT tag is used to specify where the man pages will be put. 1130# If a relative path is entered the value of OUTPUT_DIRECTORY will be 1131# put in front of it. If left blank `man' will be used as the default path. 1132 1133MAN_OUTPUT = man 1134 1135# The MAN_EXTENSION tag determines the extension that is added to 1136# the generated man pages (default is the subroutine's section .3) 1137 1138MAN_EXTENSION = .3 1139 1140# If the MAN_LINKS tag is set to YES and Doxygen generates man output, 1141# then it will generate one additional man file for each entity 1142# documented in the real man page(s). These additional files 1143# only source the real man page, but without them the man command 1144# would be unable to find the correct page. The default is NO. 1145 1146MAN_LINKS = NO 1147 1148#--------------------------------------------------------------------------- 1149# configuration options related to the XML output 1150#--------------------------------------------------------------------------- 1151 1152# If the GENERATE_XML tag is set to YES Doxygen will 1153# generate an XML file that captures the structure of 1154# the code including all documentation. 1155 1156GENERATE_XML = NO 1157 1158# The XML_OUTPUT tag is used to specify where the XML pages will be put. 1159# If a relative path is entered the value of OUTPUT_DIRECTORY will be 1160# put in front of it. If left blank `xml' will be used as the default path. 1161 1162XML_OUTPUT = xml 1163 1164# The XML_SCHEMA tag can be used to specify an XML schema, 1165# which can be used by a validating XML parser to check the 1166# syntax of the XML files. 1167 1168XML_SCHEMA = 1169 1170# The XML_DTD tag can be used to specify an XML DTD, 1171# which can be used by a validating XML parser to check the 1172# syntax of the XML files. 1173 1174XML_DTD = 1175 1176# If the XML_PROGRAMLISTING tag is set to YES Doxygen will 1177# dump the program listings (including syntax highlighting 1178# and cross-referencing information) to the XML output. Note that 1179# enabling this will significantly increase the size of the XML output. 1180 1181XML_PROGRAMLISTING = YES 1182 1183#--------------------------------------------------------------------------- 1184# configuration options for the AutoGen Definitions output 1185#--------------------------------------------------------------------------- 1186 1187# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 1188# generate an AutoGen Definitions (see autogen.sf.net) file 1189# that captures the structure of the code including all 1190# documentation. Note that this feature is still experimental 1191# and incomplete at the moment. 1192 1193GENERATE_AUTOGEN_DEF = NO 1194 1195#--------------------------------------------------------------------------- 1196# configuration options related to the Perl module output 1197#--------------------------------------------------------------------------- 1198 1199# If the GENERATE_PERLMOD tag is set to YES Doxygen will 1200# generate a Perl module file that captures the structure of 1201# the code including all documentation. Note that this 1202# feature is still experimental and incomplete at the 1203# moment. 1204 1205GENERATE_PERLMOD = NO 1206 1207# If the PERLMOD_LATEX tag is set to YES Doxygen will generate 1208# the necessary Makefile rules, Perl scripts and LaTeX code to be able 1209# to generate PDF and DVI output from the Perl module output. 1210 1211PERLMOD_LATEX = NO 1212 1213# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 1214# nicely formatted so it can be parsed by a human reader. 1215# This is useful 1216# if you want to understand what is going on. 1217# On the other hand, if this 1218# tag is set to NO the size of the Perl module output will be much smaller 1219# and Perl will parse it just the same. 1220 1221PERLMOD_PRETTY = YES 1222 1223# The names of the make variables in the generated doxyrules.make file 1224# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 1225# This is useful so different doxyrules.make files included by the same 1226# Makefile don't overwrite each other's variables. 1227 1228PERLMOD_MAKEVAR_PREFIX = 1229 1230#--------------------------------------------------------------------------- 1231# Configuration options related to the preprocessor 1232#--------------------------------------------------------------------------- 1233 1234# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 1235# evaluate all C-preprocessor directives found in the sources and include 1236# files. 1237 1238ENABLE_PREPROCESSING = YES 1239 1240# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 1241# names in the source code. If set to NO (the default) only conditional 1242# compilation will be performed. Macro expansion can be done in a controlled 1243# way by setting EXPAND_ONLY_PREDEF to YES. 1244 1245MACRO_EXPANSION = NO 1246 1247# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 1248# then the macro expansion is limited to the macros specified with the 1249# PREDEFINED and EXPAND_AS_DEFINED tags. 1250 1251EXPAND_ONLY_PREDEF = NO 1252 1253# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 1254# in the INCLUDE_PATH (see below) will be search if a #include is found. 1255 1256SEARCH_INCLUDES = YES 1257 1258# The INCLUDE_PATH tag can be used to specify one or more directories that 1259# contain include files that are not input files but should be processed by 1260# the preprocessor. 1261 1262INCLUDE_PATH = 1263 1264# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 1265# patterns (like *.h and *.hpp) to filter out the header-files in the 1266# directories. If left blank, the patterns specified with FILE_PATTERNS will 1267# be used. 1268 1269INCLUDE_FILE_PATTERNS = 1270 1271# The PREDEFINED tag can be used to specify one or more macro names that 1272# are defined before the preprocessor is started (similar to the -D option of 1273# gcc). The argument of the tag is a list of macros of the form: name 1274# or name=definition (no spaces). If the definition and the = are 1275# omitted =1 is assumed. To prevent a macro definition from being 1276# undefined via #undef or recursively expanded use the := operator 1277# instead of the = operator. 1278 1279PREDEFINED = 1280 1281# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 1282# this tag can be used to specify a list of macro names that should be expanded. 1283# The macro definition that is found in the sources will be used. 1284# Use the PREDEFINED tag if you want to use a different macro definition. 1285 1286EXPAND_AS_DEFINED = 1287 1288# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 1289# doxygen's preprocessor will remove all function-like macros that are alone 1290# on a line, have an all uppercase name, and do not end with a semicolon. Such 1291# function macros are typically used for boiler-plate code, and will confuse 1292# the parser if not removed. 1293 1294SKIP_FUNCTION_MACROS = YES 1295 1296#--------------------------------------------------------------------------- 1297# Configuration::additions related to external references 1298#--------------------------------------------------------------------------- 1299 1300# The TAGFILES option can be used to specify one or more tagfiles. 1301# Optionally an initial location of the external documentation 1302# can be added for each tagfile. The format of a tag file without 1303# this location is as follows: 1304# 1305# TAGFILES = file1 file2 ... 1306# Adding location for the tag files is done as follows: 1307# 1308# TAGFILES = file1=loc1 "file2 = loc2" ... 1309# where "loc1" and "loc2" can be relative or absolute paths or 1310# URLs. If a location is present for each tag, the installdox tool 1311# does not have to be run to correct the links. 1312# Note that each tag file must have a unique name 1313# (where the name does NOT include the path) 1314# If a tag file is not located in the directory in which doxygen 1315# is run, you must also specify the path to the tagfile here. 1316 1317TAGFILES = 1318 1319# When a file name is specified after GENERATE_TAGFILE, doxygen will create 1320# a tag file that is based on the input files it reads. 1321 1322GENERATE_TAGFILE = 1323 1324# If the ALLEXTERNALS tag is set to YES all external classes will be listed 1325# in the class index. If set to NO only the inherited external classes 1326# will be listed. 1327 1328ALLEXTERNALS = NO 1329 1330# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 1331# in the modules index. If set to NO, only the current project's groups will 1332# be listed. 1333 1334EXTERNAL_GROUPS = YES 1335 1336# The PERL_PATH should be the absolute path and name of the perl script 1337# interpreter (i.e. the result of `which perl'). 1338 1339PERL_PATH = /usr/bin/perl 1340 1341#--------------------------------------------------------------------------- 1342# Configuration options related to the dot tool 1343#--------------------------------------------------------------------------- 1344 1345# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 1346# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base 1347# or super classes. Setting the tag to NO turns the diagrams off. Note that 1348# this option is superseded by the HAVE_DOT option below. This is only a 1349# fallback. It is recommended to install and use dot, since it yields more 1350# powerful graphs. 1351 1352CLASS_DIAGRAMS = YES 1353 1354# You can define message sequence charts within doxygen comments using the \msc 1355# command. Doxygen will then run the mscgen tool (see 1356# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the 1357# documentation. The MSCGEN_PATH tag allows you to specify the directory where 1358# the mscgen tool resides. If left empty the tool is assumed to be found in the 1359# default search path. 1360 1361MSCGEN_PATH = 1362 1363# If set to YES, the inheritance and collaboration graphs will hide 1364# inheritance and usage relations if the target is undocumented 1365# or is not a class. 1366 1367HIDE_UNDOC_RELATIONS = YES 1368 1369# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 1370# available from the path. This tool is part of Graphviz, a graph visualization 1371# toolkit from AT&T and Lucent Bell Labs. The other options in this section 1372# have no effect if this option is set to NO (the default) 1373 1374HAVE_DOT = NO 1375 1376# By default doxygen will write a font called FreeSans.ttf to the output 1377# directory and reference it in all dot files that doxygen generates. This 1378# font does not include all possible unicode characters however, so when you need 1379# these (or just want a differently looking font) you can specify the font name 1380# using DOT_FONTNAME. You need need to make sure dot is able to find the font, 1381# which can be done by putting it in a standard location or by setting the 1382# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory 1383# containing the font. 1384 1385DOT_FONTNAME = FreeSans 1386 1387# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. 1388# The default size is 10pt. 1389 1390DOT_FONTSIZE = 10 1391 1392# By default doxygen will tell dot to use the output directory to look for the 1393# FreeSans.ttf font (which doxygen will put there itself). If you specify a 1394# different font using DOT_FONTNAME you can set the path where dot 1395# can find it using this tag. 1396 1397DOT_FONTPATH = 1398 1399# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 1400# will generate a graph for each documented class showing the direct and 1401# indirect inheritance relations. Setting this tag to YES will force the 1402# the CLASS_DIAGRAMS tag to NO. 1403 1404CLASS_GRAPH = YES 1405 1406# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 1407# will generate a graph for each documented class showing the direct and 1408# indirect implementation dependencies (inheritance, containment, and 1409# class references variables) of the class with other documented classes. 1410 1411COLLABORATION_GRAPH = YES 1412 1413# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen 1414# will generate a graph for groups, showing the direct groups dependencies 1415 1416GROUP_GRAPHS = YES 1417 1418# If the UML_LOOK tag is set to YES doxygen will generate inheritance and 1419# collaboration diagrams in a style similar to the OMG's Unified Modeling 1420# Language. 1421 1422UML_LOOK = NO 1423 1424# If set to YES, the inheritance and collaboration graphs will show the 1425# relations between templates and their instances. 1426 1427TEMPLATE_RELATIONS = NO 1428 1429# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 1430# tags are set to YES then doxygen will generate a graph for each documented 1431# file showing the direct and indirect include dependencies of the file with 1432# other documented files. 1433 1434INCLUDE_GRAPH = YES 1435 1436# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 1437# HAVE_DOT tags are set to YES then doxygen will generate a graph for each 1438# documented header file showing the documented files that directly or 1439# indirectly include this file. 1440 1441INCLUDED_BY_GRAPH = YES 1442 1443# If the CALL_GRAPH and HAVE_DOT options are set to YES then 1444# doxygen will generate a call dependency graph for every global function 1445# or class method. Note that enabling this option will significantly increase 1446# the time of a run. So in most cases it will be better to enable call graphs 1447# for selected functions only using the \callgraph command. 1448 1449CALL_GRAPH = NO 1450 1451# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then 1452# doxygen will generate a caller dependency graph for every global function 1453# or class method. Note that enabling this option will significantly increase 1454# the time of a run. So in most cases it will be better to enable caller 1455# graphs for selected functions only using the \callergraph command. 1456 1457CALLER_GRAPH = NO 1458 1459# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 1460# will graphical hierarchy of all classes instead of a textual one. 1461 1462GRAPHICAL_HIERARCHY = YES 1463 1464# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES 1465# then doxygen will show the dependencies a directory has on other directories 1466# in a graphical way. The dependency relations are determined by the #include 1467# relations between the files in the directories. 1468 1469DIRECTORY_GRAPH = YES 1470 1471# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 1472# generated by dot. Possible values are png, jpg, or gif 1473# If left blank png will be used. 1474 1475DOT_IMAGE_FORMAT = png 1476 1477# The tag DOT_PATH can be used to specify the path where the dot tool can be 1478# found. If left blank, it is assumed the dot tool can be found in the path. 1479 1480DOT_PATH = 1481 1482# The DOTFILE_DIRS tag can be used to specify one or more directories that 1483# contain dot files that are included in the documentation (see the 1484# \dotfile command). 1485 1486DOTFILE_DIRS = 1487 1488# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of 1489# nodes that will be shown in the graph. If the number of nodes in a graph 1490# becomes larger than this value, doxygen will truncate the graph, which is 1491# visualized by representing a node as a red box. Note that doxygen if the 1492# number of direct children of the root node in a graph is already larger than 1493# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note 1494# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. 1495 1496DOT_GRAPH_MAX_NODES = 50 1497 1498# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 1499# graphs generated by dot. A depth value of 3 means that only nodes reachable 1500# from the root by following a path via at most 3 edges will be shown. Nodes 1501# that lay further from the root node will be omitted. Note that setting this 1502# option to 1 or 2 may greatly reduce the computation time needed for large 1503# code bases. Also note that the size of a graph can be further restricted by 1504# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. 1505 1506MAX_DOT_GRAPH_DEPTH = 0 1507 1508# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 1509# background. This is disabled by default, because dot on Windows does not 1510# seem to support this out of the box. Warning: Depending on the platform used, 1511# enabling this option may lead to badly anti-aliased labels on the edges of 1512# a graph (i.e. they become hard to read). 1513 1514DOT_TRANSPARENT = NO 1515 1516# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output 1517# files in one run (i.e. multiple -o and -T options on the command line). This 1518# makes dot run faster, but since only newer versions of dot (>1.8.10) 1519# support this, this feature is disabled by default. 1520 1521DOT_MULTI_TARGETS = NO 1522 1523# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 1524# generate a legend page explaining the meaning of the various boxes and 1525# arrows in the dot generated graphs. 1526 1527GENERATE_LEGEND = YES 1528 1529# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 1530# remove the intermediate dot files that are used to generate 1531# the various graphs. 1532 1533DOT_CLEANUP = YES 1534