1# Doxyfile 1.4.4 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# The PROJECT_NAME tag is a single word (or a sequence of words surrounded 18# by quotes) that should identify the project. 19 20PROJECT_NAME = clang 21 22# The PROJECT_NUMBER tag can be used to enter a project or revision number. 23# This could be handy for archiving the generated documentation or 24# if some version control system is used. 25 26PROJECT_NUMBER = @PACKAGE_VERSION@ 27 28# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 29# base path where the generated documentation will be put. 30# If a relative path is entered, it will be relative to the location 31# where doxygen was started. If left blank the current directory will be used. 32 33OUTPUT_DIRECTORY = @abs_builddir@/doxygen 34 35# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 36# 4096 sub-directories (in 2 levels) under the output directory of each output 37# format and will distribute the generated files over these directories. 38# Enabling this option can be useful when feeding doxygen a huge amount of 39# source files, where putting all generated files in the same directory would 40# otherwise cause performance problems for the file system. 41 42CREATE_SUBDIRS = NO 43 44# The OUTPUT_LANGUAGE tag is used to specify the language in which all 45# documentation generated by doxygen is written. Doxygen will use this 46# information to generate all constant output in the proper language. 47# The default language is English, other supported languages are: 48# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, 49# Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese, 50# Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian, 51# Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, 52# Swedish, and Ukrainian. 53 54OUTPUT_LANGUAGE = English 55 56# This tag can be used to specify the encoding used in the generated output. 57# The encoding is not always determined by the language that is chosen, 58# but also whether or not the output is meant for Windows or non-Windows users. 59# In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES 60# forces the Windows encoding (this is the default for the Windows binary), 61# whereas setting the tag to NO uses a Unix-style encoding (the default for 62# all platforms other than Windows). 63 64USE_WINDOWS_ENCODING = NO 65 66# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 67# include brief member descriptions after the members that are listed in 68# the file and class documentation (similar to JavaDoc). 69# Set to NO to disable this. 70 71BRIEF_MEMBER_DESC = YES 72 73# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 74# the brief description of a member or function before the detailed description. 75# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 76# brief descriptions will be completely suppressed. 77 78REPEAT_BRIEF = YES 79 80# This tag implements a quasi-intelligent brief description abbreviator 81# that is used to form the text in various listings. Each string 82# in this list, if found as the leading text of the brief description, will be 83# stripped from the text and the result after processing the whole list, is 84# used as the annotated text. Otherwise, the brief description is used as-is. 85# If left blank, the following values are used ("$name" is automatically 86# replaced with the name of the entity): "The $name class" "The $name widget" 87# "The $name file" "is" "provides" "specifies" "contains" 88# "represents" "a" "an" "the" 89 90ABBREVIATE_BRIEF = 91 92# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 93# Doxygen will generate a detailed section even if there is only a brief 94# description. 95 96ALWAYS_DETAILED_SEC = NO 97 98# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 99# inherited members of a class in the documentation of that class as if those 100# members were ordinary class members. Constructors, destructors and assignment 101# operators of the base classes will not be shown. 102 103INLINE_INHERITED_MEMB = NO 104 105# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 106# path before files name in the file list and in the header files. If set 107# to NO the shortest path that makes the file name unique will be used. 108 109FULL_PATH_NAMES = NO 110 111# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 112# can be used to strip a user-defined part of the path. Stripping is 113# only done if one of the specified strings matches the left-hand part of 114# the path. The tag can be used to show relative paths in the file list. 115# If left blank the directory from which doxygen is run is used as the 116# path to strip. 117 118STRIP_FROM_PATH = ../.. 119 120# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 121# the path mentioned in the documentation of a class, which tells 122# the reader which header file to include in order to use a class. 123# If left blank only the name of the header file containing the class 124# definition is used. Otherwise one should specify the include paths that 125# are normally passed to the compiler using the -I flag. 126 127STRIP_FROM_INC_PATH = 128 129# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 130# (but less readable) file names. This can be useful is your file systems 131# doesn't support long names like on DOS, Mac, or CD-ROM. 132 133SHORT_NAMES = NO 134 135# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 136# will interpret the first line (until the first dot) of a JavaDoc-style 137# comment as the brief description. If set to NO, the JavaDoc 138# comments will behave just like the Qt-style comments (thus requiring an 139# explicit @brief command for a brief description. 140 141JAVADOC_AUTOBRIEF = NO 142 143# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 144# treat a multi-line C++ special comment block (i.e. a block of //! or /// 145# comments) as a brief description. This used to be the default behaviour. 146# The new default is to treat a multi-line C++ comment block as a detailed 147# description. Set this tag to YES if you prefer the old behaviour instead. 148 149MULTILINE_CPP_IS_BRIEF = NO 150 151# If the DETAILS_AT_TOP tag is set to YES then Doxygen 152# will output the detailed description near the top, like JavaDoc. 153# If set to NO, the detailed description appears after the member 154# documentation. 155 156DETAILS_AT_TOP = NO 157 158# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 159# member inherits the documentation from any documented member that it 160# re-implements. 161 162INHERIT_DOCS = YES 163 164# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 165# tag is set to YES, then doxygen will reuse the documentation of the first 166# member in the group (if any) for the other members of the group. By default 167# all members of a group must be documented explicitly. 168 169DISTRIBUTE_GROUP_DOC = NO 170 171# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce 172# a new page for each member. If set to NO, the documentation of a member will 173# be part of the file/class/namespace that contains it. 174 175#SEPARATE_MEMBER_PAGES = NO 176 177# The TAB_SIZE tag can be used to set the number of spaces in a tab. 178# Doxygen uses this value to replace tabs by spaces in code fragments. 179 180TAB_SIZE = 2 181 182# This tag can be used to specify a number of aliases that acts 183# as commands in the documentation. An alias has the form "name=value". 184# For example adding "sideeffect=\par Side Effects:\n" will allow you to 185# put the command \sideeffect (or @sideeffect) in the documentation, which 186# will result in a user-defined paragraph with heading "Side Effects:". 187# You can put \n's in the value part of an alias to insert newlines. 188 189ALIASES = 190 191# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 192# sources only. Doxygen will then generate output that is more tailored for C. 193# For instance, some of the names that are used will be different. The list 194# of all members will be omitted, etc. 195 196OPTIMIZE_OUTPUT_FOR_C = NO 197 198# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources 199# only. Doxygen will then generate output that is more tailored for Java. 200# For instance, namespaces will be presented as packages, qualified scopes 201# will look different, etc. 202 203OPTIMIZE_OUTPUT_JAVA = NO 204 205# Set the SUBGROUPING tag to YES (the default) to allow class member groups of 206# the same type (for instance a group of public functions) to be put as a 207# subgroup of that type (e.g. under the Public Functions section). Set it to 208# NO to prevent subgrouping. Alternatively, this can be done per class using 209# the \nosubgrouping command. 210 211SUBGROUPING = YES 212 213#--------------------------------------------------------------------------- 214# Build related configuration options 215#--------------------------------------------------------------------------- 216 217# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 218# documentation are documented, even if no documentation was available. 219# Private class members and static file members will be hidden unless 220# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES 221 222EXTRACT_ALL = YES 223 224# If the EXTRACT_PRIVATE tag is set to YES all private members of a class 225# will be included in the documentation. 226 227EXTRACT_PRIVATE = NO 228 229# If the EXTRACT_STATIC tag is set to YES all static members of a file 230# will be included in the documentation. 231 232EXTRACT_STATIC = YES 233 234# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 235# defined locally in source files will be included in the documentation. 236# If set to NO only classes defined in header files are included. 237 238EXTRACT_LOCAL_CLASSES = YES 239 240# This flag is only useful for Objective-C code. When set to YES local 241# methods, which are defined in the implementation section but not in 242# the interface are included in the documentation. 243# If set to NO (the default) only methods in the interface are included. 244 245EXTRACT_LOCAL_METHODS = NO 246 247# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 248# undocumented members of documented classes, files or namespaces. 249# If set to NO (the default) these members will be included in the 250# various overviews, but no documentation section is generated. 251# This option has no effect if EXTRACT_ALL is enabled. 252 253HIDE_UNDOC_MEMBERS = NO 254 255# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 256# undocumented classes that are normally visible in the class hierarchy. 257# If set to NO (the default) these classes will be included in the various 258# overviews. This option has no effect if EXTRACT_ALL is enabled. 259 260HIDE_UNDOC_CLASSES = NO 261 262# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 263# friend (class|struct|union) declarations. 264# If set to NO (the default) these declarations will be included in the 265# documentation. 266 267HIDE_FRIEND_COMPOUNDS = NO 268 269# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 270# documentation blocks found inside the body of a function. 271# If set to NO (the default) these blocks will be appended to the 272# function's detailed documentation block. 273 274HIDE_IN_BODY_DOCS = NO 275 276# The INTERNAL_DOCS tag determines if documentation 277# that is typed after a \internal command is included. If the tag is set 278# to NO (the default) then the documentation will be excluded. 279# Set it to YES to include the internal documentation. 280 281INTERNAL_DOCS = NO 282 283# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 284# file names in lower-case letters. If set to YES upper-case letters are also 285# allowed. This is useful if you have classes or files whose names only differ 286# in case and if your file system supports case sensitive file names. Windows 287# and Mac users are advised to set this option to NO. 288 289CASE_SENSE_NAMES = YES 290 291# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 292# will show members with their full class and namespace scopes in the 293# documentation. If set to YES the scope will be hidden. 294 295HIDE_SCOPE_NAMES = NO 296 297# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 298# will put a list of the files that are included by a file in the documentation 299# of that file. 300 301SHOW_INCLUDE_FILES = YES 302 303# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 304# is inserted in the documentation for inline members. 305 306INLINE_INFO = YES 307 308# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 309# will sort the (detailed) documentation of file and class members 310# alphabetically by member name. If set to NO the members will appear in 311# declaration order. 312 313SORT_MEMBER_DOCS = YES 314 315# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 316# brief documentation of file, namespace and class members alphabetically 317# by member name. If set to NO (the default) the members will appear in 318# declaration order. 319 320SORT_BRIEF_DOCS = NO 321 322# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 323# sorted by fully-qualified names, including namespaces. If set to 324# NO (the default), the class list will be sorted only by class name, 325# not including the namespace part. 326# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 327# Note: This option applies only to the class list, not to the 328# alphabetical list. 329 330SORT_BY_SCOPE_NAME = NO 331 332# The GENERATE_TODOLIST tag can be used to enable (YES) or 333# disable (NO) the todo list. This list is created by putting \todo 334# commands in the documentation. 335 336GENERATE_TODOLIST = YES 337 338# The GENERATE_TESTLIST tag can be used to enable (YES) or 339# disable (NO) the test list. This list is created by putting \test 340# commands in the documentation. 341 342GENERATE_TESTLIST = YES 343 344# The GENERATE_BUGLIST tag can be used to enable (YES) or 345# disable (NO) the bug list. This list is created by putting \bug 346# commands in the documentation. 347 348GENERATE_BUGLIST = YES 349 350# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 351# disable (NO) the deprecated list. This list is created by putting 352# \deprecated commands in the documentation. 353 354GENERATE_DEPRECATEDLIST= YES 355 356# The ENABLED_SECTIONS tag can be used to enable conditional 357# documentation sections, marked by \if sectionname ... \endif. 358 359ENABLED_SECTIONS = 360 361# The MAX_INITIALIZER_LINES tag determines the maximum number of lines 362# the initial value of a variable or define consists of for it to appear in 363# the documentation. If the initializer consists of more lines than specified 364# here it will be hidden. Use a value of 0 to hide initializers completely. 365# The appearance of the initializer of individual variables and defines in the 366# documentation can be controlled using \showinitializer or \hideinitializer 367# command in the documentation regardless of this setting. 368 369MAX_INITIALIZER_LINES = 30 370 371# Set the SHOW_USED_FILES tag to NO to disable the list of files generated 372# at the bottom of the documentation of classes and structs. If set to YES the 373# list will mention the files that were used to generate the documentation. 374 375SHOW_USED_FILES = YES 376 377# If the sources in your project are distributed over multiple directories 378# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy 379# in the documentation. The default is YES. 380 381SHOW_DIRECTORIES = YES 382 383# The FILE_VERSION_FILTER tag can be used to specify a program or script that 384# doxygen should invoke to get the current version for each file (typically from the 385# version control system). Doxygen will invoke the program by executing (via 386# popen()) the command <command> <input-file>, where <command> is the value of 387# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file 388# provided by doxygen. Whatever the progam writes to standard output 389# is used as the file version. See the manual for examples. 390 391#FILE_VERSION_FILTER = 392 393#--------------------------------------------------------------------------- 394# configuration options related to warning and progress messages 395#--------------------------------------------------------------------------- 396 397# The QUIET tag can be used to turn on/off the messages that are generated 398# by doxygen. Possible values are YES and NO. If left blank NO is used. 399 400QUIET = NO 401 402# The WARNINGS tag can be used to turn on/off the warning messages that are 403# generated by doxygen. Possible values are YES and NO. If left blank 404# NO is used. 405 406WARNINGS = NO 407 408# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 409# for undocumented members. If EXTRACT_ALL is set to YES then this flag will 410# automatically be disabled. 411 412WARN_IF_UNDOCUMENTED = NO 413 414# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 415# potential errors in the documentation, such as not documenting some 416# parameters in a documented function, or documenting parameters that 417# don't exist or using markup commands wrongly. 418 419WARN_IF_DOC_ERROR = YES 420 421# This WARN_NO_PARAMDOC option can be abled to get warnings for 422# functions that are documented, but have no documentation for their parameters 423# or return value. If set to NO (the default) doxygen will only warn about 424# wrong or incomplete parameter documentation, but not about the absence of 425# documentation. 426 427#WARN_NO_PARAMDOC = NO 428 429# The WARN_FORMAT tag determines the format of the warning messages that 430# doxygen can produce. The string should contain the $file, $line, and $text 431# tags, which will be replaced by the file and line number from which the 432# warning originated and the warning text. Optionally the format may contain 433# $version, which will be replaced by the version of the file (if it could 434# be obtained via FILE_VERSION_FILTER) 435 436WARN_FORMAT = 437 438# The WARN_LOGFILE tag can be used to specify a file to which warning 439# and error messages should be written. If left blank the output is written 440# to stderr. 441 442WARN_LOGFILE = 443 444#--------------------------------------------------------------------------- 445# configuration options related to the input files 446#--------------------------------------------------------------------------- 447 448# The INPUT tag can be used to specify the files and/or directories that contain 449# documented source files. You may enter file names like "myfile.cpp" or 450# directories like "/usr/src/myproject". Separate the files or directories 451# with spaces. 452 453INPUT = @abs_srcdir@/../include \ 454 @abs_srcdir@/../lib \ 455 @abs_srcdir@/doxygen.intro 456 457# If the value of the INPUT tag contains directories, you can use the 458# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 459# and *.h) to filter out the source-files in the directories. If left 460# blank the following patterns are tested: 461# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx 462# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm 463 464FILE_PATTERNS = 465 466# The RECURSIVE tag can be used to turn specify whether or not subdirectories 467# should be searched for input files as well. Possible values are YES and NO. 468# If left blank NO is used. 469 470RECURSIVE = YES 471 472# The EXCLUDE tag can be used to specify files and/or directories that should 473# excluded from the INPUT source files. This way you can easily exclude a 474# subdirectory from a directory tree whose root is specified with the INPUT tag. 475 476EXCLUDE = 477 478# The EXCLUDE_SYMLINKS tag can be used select whether or not files or 479# directories that are symbolic links (a Unix filesystem feature) are excluded 480# from the input. 481 482EXCLUDE_SYMLINKS = NO 483 484# If the value of the INPUT tag contains directories, you can use the 485# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 486# certain files from those directories. Note that the wildcards are matched 487# against the file with absolute path, so to exclude all test directories 488# for example use the pattern */test/* 489 490EXCLUDE_PATTERNS = 491 492# The EXAMPLE_PATH tag can be used to specify one or more files or 493# directories that contain example code fragments that are included (see 494# the \include command). 495 496EXAMPLE_PATH = @abs_srcdir@/../examples 497 498# If the value of the EXAMPLE_PATH tag contains directories, you can use the 499# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 500# and *.h) to filter out the source-files in the directories. If left 501# blank all files are included. 502 503EXAMPLE_PATTERNS = 504 505# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 506# searched for input files to be used with the \include or \dontinclude 507# commands irrespective of the value of the RECURSIVE tag. 508# Possible values are YES and NO. If left blank NO is used. 509 510EXAMPLE_RECURSIVE = YES 511 512# The IMAGE_PATH tag can be used to specify one or more files or 513# directories that contain image that are included in the documentation (see 514# the \image command). 515 516IMAGE_PATH = @abs_srcdir@/img 517 518# The INPUT_FILTER tag can be used to specify a program that doxygen should 519# invoke to filter for each input file. Doxygen will invoke the filter program 520# by executing (via popen()) the command <filter> <input-file>, where <filter> 521# is the value of the INPUT_FILTER tag, and <input-file> is the name of an 522# input file. Doxygen will then use the output that the filter program writes 523# to standard output. If FILTER_PATTERNS is specified, this tag will be 524# ignored. 525 526INPUT_FILTER = 527 528# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 529# basis. Doxygen will compare the file name with each pattern and apply the 530# filter if there is a match. The filters are a list of the form: 531# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 532# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER 533# is applied to all files. 534 535FILTER_PATTERNS = 536 537# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 538# INPUT_FILTER) will be used to filter the input files when producing source 539# files to browse (i.e. when SOURCE_BROWSER is set to YES). 540 541FILTER_SOURCE_FILES = NO 542 543#--------------------------------------------------------------------------- 544# configuration options related to source browsing 545#--------------------------------------------------------------------------- 546 547# If the SOURCE_BROWSER tag is set to YES then a list of source files will 548# be generated. Documented entities will be cross-referenced with these sources. 549# Note: To get rid of all source code in the generated output, make sure also 550# VERBATIM_HEADERS is set to NO. 551 552SOURCE_BROWSER = YES 553 554# Setting the INLINE_SOURCES tag to YES will include the body 555# of functions and classes directly in the documentation. 556 557INLINE_SOURCES = NO 558 559# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 560# doxygen to hide any special comment blocks from generated source code 561# fragments. Normal C and C++ comments will always remain visible. 562 563STRIP_CODE_COMMENTS = NO 564 565# If the REFERENCED_BY_RELATION tag is set to YES (the default) 566# then for each documented function all documented 567# functions referencing it will be listed. 568 569REFERENCED_BY_RELATION = YES 570 571# If the REFERENCES_RELATION tag is set to YES (the default) 572# then for each documented function all documented entities 573# called/used by that function will be listed. 574 575REFERENCES_RELATION = YES 576 577# If the USE_HTAGS tag is set to YES then the references to source code 578# will point to the HTML generated by the htags(1) tool instead of doxygen 579# built-in source browser. The htags tool is part of GNU's global source 580# tagging system (see http://www.gnu.org/software/global/global.html). You 581# will need version 4.8.6 or higher. 582 583#USE_HTAGS = NO 584 585# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 586# will generate a verbatim copy of the header file for each class for 587# which an include is specified. Set to NO to disable this. 588 589VERBATIM_HEADERS = YES 590 591#--------------------------------------------------------------------------- 592# configuration options related to the alphabetical class index 593#--------------------------------------------------------------------------- 594 595# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 596# of all compounds will be generated. Enable this if the project 597# contains a lot of classes, structs, unions or interfaces. 598 599ALPHABETICAL_INDEX = YES 600 601# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 602# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 603# in which this list will be split (can be a number in the range [1..20]) 604 605COLS_IN_ALPHA_INDEX = 4 606 607# In case all classes in a project start with a common prefix, all 608# classes will be put under the same header in the alphabetical index. 609# The IGNORE_PREFIX tag can be used to specify one or more prefixes that 610# should be ignored while generating the index headers. 611 612IGNORE_PREFIX = clang:: 613 614#--------------------------------------------------------------------------- 615# configuration options related to the HTML output 616#--------------------------------------------------------------------------- 617 618# If the GENERATE_HTML tag is set to YES (the default) Doxygen will 619# generate HTML output. 620 621GENERATE_HTML = YES 622 623# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 624# If a relative path is entered the value of OUTPUT_DIRECTORY will be 625# put in front of it. If left blank `html' will be used as the default path. 626 627HTML_OUTPUT = html 628 629# The HTML_FILE_EXTENSION tag can be used to specify the file extension for 630# each generated HTML page (for example: .htm,.php,.asp). If it is left blank 631# doxygen will generate files with .html extension. 632 633HTML_FILE_EXTENSION = .html 634 635# The HTML_HEADER tag can be used to specify a personal HTML header for 636# each generated HTML page. If it is left blank doxygen will generate a 637# standard header. 638 639HTML_HEADER = @abs_srcdir@/doxygen.header 640 641# The HTML_FOOTER tag can be used to specify a personal HTML footer for 642# each generated HTML page. If it is left blank doxygen will generate a 643# standard footer. 644 645HTML_FOOTER = @abs_srcdir@/doxygen.footer 646 647# The HTML_STYLESHEET tag can be used to specify a user-defined cascading 648# style sheet that is used by each HTML page. It can be used to 649# fine-tune the look of the HTML output. If the tag is left blank doxygen 650# will generate a default style sheet. Note that doxygen will try to copy 651# the style sheet file to the HTML output directory, so don't put your own 652# stylesheet in the HTML output directory as well, or it will be erased! 653 654HTML_STYLESHEET = @abs_srcdir@/doxygen.css 655 656# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 657# files or namespaces will be aligned in HTML using tables. If set to 658# NO a bullet list will be used. 659 660HTML_ALIGN_MEMBERS = YES 661 662# If the GENERATE_HTMLHELP tag is set to YES, additional index files 663# will be generated that can be used as input for tools like the 664# Microsoft HTML help workshop to generate a compressed HTML help file (.chm) 665# of the generated HTML documentation. 666 667GENERATE_HTMLHELP = NO 668 669# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 670# be used to specify the file name of the resulting .chm file. You 671# can add a path in front of the file if the result should not be 672# written to the html output directory. 673 674CHM_FILE = 675 676# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 677# be used to specify the location (absolute path including file name) of 678# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 679# the HTML help compiler on the generated index.hhp. 680 681HHC_LOCATION = 682 683# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 684# controls if a separate .chi index file is generated (YES) or that 685# it should be included in the master .chm file (NO). 686 687GENERATE_CHI = NO 688 689# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 690# controls whether a binary table of contents is generated (YES) or a 691# normal table of contents (NO) in the .chm file. 692 693BINARY_TOC = NO 694 695# The TOC_EXPAND flag can be set to YES to add extra items for group members 696# to the contents of the HTML help documentation and to the tree view. 697 698TOC_EXPAND = NO 699 700# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and 701# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated 702# that can be used as input for Qt's qhelpgenerator to generate a 703# Qt Compressed Help (.qch) of the generated HTML documentation. 704 705GENERATE_QHP = @clang_doxygen_generate_qhp@ 706 707# If the QHG_LOCATION tag is specified, the QCH_FILE tag can 708# be used to specify the file name of the resulting .qch file. 709# The path specified is relative to the HTML output folder. 710 711QCH_FILE = @clang_doxygen_qch_filename@ 712 713# The QHP_NAMESPACE tag specifies the namespace to use when generating 714# Qt Help Project output. For more information please see 715# http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace 716 717QHP_NAMESPACE = @clang_doxygen_qhp_namespace@ 718 719# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating 720# Qt Help Project output. For more information please see 721# http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-folders 722 723QHP_VIRTUAL_FOLDER = doc 724 725# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to 726# add. For more information please see 727# http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-filters 728 729QHP_CUST_FILTER_NAME = @clang_doxygen_qhp_cust_filter_name@ 730 731# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the 732# custom filter to add. For more information please see 733# <a href="http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-filters"> 734# Qt Help Project / Custom Filters</a>. 735 736QHP_CUST_FILTER_ATTRS = @clang_doxygen_qhp_cust_filter_attrs@ 737 738# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this 739# project's 740# filter section matches. 741# <a href="http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes"> 742# Qt Help Project / Filter Attributes</a>. 743 744QHP_SECT_FILTER_ATTRS = 745 746# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can 747# be used to specify the location of Qt's qhelpgenerator. 748# If non-empty doxygen will try to run qhelpgenerator on the generated 749# .qhp file. 750 751QHG_LOCATION = @clang_doxygen_qhelpgenerator_path@ 752 753# The DISABLE_INDEX tag can be used to turn on/off the condensed index at 754# top of each HTML page. The value NO (the default) enables the index and 755# the value YES disables it. 756 757DISABLE_INDEX = NO 758 759# This tag can be used to set the number of enum values (range [1..20]) 760# that doxygen will group on one line in the generated HTML documentation. 761 762ENUM_VALUES_PER_LINE = 4 763 764# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be 765# generated containing a tree-like index structure (just like the one that 766# is generated for HTML Help). For this to work a browser that supports 767# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, 768# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are 769# probably better off using the HTML help feature. 770 771GENERATE_TREEVIEW = NO 772 773# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 774# used to set the initial width (in pixels) of the frame in which the tree 775# is shown. 776 777TREEVIEW_WIDTH = 250 778 779#--------------------------------------------------------------------------- 780# configuration options related to the LaTeX output 781#--------------------------------------------------------------------------- 782 783# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 784# generate Latex output. 785 786GENERATE_LATEX = NO 787 788# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 789# If a relative path is entered the value of OUTPUT_DIRECTORY will be 790# put in front of it. If left blank `latex' will be used as the default path. 791 792LATEX_OUTPUT = 793 794# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 795# invoked. If left blank `latex' will be used as the default command name. 796 797LATEX_CMD_NAME = latex 798 799# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 800# generate index for LaTeX. If left blank `makeindex' will be used as the 801# default command name. 802 803MAKEINDEX_CMD_NAME = makeindex 804 805# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 806# LaTeX documents. This may be useful for small projects and may help to 807# save some trees in general. 808 809COMPACT_LATEX = NO 810 811# The PAPER_TYPE tag can be used to set the paper type that is used 812# by the printer. Possible values are: a4, a4wide, letter, legal and 813# executive. If left blank a4wide will be used. 814 815PAPER_TYPE = letter 816 817# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 818# packages that should be included in the LaTeX output. 819 820EXTRA_PACKAGES = 821 822# The LATEX_HEADER tag can be used to specify a personal LaTeX header for 823# the generated latex document. The header should contain everything until 824# the first chapter. If it is left blank doxygen will generate a 825# standard header. Notice: only use this tag if you know what you are doing! 826 827LATEX_HEADER = 828 829# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 830# is prepared for conversion to pdf (using ps2pdf). The pdf file will 831# contain links (just like the HTML output) instead of page references 832# This makes the output suitable for online browsing using a pdf viewer. 833 834PDF_HYPERLINKS = NO 835 836# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 837# plain latex in the generated Makefile. Set this option to YES to get a 838# higher quality PDF documentation. 839 840USE_PDFLATEX = NO 841 842# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 843# command to the generated LaTeX files. This will instruct LaTeX to keep 844# running if errors occur, instead of asking the user for help. 845# This option is also used when generating formulas in HTML. 846 847LATEX_BATCHMODE = NO 848 849# If LATEX_HIDE_INDICES is set to YES then doxygen will not 850# include the index chapters (such as File Index, Compound Index, etc.) 851# in the output. 852 853LATEX_HIDE_INDICES = NO 854 855#--------------------------------------------------------------------------- 856# configuration options related to the RTF output 857#--------------------------------------------------------------------------- 858 859# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 860# The RTF output is optimized for Word 97 and may not look very pretty with 861# other RTF readers or editors. 862 863GENERATE_RTF = NO 864 865# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 866# If a relative path is entered the value of OUTPUT_DIRECTORY will be 867# put in front of it. If left blank `rtf' will be used as the default path. 868 869RTF_OUTPUT = 870 871# If the COMPACT_RTF tag is set to YES Doxygen generates more compact 872# RTF documents. This may be useful for small projects and may help to 873# save some trees in general. 874 875COMPACT_RTF = NO 876 877# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 878# will contain hyperlink fields. The RTF file will 879# contain links (just like the HTML output) instead of page references. 880# This makes the output suitable for online browsing using WORD or other 881# programs which support those fields. 882# Note: wordpad (write) and others do not support links. 883 884RTF_HYPERLINKS = NO 885 886# Load stylesheet definitions from file. Syntax is similar to doxygen's 887# config file, i.e. a series of assignments. You only have to provide 888# replacements, missing definitions are set to their default value. 889 890RTF_STYLESHEET_FILE = 891 892# Set optional variables used in the generation of an rtf document. 893# Syntax is similar to doxygen's config file. 894 895RTF_EXTENSIONS_FILE = 896 897#--------------------------------------------------------------------------- 898# configuration options related to the man page output 899#--------------------------------------------------------------------------- 900 901# If the GENERATE_MAN tag is set to YES (the default) Doxygen will 902# generate man pages 903 904GENERATE_MAN = NO 905 906# The MAN_OUTPUT tag is used to specify where the man pages will be put. 907# If a relative path is entered the value of OUTPUT_DIRECTORY will be 908# put in front of it. If left blank `man' will be used as the default path. 909 910MAN_OUTPUT = 911 912# The MAN_EXTENSION tag determines the extension that is added to 913# the generated man pages (default is the subroutine's section .3) 914 915MAN_EXTENSION = 916 917# If the MAN_LINKS tag is set to YES and Doxygen generates man output, 918# then it will generate one additional man file for each entity 919# documented in the real man page(s). These additional files 920# only source the real man page, but without them the man command 921# would be unable to find the correct page. The default is NO. 922 923MAN_LINKS = NO 924 925#--------------------------------------------------------------------------- 926# configuration options related to the XML output 927#--------------------------------------------------------------------------- 928 929# If the GENERATE_XML tag is set to YES Doxygen will 930# generate an XML file that captures the structure of 931# the code including all documentation. 932 933GENERATE_XML = NO 934 935# The XML_OUTPUT tag is used to specify where the XML pages will be put. 936# If a relative path is entered the value of OUTPUT_DIRECTORY will be 937# put in front of it. If left blank `xml' will be used as the default path. 938 939XML_OUTPUT = xml 940 941# The XML_SCHEMA tag can be used to specify an XML schema, 942# which can be used by a validating XML parser to check the 943# syntax of the XML files. 944 945XML_SCHEMA = 946 947# The XML_DTD tag can be used to specify an XML DTD, 948# which can be used by a validating XML parser to check the 949# syntax of the XML files. 950 951XML_DTD = 952 953# If the XML_PROGRAMLISTING tag is set to YES Doxygen will 954# dump the program listings (including syntax highlighting 955# and cross-referencing information) to the XML output. Note that 956# enabling this will significantly increase the size of the XML output. 957 958XML_PROGRAMLISTING = YES 959 960#--------------------------------------------------------------------------- 961# configuration options for the AutoGen Definitions output 962#--------------------------------------------------------------------------- 963 964# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 965# generate an AutoGen Definitions (see autogen.sf.net) file 966# that captures the structure of the code including all 967# documentation. Note that this feature is still experimental 968# and incomplete at the moment. 969 970GENERATE_AUTOGEN_DEF = NO 971 972#--------------------------------------------------------------------------- 973# configuration options related to the Perl module output 974#--------------------------------------------------------------------------- 975 976# If the GENERATE_PERLMOD tag is set to YES Doxygen will 977# generate a Perl module file that captures the structure of 978# the code including all documentation. Note that this 979# feature is still experimental and incomplete at the 980# moment. 981 982GENERATE_PERLMOD = NO 983 984# If the PERLMOD_LATEX tag is set to YES Doxygen will generate 985# the necessary Makefile rules, Perl scripts and LaTeX code to be able 986# to generate PDF and DVI output from the Perl module output. 987 988PERLMOD_LATEX = NO 989 990# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 991# nicely formatted so it can be parsed by a human reader. This is useful 992# if you want to understand what is going on. On the other hand, if this 993# tag is set to NO the size of the Perl module output will be much smaller 994# and Perl will parse it just the same. 995 996PERLMOD_PRETTY = YES 997 998# The names of the make variables in the generated doxyrules.make file 999# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 1000# This is useful so different doxyrules.make files included by the same 1001# Makefile don't overwrite each other's variables. 1002 1003PERLMOD_MAKEVAR_PREFIX = 1004 1005#--------------------------------------------------------------------------- 1006# Configuration options related to the preprocessor 1007#--------------------------------------------------------------------------- 1008 1009# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 1010# evaluate all C-preprocessor directives found in the sources and include 1011# files. 1012 1013ENABLE_PREPROCESSING = YES 1014 1015# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 1016# names in the source code. If set to NO (the default) only conditional 1017# compilation will be performed. Macro expansion can be done in a controlled 1018# way by setting EXPAND_ONLY_PREDEF to YES. 1019 1020MACRO_EXPANSION = NO 1021 1022# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 1023# then the macro expansion is limited to the macros specified with the 1024# PREDEFINED and EXPAND_AS_PREDEFINED tags. 1025 1026EXPAND_ONLY_PREDEF = NO 1027 1028# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 1029# in the INCLUDE_PATH (see below) will be search if a #include is found. 1030 1031SEARCH_INCLUDES = YES 1032 1033# The INCLUDE_PATH tag can be used to specify one or more directories that 1034# contain include files that are not input files but should be processed by 1035# the preprocessor. 1036 1037INCLUDE_PATH = ../include 1038 1039# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 1040# patterns (like *.h and *.hpp) to filter out the header-files in the 1041# directories. If left blank, the patterns specified with FILE_PATTERNS will 1042# be used. 1043 1044INCLUDE_FILE_PATTERNS = 1045 1046# The PREDEFINED tag can be used to specify one or more macro names that 1047# are defined before the preprocessor is started (similar to the -D option of 1048# gcc). The argument of the tag is a list of macros of the form: name 1049# or name=definition (no spaces). If the definition and the = are 1050# omitted =1 is assumed. To prevent a macro definition from being 1051# undefined via #undef or recursively expanded use the := operator 1052# instead of the = operator. 1053 1054PREDEFINED = 1055 1056# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 1057# this tag can be used to specify a list of macro names that should be expanded. 1058# The macro definition that is found in the sources will be used. 1059# Use the PREDEFINED tag if you want to use a different macro definition. 1060 1061EXPAND_AS_DEFINED = 1062 1063# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 1064# doxygen's preprocessor will remove all function-like macros that are alone 1065# on a line, have an all uppercase name, and do not end with a semicolon. Such 1066# function macros are typically used for boiler-plate code, and will confuse 1067# the parser if not removed. 1068 1069SKIP_FUNCTION_MACROS = YES 1070 1071#--------------------------------------------------------------------------- 1072# Configuration::additions related to external references 1073#--------------------------------------------------------------------------- 1074 1075# The TAGFILES option can be used to specify one or more tagfiles. 1076# Optionally an initial location of the external documentation 1077# can be added for each tagfile. The format of a tag file without 1078# this location is as follows: 1079# TAGFILES = file1 file2 ... 1080# Adding location for the tag files is done as follows: 1081# TAGFILES = file1=loc1 "file2 = loc2" ... 1082# where "loc1" and "loc2" can be relative or absolute paths or 1083# URLs. If a location is present for each tag, the installdox tool 1084# does not have to be run to correct the links. 1085# Note that each tag file must have a unique name 1086# (where the name does NOT include the path) 1087# If a tag file is not located in the directory in which doxygen 1088# is run, you must also specify the path to the tagfile here. 1089 1090TAGFILES = 1091 1092# When a file name is specified after GENERATE_TAGFILE, doxygen will create 1093# a tag file that is based on the input files it reads. 1094 1095GENERATE_TAGFILE = 1096 1097# If the ALLEXTERNALS tag is set to YES all external classes will be listed 1098# in the class index. If set to NO only the inherited external classes 1099# will be listed. 1100 1101ALLEXTERNALS = YES 1102 1103# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 1104# in the modules index. If set to NO, only the current project's groups will 1105# be listed. 1106 1107EXTERNAL_GROUPS = YES 1108 1109# The PERL_PATH should be the absolute path and name of the perl script 1110# interpreter (i.e. the result of `which perl'). 1111 1112PERL_PATH = 1113 1114#--------------------------------------------------------------------------- 1115# Configuration options related to the dot tool 1116#--------------------------------------------------------------------------- 1117 1118# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 1119# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base 1120# or super classes. Setting the tag to NO turns the diagrams off. Note that 1121# this option is superseded by the HAVE_DOT option below. This is only a 1122# fallback. It is recommended to install and use dot, since it yields more 1123# powerful graphs. 1124 1125CLASS_DIAGRAMS = YES 1126 1127# If set to YES, the inheritance and collaboration graphs will hide 1128# inheritance and usage relations if the target is undocumented 1129# or is not a class. 1130 1131HIDE_UNDOC_RELATIONS = NO 1132 1133# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 1134# available from the path. This tool is part of Graphviz, a graph visualization 1135# toolkit from AT&T and Lucent Bell Labs. The other options in this section 1136# have no effect if this option is set to NO (the default) 1137 1138HAVE_DOT = YES 1139 1140# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 1141# will generate a graph for each documented class showing the direct and 1142# indirect inheritance relations. Setting this tag to YES will force the 1143# the CLASS_DIAGRAMS tag to NO. 1144 1145CLASS_GRAPH = YES 1146 1147# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 1148# will generate a graph for each documented class showing the direct and 1149# indirect implementation dependencies (inheritance, containment, and 1150# class references variables) of the class with other documented classes. 1151 1152COLLABORATION_GRAPH = YES 1153 1154# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen 1155# will generate a graph for groups, showing the direct groups dependencies 1156 1157#GROUP_GRAPHS = YES 1158 1159# If the UML_LOOK tag is set to YES doxygen will generate inheritance and 1160# collaboration diagrams in a style similar to the OMG's Unified Modeling 1161# Language. 1162 1163UML_LOOK = NO 1164 1165# If set to YES, the inheritance and collaboration graphs will show the 1166# relations between templates and their instances. 1167 1168TEMPLATE_RELATIONS = YES 1169 1170# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 1171# tags are set to YES then doxygen will generate a graph for each documented 1172# file showing the direct and indirect include dependencies of the file with 1173# other documented files. 1174 1175INCLUDE_GRAPH = YES 1176 1177# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 1178# HAVE_DOT tags are set to YES then doxygen will generate a graph for each 1179# documented header file showing the documented files that directly or 1180# indirectly include this file. 1181 1182INCLUDED_BY_GRAPH = YES 1183 1184# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will 1185# generate a call dependency graph for every global function or class method. 1186# Note that enabling this option will significantly increase the time of a run. 1187# So in most cases it will be better to enable call graphs for selected 1188# functions only using the \callgraph command. 1189 1190CALL_GRAPH = NO 1191 1192# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 1193# will graphical hierarchy of all classes instead of a textual one. 1194 1195GRAPHICAL_HIERARCHY = YES 1196 1197# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES 1198# then doxygen will show the dependencies a directory has on other directories 1199# in a graphical way. The dependency relations are determined by the #include 1200# relations between the files in the directories. 1201 1202#DIRECTORY_GRAPH = YES 1203 1204# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 1205# generated by dot. Possible values are png, jpg, or gif 1206# If left blank png will be used. 1207 1208DOT_IMAGE_FORMAT = png 1209 1210# The tag DOT_PATH can be used to specify the path where the dot tool can be 1211# found. If left blank, it is assumed the dot tool can be found in the path. 1212 1213DOT_PATH = @DOT@ 1214 1215# The DOTFILE_DIRS tag can be used to specify one or more directories that 1216# contain dot files that are included in the documentation (see the 1217# \dotfile command). 1218 1219DOTFILE_DIRS = 1220 1221# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width 1222# (in pixels) of the graphs generated by dot. If a graph becomes larger than 1223# this value, doxygen will try to truncate the graph, so that it fits within 1224# the specified constraint. Beware that most browsers cannot cope with very 1225# large images. 1226 1227MAX_DOT_GRAPH_WIDTH = 1024 1228 1229# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height 1230# (in pixels) of the graphs generated by dot. If a graph becomes larger than 1231# this value, doxygen will try to truncate the graph, so that it fits within 1232# the specified constraint. Beware that most browsers cannot cope with very 1233# large images. 1234 1235MAX_DOT_GRAPH_HEIGHT = 1024 1236 1237# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 1238# graphs generated by dot. A depth value of 3 means that only nodes reachable 1239# from the root by following a path via at most 3 edges will be shown. Nodes 1240# that lay further from the root node will be omitted. Note that setting this 1241# option to 1 or 2 may greatly reduce the computation time needed for large 1242# code bases. Also note that a graph may be further truncated if the graph's 1243# image dimensions are not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH 1244# and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the depth value (the default), 1245# the graph is not depth-constrained. 1246 1247MAX_DOT_GRAPH_DEPTH = 0 1248 1249# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 1250# background. This is disabled by default, which results in a white background. 1251# Warning: Depending on the platform used, enabling this option may lead to 1252# badly anti-aliased labels on the edges of a graph (i.e. they become hard to 1253# read). 1254 1255#DOT_TRANSPARENT = NO 1256 1257# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output 1258# files in one run (i.e. multiple -o and -T options on the command line). This 1259# makes dot run faster, but since only newer versions of dot (>1.8.10) 1260# support this, this feature is disabled by default. 1261 1262#DOT_MULTI_TARGETS = NO 1263 1264# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 1265# generate a legend page explaining the meaning of the various boxes and 1266# arrows in the dot generated graphs. 1267 1268GENERATE_LEGEND = YES 1269 1270# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 1271# remove the intermediate dot files that are used to generate 1272# the various graphs. 1273 1274DOT_CLEANUP = YES 1275 1276#--------------------------------------------------------------------------- 1277# Configuration::additions related to the search engine 1278#--------------------------------------------------------------------------- 1279 1280# When the SEARCHENGINE tag is enabled doxygen will generate a search box 1281# for the HTML output. The underlying search engine uses javascript 1282# and DHTML and should work on any modern browser. Note that when using 1283# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets 1284# (GENERATE_DOCSET) there is already a search function so this one should 1285# typically be disabled. For large projects the javascript based search engine 1286# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. 1287 1288SEARCHENGINE = @enable_searchengine@ 1289 1290# When the SERVER_BASED_SEARCH tag is enabled the search engine will be 1291# implemented using a PHP enabled web server instead of at the web client 1292# using Javascript. Doxygen will generate the search PHP script and index 1293# file to put on the web server. The advantage of the server 1294# based approach is that it scales better to large projects and allows 1295# full text search. The disadvances is that it is more difficult to setup 1296# and does not have live searching capabilities. 1297 1298SERVER_BASED_SEARCH = @enable_server_based_search@ 1299 1300SEARCHENGINE_URL = @searchengine_url@ 1301 1302EXTERNAL_SEARCH = @enable_external_search@ 1303 1304EXTERNAL_SEARCH_ID = clang 1305 1306EXTRA_SEARCH_MAPPINGS = @extra_search_mappings@ 1307