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