1# Doxyfile 1.5.5 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 = "Lhasa" 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 = . 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, Farsi, Finnish, French, German, Greek, 58# Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages), 59# Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish, 60# Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, 61# and Ukrainian. 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 = NO 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 = lib/public/ 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 = YES 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 = 8 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# 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# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 241# tag is set to YES, then doxygen will reuse the documentation of the first 242# member in the group (if any) for the other members of the group. By default 243# all members of a group must be documented explicitly. 244 245DISTRIBUTE_GROUP_DOC = NO 246 247# Set the SUBGROUPING tag to YES (the default) to allow class member groups of 248# the same type (for instance a group of public functions) to be put as a 249# subgroup of that type (e.g. under the Public Functions section). Set it to 250# NO to prevent subgrouping. Alternatively, this can be done per class using 251# the \nosubgrouping command. 252 253SUBGROUPING = YES 254 255# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum 256# is documented as struct, union, or enum with the name of the typedef. So 257# typedef struct TypeS {} TypeT, will appear in the documentation as a struct 258# with name TypeT. When disabled the typedef will appear as a member of a file, 259# namespace, or class. And the struct will be named TypeS. This can typically 260# be useful for C code in case the coding convention dictates that all compound 261# types are typedef'ed and only the typedef is referenced, never the tag name. 262 263TYPEDEF_HIDES_STRUCT = NO 264 265#--------------------------------------------------------------------------- 266# Build related configuration options 267#--------------------------------------------------------------------------- 268 269# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 270# documentation are documented, even if no documentation was available. 271# Private class members and static file members will be hidden unless 272# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES 273 274EXTRACT_ALL = NO 275 276# If the EXTRACT_PRIVATE tag is set to YES all private members of a class 277# will be included in the documentation. 278 279EXTRACT_PRIVATE = NO 280 281# If the EXTRACT_STATIC tag is set to YES all static members of a file 282# will be included in the documentation. 283 284EXTRACT_STATIC = NO 285 286# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 287# defined locally in source files will be included in the documentation. 288# If set to NO only classes defined in header files are included. 289 290EXTRACT_LOCAL_CLASSES = YES 291 292# This flag is only useful for Objective-C code. When set to YES local 293# methods, which are defined in the implementation section but not in 294# the interface are included in the documentation. 295# If set to NO (the default) only methods in the interface are included. 296 297EXTRACT_LOCAL_METHODS = NO 298 299# If this flag is set to YES, the members of anonymous namespaces will be 300# extracted and appear in the documentation as a namespace called 301# 'anonymous_namespace{file}', where file will be replaced with the base 302# name of the file that contains the anonymous namespace. By default 303# anonymous namespace are hidden. 304 305EXTRACT_ANON_NSPACES = NO 306 307# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 308# undocumented members of documented classes, files or namespaces. 309# If set to NO (the default) these members will be included in the 310# various overviews, but no documentation section is generated. 311# This option has no effect if EXTRACT_ALL is enabled. 312 313HIDE_UNDOC_MEMBERS = YES 314 315# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 316# undocumented classes that are normally visible in the class hierarchy. 317# If set to NO (the default) these classes will be included in the various 318# overviews. This option has no effect if EXTRACT_ALL is enabled. 319 320HIDE_UNDOC_CLASSES = YES 321 322# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 323# friend (class|struct|union) declarations. 324# If set to NO (the default) these declarations will be included in the 325# documentation. 326 327HIDE_FRIEND_COMPOUNDS = NO 328 329# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 330# documentation blocks found inside the body of a function. 331# If set to NO (the default) these blocks will be appended to the 332# function's detailed documentation block. 333 334HIDE_IN_BODY_DOCS = NO 335 336# The INTERNAL_DOCS tag determines if documentation 337# that is typed after a \internal command is included. If the tag is set 338# to NO (the default) then the documentation will be excluded. 339# Set it to YES to include the internal documentation. 340 341INTERNAL_DOCS = NO 342 343# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 344# file names in lower-case letters. If set to YES upper-case letters are also 345# allowed. This is useful if you have classes or files whose names only differ 346# in case and if your file system supports case sensitive file names. Windows 347# and Mac users are advised to set this option to NO. 348 349CASE_SENSE_NAMES = YES 350 351# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 352# will show members with their full class and namespace scopes in the 353# documentation. If set to YES the scope will be hidden. 354 355HIDE_SCOPE_NAMES = NO 356 357# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 358# will put a list of the files that are included by a file in the documentation 359# of that file. 360 361SHOW_INCLUDE_FILES = NO 362 363# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 364# is inserted in the documentation for inline members. 365 366INLINE_INFO = YES 367 368# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 369# will sort the (detailed) documentation of file and class members 370# alphabetically by member name. If set to NO the members will appear in 371# declaration order. 372 373SORT_MEMBER_DOCS = YES 374 375# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 376# brief documentation of file, namespace and class members alphabetically 377# by member name. If set to NO (the default) the members will appear in 378# declaration order. 379 380SORT_BRIEF_DOCS = NO 381 382# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the 383# hierarchy of group names into alphabetical order. If set to NO (the default) 384# the group names will appear in their defined order. 385 386SORT_GROUP_NAMES = NO 387 388# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 389# sorted by fully-qualified names, including namespaces. If set to 390# NO (the default), the class list will be sorted only by class name, 391# not including the namespace part. 392# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 393# Note: This option applies only to the class list, not to the 394# alphabetical list. 395 396SORT_BY_SCOPE_NAME = NO 397 398# The GENERATE_TODOLIST tag can be used to enable (YES) or 399# disable (NO) the todo list. This list is created by putting \todo 400# commands in the documentation. 401 402GENERATE_TODOLIST = YES 403 404# The GENERATE_TESTLIST tag can be used to enable (YES) or 405# disable (NO) the test list. This list is created by putting \test 406# commands in the documentation. 407 408GENERATE_TESTLIST = YES 409 410# The GENERATE_BUGLIST tag can be used to enable (YES) or 411# disable (NO) the bug list. This list is created by putting \bug 412# commands in the documentation. 413 414GENERATE_BUGLIST = YES 415 416# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 417# disable (NO) the deprecated list. This list is created by putting 418# \deprecated commands in the documentation. 419 420GENERATE_DEPRECATEDLIST= YES 421 422# The ENABLED_SECTIONS tag can be used to enable conditional 423# documentation sections, marked by \if sectionname ... \endif. 424 425ENABLED_SECTIONS = 426 427# The MAX_INITIALIZER_LINES tag determines the maximum number of lines 428# the initial value of a variable or define consists of for it to appear in 429# the documentation. If the initializer consists of more lines than specified 430# here it will be hidden. Use a value of 0 to hide initializers completely. 431# The appearance of the initializer of individual variables and defines in the 432# documentation can be controlled using \showinitializer or \hideinitializer 433# command in the documentation regardless of this setting. 434 435MAX_INITIALIZER_LINES = 30 436 437# Set the SHOW_USED_FILES tag to NO to disable the list of files generated 438# at the bottom of the documentation of classes and structs. If set to YES the 439# list will mention the files that were used to generate the documentation. 440 441SHOW_USED_FILES = YES 442 443# If the sources in your project are distributed over multiple directories 444# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy 445# in the documentation. The default is NO. 446 447SHOW_DIRECTORIES = NO 448 449# The FILE_VERSION_FILTER tag can be used to specify a program or script that 450# doxygen should invoke to get the current version for each file (typically from 451# the version control system). Doxygen will invoke the program by executing (via 452# popen()) the command <command> <input-file>, where <command> is the value of 453# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file 454# provided by doxygen. Whatever the program writes to standard output 455# is used as the file version. See the manual for examples. 456 457FILE_VERSION_FILTER = 458 459#--------------------------------------------------------------------------- 460# configuration options related to warning and progress messages 461#--------------------------------------------------------------------------- 462 463# The QUIET tag can be used to turn on/off the messages that are generated 464# by doxygen. Possible values are YES and NO. If left blank NO is used. 465 466QUIET = NO 467 468# The WARNINGS tag can be used to turn on/off the warning messages that are 469# generated by doxygen. Possible values are YES and NO. If left blank 470# NO is used. 471 472WARNINGS = YES 473 474# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 475# for undocumented members. If EXTRACT_ALL is set to YES then this flag will 476# automatically be disabled. 477 478WARN_IF_UNDOCUMENTED = YES 479 480# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 481# potential errors in the documentation, such as not documenting some 482# parameters in a documented function, or documenting parameters that 483# don't exist or using markup commands wrongly. 484 485WARN_IF_DOC_ERROR = YES 486 487# This WARN_NO_PARAMDOC option can be abled to get warnings for 488# functions that are documented, but have no documentation for their parameters 489# or return value. If set to NO (the default) doxygen will only warn about 490# wrong or incomplete parameter documentation, but not about the absence of 491# documentation. 492 493WARN_NO_PARAMDOC = NO 494 495# The WARN_FORMAT tag determines the format of the warning messages that 496# doxygen can produce. The string should contain the $file, $line, and $text 497# tags, which will be replaced by the file and line number from which the 498# warning originated and the warning text. Optionally the format may contain 499# $version, which will be replaced by the version of the file (if it could 500# be obtained via FILE_VERSION_FILTER) 501 502WARN_FORMAT = "$file:$line: $text" 503 504# The WARN_LOGFILE tag can be used to specify a file to which warning 505# and error messages should be written. If left blank the output is written 506# to stderr. 507 508WARN_LOGFILE = 509 510#--------------------------------------------------------------------------- 511# configuration options related to the input files 512#--------------------------------------------------------------------------- 513 514# The INPUT tag can be used to specify the files and/or directories that contain 515# documented source files. You may enter file names like "myfile.cpp" or 516# directories like "/usr/src/myproject". Separate the files or directories 517# with spaces. 518 519INPUT = intro.h \ 520 ../lib/public 521 522# This tag can be used to specify the character encoding of the source files 523# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is 524# also the default input encoding. Doxygen uses libiconv (or the iconv built 525# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for 526# the list of possible encodings. 527 528INPUT_ENCODING = UTF-8 529 530# If the value of the INPUT tag contains directories, you can use the 531# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 532# and *.h) to filter out the source-files in the directories. If left 533# blank the following patterns are tested: 534# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx 535# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 536 537FILE_PATTERNS = *.h 538 539# The RECURSIVE tag can be used to turn specify whether or not subdirectories 540# should be searched for input files as well. Possible values are YES and NO. 541# If left blank NO is used. 542 543RECURSIVE = NO 544 545# The EXCLUDE tag can be used to specify files and/or directories that should 546# excluded from the INPUT source files. This way you can easily exclude a 547# subdirectory from a directory tree whose root is specified with the INPUT tag. 548 549EXCLUDE = 550 551# The EXCLUDE_SYMLINKS tag can be used select whether or not files or 552# directories that are symbolic links (a Unix filesystem feature) are excluded 553# from the input. 554 555EXCLUDE_SYMLINKS = NO 556 557# If the value of the INPUT tag contains directories, you can use the 558# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 559# certain files from those directories. Note that the wildcards are matched 560# against the file with absolute path, so to exclude all test directories 561# for example use the pattern */test/* 562 563EXCLUDE_PATTERNS = 564 565# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 566# (namespaces, classes, functions, etc.) that should be excluded from the 567# output. The symbol name can be a fully qualified name, a word, or if the 568# wildcard * is used, a substring. Examples: ANamespace, AClass, 569# AClass::ANamespace, ANamespace::*Test 570 571EXCLUDE_SYMBOLS = 572 573# The EXAMPLE_PATH tag can be used to specify one or more files or 574# directories that contain example code fragments that are included (see 575# the \include command). 576 577EXAMPLE_PATH = 578 579# If the value of the EXAMPLE_PATH tag contains directories, you can use the 580# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 581# and *.h) to filter out the source-files in the directories. If left 582# blank all files are included. 583 584EXAMPLE_PATTERNS = * 585 586# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 587# searched for input files to be used with the \include or \dontinclude 588# commands irrespective of the value of the RECURSIVE tag. 589# Possible values are YES and NO. If left blank NO is used. 590 591EXAMPLE_RECURSIVE = NO 592 593# The IMAGE_PATH tag can be used to specify one or more files or 594# directories that contain image that are included in the documentation (see 595# the \image command). 596 597IMAGE_PATH = 598 599# The INPUT_FILTER tag can be used to specify a program that doxygen should 600# invoke to filter for each input file. Doxygen will invoke the filter program 601# by executing (via popen()) the command <filter> <input-file>, where <filter> 602# is the value of the INPUT_FILTER tag, and <input-file> is the name of an 603# input file. Doxygen will then use the output that the filter program writes 604# to standard output. If FILTER_PATTERNS is specified, this tag will be 605# ignored. 606 607INPUT_FILTER = 608 609# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 610# basis. Doxygen will compare the file name with each pattern and apply the 611# filter if there is a match. The filters are a list of the form: 612# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 613# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER 614# is applied to all files. 615 616FILTER_PATTERNS = 617 618# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 619# INPUT_FILTER) will be used to filter the input files when producing source 620# files to browse (i.e. when SOURCE_BROWSER is set to YES). 621 622FILTER_SOURCE_FILES = NO 623 624#--------------------------------------------------------------------------- 625# configuration options related to source browsing 626#--------------------------------------------------------------------------- 627 628# If the SOURCE_BROWSER tag is set to YES then a list of source files will 629# be generated. Documented entities will be cross-referenced with these sources. 630# Note: To get rid of all source code in the generated output, make sure also 631# VERBATIM_HEADERS is set to NO. 632 633SOURCE_BROWSER = NO 634 635# Setting the INLINE_SOURCES tag to YES will include the body 636# of functions and classes directly in the documentation. 637 638INLINE_SOURCES = NO 639 640# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 641# doxygen to hide any special comment blocks from generated source code 642# fragments. Normal C and C++ comments will always remain visible. 643 644STRIP_CODE_COMMENTS = YES 645 646# If the REFERENCED_BY_RELATION tag is set to YES (the default) 647# then for each documented function all documented 648# functions referencing it will be listed. 649 650REFERENCED_BY_RELATION = NO 651 652# If the REFERENCES_RELATION tag is set to YES (the default) 653# then for each documented function all documented entities 654# called/used by that function will be listed. 655 656REFERENCES_RELATION = NO 657 658# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) 659# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from 660# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will 661# link to the source code. Otherwise they will link to the documentstion. 662 663REFERENCES_LINK_SOURCE = YES 664 665# If the USE_HTAGS tag is set to YES then the references to source code 666# will point to the HTML generated by the htags(1) tool instead of doxygen 667# built-in source browser. The htags tool is part of GNU's global source 668# tagging system (see http://www.gnu.org/software/global/global.html). You 669# will need version 4.8.6 or higher. 670 671USE_HTAGS = NO 672 673# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 674# will generate a verbatim copy of the header file for each class for 675# which an include is specified. Set to NO to disable this. 676 677VERBATIM_HEADERS = NO 678 679#--------------------------------------------------------------------------- 680# configuration options related to the alphabetical class index 681#--------------------------------------------------------------------------- 682 683# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 684# of all compounds will be generated. Enable this if the project 685# contains a lot of classes, structs, unions or interfaces. 686 687ALPHABETICAL_INDEX = NO 688 689# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 690# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 691# in which this list will be split (can be a number in the range [1..20]) 692 693COLS_IN_ALPHA_INDEX = 5 694 695# In case all classes in a project start with a common prefix, all 696# classes will be put under the same header in the alphabetical index. 697# The IGNORE_PREFIX tag can be used to specify one or more prefixes that 698# should be ignored while generating the index headers. 699 700IGNORE_PREFIX = 701 702#--------------------------------------------------------------------------- 703# configuration options related to the HTML output 704#--------------------------------------------------------------------------- 705 706# If the GENERATE_HTML tag is set to YES (the default) Doxygen will 707# generate HTML output. 708 709GENERATE_HTML = YES 710 711# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 712# If a relative path is entered the value of OUTPUT_DIRECTORY will be 713# put in front of it. If left blank `html' will be used as the default path. 714 715HTML_OUTPUT = html 716 717# The HTML_FILE_EXTENSION tag can be used to specify the file extension for 718# each generated HTML page (for example: .htm,.php,.asp). If it is left blank 719# doxygen will generate files with .html extension. 720 721HTML_FILE_EXTENSION = .html 722 723# The HTML_HEADER tag can be used to specify a personal HTML header for 724# each generated HTML page. If it is left blank doxygen will generate a 725# standard header. 726 727HTML_HEADER = 728 729# The HTML_FOOTER tag can be used to specify a personal HTML footer for 730# each generated HTML page. If it is left blank doxygen will generate a 731# standard footer. 732 733HTML_FOOTER = 734 735# The HTML_STYLESHEET tag can be used to specify a user-defined cascading 736# style sheet that is used by each HTML page. It can be used to 737# fine-tune the look of the HTML output. If the tag is left blank doxygen 738# will generate a default style sheet. Note that doxygen will try to copy 739# the style sheet file to the HTML output directory, so don't put your own 740# stylesheet in the HTML output directory as well, or it will be erased! 741 742HTML_STYLESHEET = 743 744# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 745# files or namespaces will be aligned in HTML using tables. If set to 746# NO a bullet list will be used. 747 748HTML_ALIGN_MEMBERS = YES 749 750# If the GENERATE_HTMLHELP tag is set to YES, additional index files 751# will be generated that can be used as input for tools like the 752# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) 753# of the generated HTML documentation. 754 755GENERATE_HTMLHELP = NO 756 757# If the GENERATE_DOCSET tag is set to YES, additional index files 758# will be generated that can be used as input for Apple's Xcode 3 759# integrated development environment, introduced with OSX 10.5 (Leopard). 760# To create a documentation set, doxygen will generate a Makefile in the 761# HTML output directory. Running make will produce the docset in that 762# directory and running "make install" will install the docset in 763# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find 764# it at startup. 765 766GENERATE_DOCSET = NO 767 768# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the 769# feed. A documentation feed provides an umbrella under which multiple 770# documentation sets from a single provider (such as a company or product suite) 771# can be grouped. 772 773DOCSET_FEEDNAME = "Doxygen generated docs" 774 775# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that 776# should uniquely identify the documentation set bundle. This should be a 777# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen 778# will append .docset to the name. 779 780DOCSET_BUNDLE_ID = org.doxygen.Project 781 782# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 783# documentation will contain sections that can be hidden and shown after the 784# page has loaded. For this to work a browser that supports 785# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox 786# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). 787 788HTML_DYNAMIC_SECTIONS = NO 789 790# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 791# be used to specify the file name of the resulting .chm file. You 792# can add a path in front of the file if the result should not be 793# written to the html output directory. 794 795CHM_FILE = 796 797# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 798# be used to specify the location (absolute path including file name) of 799# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 800# the HTML help compiler on the generated index.hhp. 801 802HHC_LOCATION = 803 804# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 805# controls if a separate .chi index file is generated (YES) or that 806# it should be included in the master .chm file (NO). 807 808GENERATE_CHI = NO 809 810# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 811# controls whether a binary table of contents is generated (YES) or a 812# normal table of contents (NO) in the .chm file. 813 814BINARY_TOC = NO 815 816# The TOC_EXPAND flag can be set to YES to add extra items for group members 817# to the contents of the HTML help documentation and to the tree view. 818 819TOC_EXPAND = NO 820 821# The DISABLE_INDEX tag can be used to turn on/off the condensed index at 822# top of each HTML page. The value NO (the default) enables the index and 823# the value YES disables it. 824 825DISABLE_INDEX = NO 826 827# This tag can be used to set the number of enum values (range [1..20]) 828# that doxygen will group on one line in the generated HTML documentation. 829 830ENUM_VALUES_PER_LINE = 4 831 832# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be 833# generated containing a tree-like index structure (just like the one that 834# is generated for HTML Help). For this to work a browser that supports 835# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, 836# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are 837# probably better off using the HTML help feature. 838 839GENERATE_TREEVIEW = NO 840 841# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 842# used to set the initial width (in pixels) of the frame in which the tree 843# is shown. 844 845TREEVIEW_WIDTH = 250 846 847#--------------------------------------------------------------------------- 848# configuration options related to the LaTeX output 849#--------------------------------------------------------------------------- 850 851# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 852# generate Latex output. 853 854GENERATE_LATEX = NO 855 856# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 857# If a relative path is entered the value of OUTPUT_DIRECTORY will be 858# put in front of it. If left blank `latex' will be used as the default path. 859 860LATEX_OUTPUT = latex 861 862# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 863# invoked. If left blank `latex' will be used as the default command name. 864 865LATEX_CMD_NAME = latex 866 867# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 868# generate index for LaTeX. If left blank `makeindex' will be used as the 869# default command name. 870 871MAKEINDEX_CMD_NAME = makeindex 872 873# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 874# LaTeX documents. This may be useful for small projects and may help to 875# save some trees in general. 876 877COMPACT_LATEX = NO 878 879# The PAPER_TYPE tag can be used to set the paper type that is used 880# by the printer. Possible values are: a4, a4wide, letter, legal and 881# executive. If left blank a4wide will be used. 882 883PAPER_TYPE = a4wide 884 885# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 886# packages that should be included in the LaTeX output. 887 888EXTRA_PACKAGES = 889 890# The LATEX_HEADER tag can be used to specify a personal LaTeX header for 891# the generated latex document. The header should contain everything until 892# the first chapter. If it is left blank doxygen will generate a 893# standard header. Notice: only use this tag if you know what you are doing! 894 895LATEX_HEADER = 896 897# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 898# is prepared for conversion to pdf (using ps2pdf). The pdf file will 899# contain links (just like the HTML output) instead of page references 900# This makes the output suitable for online browsing using a pdf viewer. 901 902PDF_HYPERLINKS = NO 903 904# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 905# plain latex in the generated Makefile. Set this option to YES to get a 906# higher quality PDF documentation. 907 908USE_PDFLATEX = YES 909 910# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 911# command to the generated LaTeX files. This will instruct LaTeX to keep 912# running if errors occur, instead of asking the user for help. 913# This option is also used when generating formulas in HTML. 914 915LATEX_BATCHMODE = NO 916 917# If LATEX_HIDE_INDICES is set to YES then doxygen will not 918# include the index chapters (such as File Index, Compound Index, etc.) 919# in the output. 920 921LATEX_HIDE_INDICES = NO 922 923#--------------------------------------------------------------------------- 924# configuration options related to the RTF output 925#--------------------------------------------------------------------------- 926 927# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 928# The RTF output is optimized for Word 97 and may not look very pretty with 929# other RTF readers or editors. 930 931GENERATE_RTF = NO 932 933# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 934# If a relative path is entered the value of OUTPUT_DIRECTORY will be 935# put in front of it. If left blank `rtf' will be used as the default path. 936 937RTF_OUTPUT = rtf 938 939# If the COMPACT_RTF tag is set to YES Doxygen generates more compact 940# RTF documents. This may be useful for small projects and may help to 941# save some trees in general. 942 943COMPACT_RTF = NO 944 945# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 946# will contain hyperlink fields. The RTF file will 947# contain links (just like the HTML output) instead of page references. 948# This makes the output suitable for online browsing using WORD or other 949# programs which support those fields. 950# Note: wordpad (write) and others do not support links. 951 952RTF_HYPERLINKS = NO 953 954# Load stylesheet definitions from file. Syntax is similar to doxygen's 955# config file, i.e. a series of assignments. You only have to provide 956# replacements, missing definitions are set to their default value. 957 958RTF_STYLESHEET_FILE = 959 960# Set optional variables used in the generation of an rtf document. 961# Syntax is similar to doxygen's config file. 962 963RTF_EXTENSIONS_FILE = 964 965#--------------------------------------------------------------------------- 966# configuration options related to the man page output 967#--------------------------------------------------------------------------- 968 969# If the GENERATE_MAN tag is set to YES (the default) Doxygen will 970# generate man pages 971 972GENERATE_MAN = NO 973 974# The MAN_OUTPUT tag is used to specify where the man pages will be put. 975# If a relative path is entered the value of OUTPUT_DIRECTORY will be 976# put in front of it. If left blank `man' will be used as the default path. 977 978MAN_OUTPUT = man 979 980# The MAN_EXTENSION tag determines the extension that is added to 981# the generated man pages (default is the subroutine's section .3) 982 983MAN_EXTENSION = .3 984 985# If the MAN_LINKS tag is set to YES and Doxygen generates man output, 986# then it will generate one additional man file for each entity 987# documented in the real man page(s). These additional files 988# only source the real man page, but without them the man command 989# would be unable to find the correct page. The default is NO. 990 991MAN_LINKS = YES 992 993#--------------------------------------------------------------------------- 994# configuration options related to the XML output 995#--------------------------------------------------------------------------- 996 997# If the GENERATE_XML tag is set to YES Doxygen will 998# generate an XML file that captures the structure of 999# the code including all documentation. 1000 1001GENERATE_XML = NO 1002 1003# The XML_OUTPUT tag is used to specify where the XML pages will be put. 1004# If a relative path is entered the value of OUTPUT_DIRECTORY will be 1005# put in front of it. If left blank `xml' will be used as the default path. 1006 1007XML_OUTPUT = xml 1008 1009# The XML_SCHEMA tag can be used to specify an XML schema, 1010# which can be used by a validating XML parser to check the 1011# syntax of the XML files. 1012 1013XML_SCHEMA = 1014 1015# The XML_DTD tag can be used to specify an XML DTD, 1016# which can be used by a validating XML parser to check the 1017# syntax of the XML files. 1018 1019XML_DTD = 1020 1021# If the XML_PROGRAMLISTING tag is set to YES Doxygen will 1022# dump the program listings (including syntax highlighting 1023# and cross-referencing information) to the XML output. Note that 1024# enabling this will significantly increase the size of the XML output. 1025 1026XML_PROGRAMLISTING = YES 1027 1028#--------------------------------------------------------------------------- 1029# configuration options for the AutoGen Definitions output 1030#--------------------------------------------------------------------------- 1031 1032# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 1033# generate an AutoGen Definitions (see autogen.sf.net) file 1034# that captures the structure of the code including all 1035# documentation. Note that this feature is still experimental 1036# and incomplete at the moment. 1037 1038GENERATE_AUTOGEN_DEF = NO 1039 1040#--------------------------------------------------------------------------- 1041# configuration options related to the Perl module output 1042#--------------------------------------------------------------------------- 1043 1044# If the GENERATE_PERLMOD tag is set to YES Doxygen will 1045# generate a Perl module file that captures the structure of 1046# the code including all documentation. Note that this 1047# feature is still experimental and incomplete at the 1048# moment. 1049 1050GENERATE_PERLMOD = NO 1051 1052# If the PERLMOD_LATEX tag is set to YES Doxygen will generate 1053# the necessary Makefile rules, Perl scripts and LaTeX code to be able 1054# to generate PDF and DVI output from the Perl module output. 1055 1056PERLMOD_LATEX = NO 1057 1058# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 1059# nicely formatted so it can be parsed by a human reader. This is useful 1060# if you want to understand what is going on. On the other hand, if this 1061# tag is set to NO the size of the Perl module output will be much smaller 1062# and Perl will parse it just the same. 1063 1064PERLMOD_PRETTY = YES 1065 1066# The names of the make variables in the generated doxyrules.make file 1067# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 1068# This is useful so different doxyrules.make files included by the same 1069# Makefile don't overwrite each other's variables. 1070 1071PERLMOD_MAKEVAR_PREFIX = 1072 1073#--------------------------------------------------------------------------- 1074# Configuration options related to the preprocessor 1075#--------------------------------------------------------------------------- 1076 1077# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 1078# evaluate all C-preprocessor directives found in the sources and include 1079# files. 1080 1081ENABLE_PREPROCESSING = YES 1082 1083# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 1084# names in the source code. If set to NO (the default) only conditional 1085# compilation will be performed. Macro expansion can be done in a controlled 1086# way by setting EXPAND_ONLY_PREDEF to YES. 1087 1088MACRO_EXPANSION = NO 1089 1090# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 1091# then the macro expansion is limited to the macros specified with the 1092# PREDEFINED and EXPAND_AS_DEFINED tags. 1093 1094EXPAND_ONLY_PREDEF = NO 1095 1096# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 1097# in the INCLUDE_PATH (see below) will be search if a #include is found. 1098 1099SEARCH_INCLUDES = YES 1100 1101# The INCLUDE_PATH tag can be used to specify one or more directories that 1102# contain include files that are not input files but should be processed by 1103# the preprocessor. 1104 1105INCLUDE_PATH = 1106 1107# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 1108# patterns (like *.h and *.hpp) to filter out the header-files in the 1109# directories. If left blank, the patterns specified with FILE_PATTERNS will 1110# be used. 1111 1112INCLUDE_FILE_PATTERNS = 1113 1114# The PREDEFINED tag can be used to specify one or more macro names that 1115# are defined before the preprocessor is started (similar to the -D option of 1116# gcc). The argument of the tag is a list of macros of the form: name 1117# or name=definition (no spaces). If the definition and the = are 1118# omitted =1 is assumed. To prevent a macro definition from being 1119# undefined via #undef or recursively expanded use the := operator 1120# instead of the = operator. 1121 1122PREDEFINED = 1123 1124# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 1125# this tag can be used to specify a list of macro names that should be expanded. 1126# The macro definition that is found in the sources will be used. 1127# Use the PREDEFINED tag if you want to use a different macro definition. 1128 1129EXPAND_AS_DEFINED = 1130 1131# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 1132# doxygen's preprocessor will remove all function-like macros that are alone 1133# on a line, have an all uppercase name, and do not end with a semicolon. Such 1134# function macros are typically used for boiler-plate code, and will confuse 1135# the parser if not removed. 1136 1137SKIP_FUNCTION_MACROS = YES 1138 1139#--------------------------------------------------------------------------- 1140# Configuration::additions related to external references 1141#--------------------------------------------------------------------------- 1142 1143# The TAGFILES option can be used to specify one or more tagfiles. 1144# Optionally an initial location of the external documentation 1145# can be added for each tagfile. The format of a tag file without 1146# this location is as follows: 1147# TAGFILES = file1 file2 ... 1148# Adding location for the tag files is done as follows: 1149# TAGFILES = file1=loc1 "file2 = loc2" ... 1150# where "loc1" and "loc2" can be relative or absolute paths or 1151# URLs. If a location is present for each tag, the installdox tool 1152# does not have to be run to correct the links. 1153# Note that each tag file must have a unique name 1154# (where the name does NOT include the path) 1155# If a tag file is not located in the directory in which doxygen 1156# is run, you must also specify the path to the tagfile here. 1157 1158TAGFILES = 1159 1160# When a file name is specified after GENERATE_TAGFILE, doxygen will create 1161# a tag file that is based on the input files it reads. 1162 1163GENERATE_TAGFILE = 1164 1165# If the ALLEXTERNALS tag is set to YES all external classes will be listed 1166# in the class index. If set to NO only the inherited external classes 1167# will be listed. 1168 1169ALLEXTERNALS = NO 1170 1171# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 1172# in the modules index. If set to NO, only the current project's groups will 1173# be listed. 1174 1175EXTERNAL_GROUPS = YES 1176 1177# The PERL_PATH should be the absolute path and name of the perl script 1178# interpreter (i.e. the result of `which perl'). 1179 1180PERL_PATH = /usr/bin/perl 1181 1182#--------------------------------------------------------------------------- 1183# Configuration options related to the dot tool 1184#--------------------------------------------------------------------------- 1185 1186# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 1187# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base 1188# or super classes. Setting the tag to NO turns the diagrams off. Note that 1189# this option is superseded by the HAVE_DOT option below. This is only a 1190# fallback. It is recommended to install and use dot, since it yields more 1191# powerful graphs. 1192 1193CLASS_DIAGRAMS = NO 1194 1195# You can define message sequence charts within doxygen comments using the \msc 1196# command. Doxygen will then run the mscgen tool (see 1197# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the 1198# documentation. The MSCGEN_PATH tag allows you to specify the directory where 1199# the mscgen tool resides. If left empty the tool is assumed to be found in the 1200# default search path. 1201 1202MSCGEN_PATH = 1203 1204# If set to YES, the inheritance and collaboration graphs will hide 1205# inheritance and usage relations if the target is undocumented 1206# or is not a class. 1207 1208HIDE_UNDOC_RELATIONS = YES 1209 1210# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 1211# available from the path. This tool is part of Graphviz, a graph visualization 1212# toolkit from AT&T and Lucent Bell Labs. The other options in this section 1213# have no effect if this option is set to NO (the default) 1214 1215HAVE_DOT = NO 1216 1217# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 1218# will generate a graph for each documented class showing the direct and 1219# indirect inheritance relations. Setting this tag to YES will force the 1220# the CLASS_DIAGRAMS tag to NO. 1221 1222CLASS_GRAPH = YES 1223 1224# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 1225# will generate a graph for each documented class showing the direct and 1226# indirect implementation dependencies (inheritance, containment, and 1227# class references variables) of the class with other documented classes. 1228 1229COLLABORATION_GRAPH = YES 1230 1231# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen 1232# will generate a graph for groups, showing the direct groups dependencies 1233 1234GROUP_GRAPHS = YES 1235 1236# If the UML_LOOK tag is set to YES doxygen will generate inheritance and 1237# collaboration diagrams in a style similar to the OMG's Unified Modeling 1238# Language. 1239 1240UML_LOOK = NO 1241 1242# If set to YES, the inheritance and collaboration graphs will show the 1243# relations between templates and their instances. 1244 1245TEMPLATE_RELATIONS = NO 1246 1247# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 1248# tags are set to YES then doxygen will generate a graph for each documented 1249# file showing the direct and indirect include dependencies of the file with 1250# other documented files. 1251 1252INCLUDE_GRAPH = YES 1253 1254# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 1255# HAVE_DOT tags are set to YES then doxygen will generate a graph for each 1256# documented header file showing the documented files that directly or 1257# indirectly include this file. 1258 1259INCLUDED_BY_GRAPH = YES 1260 1261# If the CALL_GRAPH and HAVE_DOT options are set to YES then 1262# doxygen will generate a call dependency graph for every global function 1263# or class method. Note that enabling this option will significantly increase 1264# the time of a run. So in most cases it will be better to enable call graphs 1265# for selected functions only using the \callgraph command. 1266 1267CALL_GRAPH = NO 1268 1269# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then 1270# doxygen will generate a caller dependency graph for every global function 1271# or class method. Note that enabling this option will significantly increase 1272# the time of a run. So in most cases it will be better to enable caller 1273# graphs for selected functions only using the \callergraph command. 1274 1275CALLER_GRAPH = NO 1276 1277# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 1278# will graphical hierarchy of all classes instead of a textual one. 1279 1280GRAPHICAL_HIERARCHY = YES 1281 1282# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES 1283# then doxygen will show the dependencies a directory has on other directories 1284# in a graphical way. The dependency relations are determined by the #include 1285# relations between the files in the directories. 1286 1287DIRECTORY_GRAPH = YES 1288 1289# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 1290# generated by dot. Possible values are png, jpg, or gif 1291# If left blank png will be used. 1292 1293DOT_IMAGE_FORMAT = png 1294 1295# The tag DOT_PATH can be used to specify the path where the dot tool can be 1296# found. If left blank, it is assumed the dot tool can be found in the path. 1297 1298DOT_PATH = 1299 1300# The DOTFILE_DIRS tag can be used to specify one or more directories that 1301# contain dot files that are included in the documentation (see the 1302# \dotfile command). 1303 1304DOTFILE_DIRS = 1305 1306# The MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of 1307# nodes that will be shown in the graph. If the number of nodes in a graph 1308# becomes larger than this value, doxygen will truncate the graph, which is 1309# visualized by representing a node as a red box. Note that doxygen if the 1310# number of direct children of the root node in a graph is already larger than 1311# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note 1312# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. 1313 1314DOT_GRAPH_MAX_NODES = 50 1315 1316# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 1317# graphs generated by dot. A depth value of 3 means that only nodes reachable 1318# from the root by following a path via at most 3 edges will be shown. Nodes 1319# that lay further from the root node will be omitted. Note that setting this 1320# option to 1 or 2 may greatly reduce the computation time needed for large 1321# code bases. Also note that the size of a graph can be further restricted by 1322# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. 1323 1324MAX_DOT_GRAPH_DEPTH = 1000 1325 1326# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 1327# background. This is enabled by default, which results in a transparent 1328# background. Warning: Depending on the platform used, enabling this option 1329# may lead to badly anti-aliased labels on the edges of a graph (i.e. they 1330# become hard to read). 1331 1332DOT_TRANSPARENT = NO 1333 1334# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output 1335# files in one run (i.e. multiple -o and -T options on the command line). This 1336# makes dot run faster, but since only newer versions of dot (>1.8.10) 1337# support this, this feature is disabled by default. 1338 1339DOT_MULTI_TARGETS = NO 1340 1341# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 1342# generate a legend page explaining the meaning of the various boxes and 1343# arrows in the dot generated graphs. 1344 1345GENERATE_LEGEND = YES 1346 1347# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 1348# remove the intermediate dot files that are used to generate 1349# the various graphs. 1350 1351DOT_CLEANUP = YES 1352 1353#--------------------------------------------------------------------------- 1354# Configuration::additions related to the search engine 1355#--------------------------------------------------------------------------- 1356 1357# The SEARCHENGINE tag specifies whether or not a search engine should be 1358# used. If set to NO the values of all tags below this one will be ignored. 1359 1360SEARCHENGINE = NO 1361