108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# Doxyfile 1.7.1 208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# This file describes the settings to be used by the documentation system 408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# doxygen (www.doxygen.org) for a project 508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# 608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# All text after a hash (#) is considered a comment and will be ignored 708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# The format is: 808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# TAG = value [value, ...] 908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# For lists items can also be appended using: 1008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# TAG += value [value, ...] 1108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# Values that contain spaces should be placed between quotes (" ") 1208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 1308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten#--------------------------------------------------------------------------- 1408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# Project related configuration options 1508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten#--------------------------------------------------------------------------- 1608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 1708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# This tag specifies the encoding used for all characters in the config file 1808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# that follow. The default is UTF-8 which is also the encoding used for all 1908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# text before the first occurrence of this tag. Doxygen uses libiconv (or the 2008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# iconv built into libc) for the transcoding. See 2108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# http://www.gnu.org/software/libiconv for the list of possible encodings. 2208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 2308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenDOXYFILE_ENCODING = UTF-8 2408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 2508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# The PROJECT_NAME tag is a single word (or a sequence of words surrounded 2608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# by quotes) that should identify the project. 2708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 2808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenPROJECT_NAME = Wilhelm 2908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 3008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# The PROJECT_NUMBER tag can be used to enter a project or revision number. 3108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# This could be handy for archiving the generated documentation or 3208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# if some version control system is used. 3308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 3408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenPROJECT_NUMBER = 0.1 3508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 3608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 3708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# base path where the generated documentation will be put. 3808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If a relative path is entered, it will be relative to the location 3908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# where doxygen was started. If left blank the current directory will be used. 4008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 4108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenOUTPUT_DIRECTORY = 4208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 4308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# 4096 sub-directories (in 2 levels) under the output directory of each output 4508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# format and will distribute the generated files over these directories. 4608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# Enabling this option can be useful when feeding doxygen a huge amount of 4708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# source files, where putting all generated files in the same directory would 4808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# otherwise cause performance problems for the file system. 4908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 5008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenCREATE_SUBDIRS = NO 5108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 5208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# The OUTPUT_LANGUAGE tag is used to specify the language in which all 5308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# documentation generated by doxygen is written. Doxygen will use this 5408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# information to generate all constant output in the proper language. 5508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# The default language is English, other supported languages are: 5608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, 5708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, 5808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English 5908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, 6008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak, 6108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. 6208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 6308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenOUTPUT_LANGUAGE = English 6408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 6508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 6608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# include brief member descriptions after the members that are listed in 6708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# the file and class documentation (similar to JavaDoc). 6808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# Set to NO to disable this. 6908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 7008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenBRIEF_MEMBER_DESC = YES 7108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 7208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 7308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# the brief description of a member or function before the detailed description. 7408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 7508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# brief descriptions will be completely suppressed. 7608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 7708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenREPEAT_BRIEF = YES 7808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 7908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# This tag implements a quasi-intelligent brief description abbreviator 8008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# that is used to form the text in various listings. Each string 8108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# in this list, if found as the leading text of the brief description, will be 8208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# stripped from the text and the result after processing the whole list, is 8308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# used as the annotated text. Otherwise, the brief description is used as-is. 8408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If left blank, the following values are used ("$name" is automatically 8508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# replaced with the name of the entity): "The $name class" "The $name widget" 8608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# "The $name file" "is" "provides" "specifies" "contains" 8708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# "represents" "a" "an" "the" 8808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 8908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenABBREVIATE_BRIEF = 9008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 9108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 9208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# Doxygen will generate a detailed section even if there is only a brief 9308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# description. 9408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 9508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenALWAYS_DETAILED_SEC = NO 9608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 9708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 9808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# inherited members of a class in the documentation of that class as if those 9908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# members were ordinary class members. Constructors, destructors and assignment 10008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# operators of the base classes will not be shown. 10108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 10208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenINLINE_INHERITED_MEMB = NO 10308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 10408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 10508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# path before files name in the file list and in the header files. If set 10608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# to NO the shortest path that makes the file name unique will be used. 10708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 10808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenFULL_PATH_NAMES = NO 10908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 11008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 11108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# can be used to strip a user-defined part of the path. Stripping is 11208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# only done if one of the specified strings matches the left-hand part of 11308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# the path. The tag can be used to show relative paths in the file list. 11408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If left blank the directory from which doxygen is run is used as the 11508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# path to strip. 11608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 11708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenSTRIP_FROM_PATH = 11808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 11908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 12008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# the path mentioned in the documentation of a class, which tells 12108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# the reader which header file to include in order to use a class. 12208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If left blank only the name of the header file containing the class 12308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# definition is used. Otherwise one should specify the include paths that 12408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# are normally passed to the compiler using the -I flag. 12508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 12608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenSTRIP_FROM_INC_PATH = 12708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 12808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 12908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# (but less readable) file names. This can be useful is your file systems 13008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# doesn't support long names like on DOS, Mac, or CD-ROM. 13108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 13208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenSHORT_NAMES = NO 13308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 13408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 13508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# will interpret the first line (until the first dot) of a JavaDoc-style 13608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# comment as the brief description. If set to NO, the JavaDoc 13708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# comments will behave just like regular Qt-style comments 13808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# (thus requiring an explicit @brief command for a brief description.) 13908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 14008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenJAVADOC_AUTOBRIEF = NO 14108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 14208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the QT_AUTOBRIEF tag is set to YES then Doxygen will 14308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# interpret the first line (until the first dot) of a Qt-style 14408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# comment as the brief description. If set to NO, the comments 14508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# will behave just like regular Qt-style comments (thus requiring 14608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# an explicit \brief command for a brief description.) 14708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 14808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenQT_AUTOBRIEF = NO 14908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 15008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 15108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# treat a multi-line C++ special comment block (i.e. a block of //! or /// 15208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# comments) as a brief description. This used to be the default behaviour. 15308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# The new default is to treat a multi-line C++ comment block as a detailed 15408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# description. Set this tag to YES if you prefer the old behaviour instead. 15508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 15608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenMULTILINE_CPP_IS_BRIEF = NO 15708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 15808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 15908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# member inherits the documentation from any documented member that it 16008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# re-implements. 16108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 16208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenINHERIT_DOCS = YES 16308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 16408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce 16508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# a new page for each member. If set to NO, the documentation of a member will 16608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# be part of the file/class/namespace that contains it. 16708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 16808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenSEPARATE_MEMBER_PAGES = NO 16908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 17008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# The TAB_SIZE tag can be used to set the number of spaces in a tab. 17108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# Doxygen uses this value to replace tabs by spaces in code fragments. 17208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 17308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenTAB_SIZE = 8 17408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 17508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# This tag can be used to specify a number of aliases that acts 17608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# as commands in the documentation. An alias has the form "name=value". 17708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# For example adding "sideeffect=\par Side Effects:\n" will allow you to 17808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# put the command \sideeffect (or @sideeffect) in the documentation, which 17908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# will result in a user-defined paragraph with heading "Side Effects:". 18008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# You can put \n's in the value part of an alias to insert newlines. 18108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 18208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenALIASES = 18308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 18408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 18508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# sources only. Doxygen will then generate output that is more tailored for C. 18608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# For instance, some of the names that are used will be different. The list 18708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# of all members will be omitted, etc. 18808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 18908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenOPTIMIZE_OUTPUT_FOR_C = NO 19008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 19108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java 19208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# sources only. Doxygen will then generate output that is more tailored for 19308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# Java. For instance, namespaces will be presented as packages, qualified 19408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# scopes will look different, etc. 19508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 19608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenOPTIMIZE_OUTPUT_JAVA = NO 19708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 19808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 19908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# sources only. Doxygen will then generate output that is more tailored for 20008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# Fortran. 20108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 20208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenOPTIMIZE_FOR_FORTRAN = NO 20308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 20408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 20508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# sources. Doxygen will then generate output that is tailored for 20608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# VHDL. 20708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 20808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenOPTIMIZE_OUTPUT_VHDL = NO 20908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 21008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# Doxygen selects the parser to use depending on the extension of the files it 21108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# parses. With this tag you can assign which parser to use for a given extension. 21208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# Doxygen has a built-in mapping, but you can override or extend it using this 21308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# tag. The format is ext=language, where ext is a file extension, and language 21408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C, 21508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make 21608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C 21708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions 21808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen. 21908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 22008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenEXTENSION_MAPPING = 22108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 22208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 22308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# to include (a tag file for) the STL sources as input, then you should 22408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# set this tag to YES in order to let doxygen match functions declarations and 22508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. 22608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# func(std::string) {}). This also make the inheritance and collaboration 22708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# diagrams that involve STL classes more complete and accurate. 22808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 22908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenBUILTIN_STL_SUPPORT = NO 23008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 23108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If you use Microsoft's C++/CLI language, you should set this option to YES to 23208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# enable parsing support. 23308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 23408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenCPP_CLI_SUPPORT = NO 23508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 23608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. 23708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# Doxygen will parse them like normal C++ but will assume all classes use public 23808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# instead of private inheritance when no explicit protection keyword is present. 23908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 24008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenSIP_SUPPORT = NO 24108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 24208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# For Microsoft's IDL there are propget and propput attributes to indicate getter 24308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# and setter methods for a property. Setting this option to YES (the default) 24408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# will make doxygen to replace the get and set methods by a property in the 24508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# documentation. This will only work if the methods are indeed getting or 24608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# setting a simple type. If this is not the case, or you want to show the 24708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# methods anyway, you should set this option to NO. 24808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 24908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenIDL_PROPERTY_SUPPORT = YES 25008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 25108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 25208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# tag is set to YES, then doxygen will reuse the documentation of the first 25308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# member in the group (if any) for the other members of the group. By default 25408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# all members of a group must be documented explicitly. 25508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 25608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenDISTRIBUTE_GROUP_DOC = NO 25708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 25808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# Set the SUBGROUPING tag to YES (the default) to allow class member groups of 25908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# the same type (for instance a group of public functions) to be put as a 26008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# subgroup of that type (e.g. under the Public Functions section). Set it to 26108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# NO to prevent subgrouping. Alternatively, this can be done per class using 26208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# the \nosubgrouping command. 26308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 26408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenSUBGROUPING = YES 26508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 26608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum 26708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# is documented as struct, union, or enum with the name of the typedef. So 26808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# typedef struct TypeS {} TypeT, will appear in the documentation as a struct 26908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# with name TypeT. When disabled the typedef will appear as a member of a file, 27008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# namespace, or class. And the struct will be named TypeS. This can typically 27108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# be useful for C code in case the coding convention dictates that all compound 27208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# types are typedef'ed and only the typedef is referenced, never the tag name. 27308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 27408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenTYPEDEF_HIDES_STRUCT = NO 27508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 27608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to 27708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# determine which symbols to keep in memory and which to flush to disk. 27808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# When the cache is full, less often used symbols will be written to disk. 27908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# For small to medium size projects (<1000 input files) the default value is 28008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# probably good enough. For larger projects a too small cache size can cause 28108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# doxygen to be busy swapping symbols to and from disk most of the time 28208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# causing a significant performance penality. 28308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the system has enough physical memory increasing the cache will improve the 28408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# performance by keeping more symbols in memory. Note that the value works on 28508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# a logarithmic scale so increasing the size by one will rougly double the 28608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# memory usage. The cache size is given by this formula: 28708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, 28808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# corresponding to a cache size of 2^16 = 65536 symbols 28908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 29008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenSYMBOL_CACHE_SIZE = 0 29108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 29208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten#--------------------------------------------------------------------------- 29308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# Build related configuration options 29408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten#--------------------------------------------------------------------------- 29508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 29608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 29708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# documentation are documented, even if no documentation was available. 29808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# Private class members and static file members will be hidden unless 29908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES 30008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 30108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenEXTRACT_ALL = YES 30208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 30308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the EXTRACT_PRIVATE tag is set to YES all private members of a class 30408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# will be included in the documentation. 30508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 30608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenEXTRACT_PRIVATE = YES 30708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 30808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the EXTRACT_STATIC tag is set to YES all static members of a file 30908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# will be included in the documentation. 31008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 31108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenEXTRACT_STATIC = YES 31208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 31308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 31408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# defined locally in source files will be included in the documentation. 31508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If set to NO only classes defined in header files are included. 31608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 31708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenEXTRACT_LOCAL_CLASSES = YES 31808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 31908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# This flag is only useful for Objective-C code. When set to YES local 32008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# methods, which are defined in the implementation section but not in 32108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# the interface are included in the documentation. 32208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If set to NO (the default) only methods in the interface are included. 32308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 32408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenEXTRACT_LOCAL_METHODS = NO 32508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 32608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If this flag is set to YES, the members of anonymous namespaces will be 32708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# extracted and appear in the documentation as a namespace called 32808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# 'anonymous_namespace{file}', where file will be replaced with the base 32908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# name of the file that contains the anonymous namespace. By default 33008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# anonymous namespace are hidden. 33108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 33208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenEXTRACT_ANON_NSPACES = NO 33308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 33408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 33508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# undocumented members of documented classes, files or namespaces. 33608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If set to NO (the default) these members will be included in the 33708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# various overviews, but no documentation section is generated. 33808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# This option has no effect if EXTRACT_ALL is enabled. 33908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 34008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenHIDE_UNDOC_MEMBERS = NO 34108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 34208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 34308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# undocumented classes that are normally visible in the class hierarchy. 34408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If set to NO (the default) these classes will be included in the various 34508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# overviews. This option has no effect if EXTRACT_ALL is enabled. 34608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 34708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenHIDE_UNDOC_CLASSES = NO 34808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 34908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 35008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# friend (class|struct|union) declarations. 35108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If set to NO (the default) these declarations will be included in the 35208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# documentation. 35308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 35408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenHIDE_FRIEND_COMPOUNDS = NO 35508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 35608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 35708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# documentation blocks found inside the body of a function. 35808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If set to NO (the default) these blocks will be appended to the 35908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# function's detailed documentation block. 36008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 36108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenHIDE_IN_BODY_DOCS = NO 36208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 36308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# The INTERNAL_DOCS tag determines if documentation 36408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# that is typed after a \internal command is included. If the tag is set 36508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# to NO (the default) then the documentation will be excluded. 36608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# Set it to YES to include the internal documentation. 36708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 36808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenINTERNAL_DOCS = NO 36908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 37008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 37108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# file names in lower-case letters. If set to YES upper-case letters are also 37208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# allowed. This is useful if you have classes or files whose names only differ 37308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# in case and if your file system supports case sensitive file names. Windows 37408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# and Mac users are advised to set this option to NO. 37508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 37608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenCASE_SENSE_NAMES = NO 37708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 37808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 37908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# will show members with their full class and namespace scopes in the 38008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# documentation. If set to YES the scope will be hidden. 38108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 38208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenHIDE_SCOPE_NAMES = NO 38308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 38408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 38508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# will put a list of the files that are included by a file in the documentation 38608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# of that file. 38708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 38808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenSHOW_INCLUDE_FILES = YES 38908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 39008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen 39108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# will list include files with double quotes in the documentation 39208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# rather than with sharp brackets. 39308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 39408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenFORCE_LOCAL_INCLUDES = NO 39508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 39608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 39708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# is inserted in the documentation for inline members. 39808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 39908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenINLINE_INFO = YES 40008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 40108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 40208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# will sort the (detailed) documentation of file and class members 40308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# alphabetically by member name. If set to NO the members will appear in 40408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# declaration order. 40508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 40608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenSORT_MEMBER_DOCS = NO 40708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 40808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 40908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# brief documentation of file, namespace and class members alphabetically 41008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# by member name. If set to NO (the default) the members will appear in 41108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# declaration order. 41208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 41308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenSORT_BRIEF_DOCS = NO 41408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 41508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen 41608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# will sort the (brief and detailed) documentation of class members so that 41708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# constructors and destructors are listed first. If set to NO (the default) 41808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# the constructors will appear in the respective orders defined by 41908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. 42008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO 42108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. 42208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 42308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenSORT_MEMBERS_CTORS_1ST = NO 42408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 42508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the 42608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# hierarchy of group names into alphabetical order. If set to NO (the default) 42708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# the group names will appear in their defined order. 42808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 42908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenSORT_GROUP_NAMES = NO 43008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 43108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 43208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# sorted by fully-qualified names, including namespaces. If set to 43308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# NO (the default), the class list will be sorted only by class name, 43408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# not including the namespace part. 43508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 43608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# Note: This option applies only to the class list, not to the 43708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# alphabetical list. 43808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 43908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenSORT_BY_SCOPE_NAME = NO 44008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 44108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# The GENERATE_TODOLIST tag can be used to enable (YES) or 44208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# disable (NO) the todo list. This list is created by putting \todo 44308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# commands in the documentation. 44408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 44508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenGENERATE_TODOLIST = YES 44608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 44708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# The GENERATE_TESTLIST tag can be used to enable (YES) or 44808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# disable (NO) the test list. This list is created by putting \test 44908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# commands in the documentation. 45008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 45108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenGENERATE_TESTLIST = YES 45208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 45308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# The GENERATE_BUGLIST tag can be used to enable (YES) or 45408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# disable (NO) the bug list. This list is created by putting \bug 45508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# commands in the documentation. 45608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 45708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenGENERATE_BUGLIST = YES 45808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 45908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 46008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# disable (NO) the deprecated list. This list is created by putting 46108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# \deprecated commands in the documentation. 46208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 46308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenGENERATE_DEPRECATEDLIST= YES 46408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 46508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# The ENABLED_SECTIONS tag can be used to enable conditional 46608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# documentation sections, marked by \if sectionname ... \endif. 46708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 46808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenENABLED_SECTIONS = 46908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 47008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# The MAX_INITIALIZER_LINES tag determines the maximum number of lines 47108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# the initial value of a variable or define consists of for it to appear in 47208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# the documentation. If the initializer consists of more lines than specified 47308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# here it will be hidden. Use a value of 0 to hide initializers completely. 47408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# The appearance of the initializer of individual variables and defines in the 47508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# documentation can be controlled using \showinitializer or \hideinitializer 47608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# command in the documentation regardless of this setting. 47708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 47808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenMAX_INITIALIZER_LINES = 30 47908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 48008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# Set the SHOW_USED_FILES tag to NO to disable the list of files generated 48108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# at the bottom of the documentation of classes and structs. If set to YES the 48208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# list will mention the files that were used to generate the documentation. 48308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 48408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenSHOW_USED_FILES = YES 48508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 48608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the sources in your project are distributed over multiple directories 48708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy 48808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# in the documentation. The default is NO. 48908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 49008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenSHOW_DIRECTORIES = NO 49108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 49208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# Set the SHOW_FILES tag to NO to disable the generation of the Files page. 49308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# This will remove the Files entry from the Quick Index and from the 49408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# Folder Tree View (if specified). The default is YES. 49508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 49608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenSHOW_FILES = YES 49708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 49808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# Set the SHOW_NAMESPACES tag to NO to disable the generation of the 49908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# Namespaces page. 50008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# This will remove the Namespaces entry from the Quick Index 50108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# and from the Folder Tree View (if specified). The default is YES. 50208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 50308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenSHOW_NAMESPACES = YES 50408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 50508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# The FILE_VERSION_FILTER tag can be used to specify a program or script that 50608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# doxygen should invoke to get the current version for each file (typically from 50708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# the version control system). Doxygen will invoke the program by executing (via 50808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# popen()) the command <command> <input-file>, where <command> is the value of 50908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file 51008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# provided by doxygen. Whatever the program writes to standard output 51108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# is used as the file version. See the manual for examples. 51208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 51308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenFILE_VERSION_FILTER = 51408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 51508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed 51608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# by doxygen. The layout file controls the global structure of the generated 51708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# output files in an output format independent way. The create the layout file 51808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# that represents doxygen's defaults, run doxygen with the -l option. 51908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# You can optionally specify a file name after the option, if omitted 52008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# DoxygenLayout.xml will be used as the name of the layout file. 52108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 52208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenLAYOUT_FILE = 52308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 52408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten#--------------------------------------------------------------------------- 52508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# configuration options related to warning and progress messages 52608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten#--------------------------------------------------------------------------- 52708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 52808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# The QUIET tag can be used to turn on/off the messages that are generated 52908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# by doxygen. Possible values are YES and NO. If left blank NO is used. 53008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 53108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenQUIET = YES 53208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 53308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# The WARNINGS tag can be used to turn on/off the warning messages that are 53408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# generated by doxygen. Possible values are YES and NO. If left blank 53508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# NO is used. 53608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 53708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenWARNINGS = YES 53808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 53908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 54008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# for undocumented members. If EXTRACT_ALL is set to YES then this flag will 54108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# automatically be disabled. 54208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 54308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenWARN_IF_UNDOCUMENTED = YES 54408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 54508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 54608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# potential errors in the documentation, such as not documenting some 54708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# parameters in a documented function, or documenting parameters that 54808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# don't exist or using markup commands wrongly. 54908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 55008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenWARN_IF_DOC_ERROR = YES 55108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 55208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# This WARN_NO_PARAMDOC option can be abled to get warnings for 55308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# functions that are documented, but have no documentation for their parameters 55408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# or return value. If set to NO (the default) doxygen will only warn about 55508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# wrong or incomplete parameter documentation, but not about the absence of 55608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# documentation. 55708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 55808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenWARN_NO_PARAMDOC = NO 55908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 56008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# The WARN_FORMAT tag determines the format of the warning messages that 56108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# doxygen can produce. The string should contain the $file, $line, and $text 56208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# tags, which will be replaced by the file and line number from which the 56308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# warning originated and the warning text. Optionally the format may contain 56408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# $version, which will be replaced by the version of the file (if it could 56508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# be obtained via FILE_VERSION_FILTER) 56608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 56708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenWARN_FORMAT = "$file:$line: $text" 56808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 56908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# The WARN_LOGFILE tag can be used to specify a file to which warning 57008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# and error messages should be written. If left blank the output is written 57108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# to stderr. 57208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 57308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenWARN_LOGFILE = 57408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 57508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten#--------------------------------------------------------------------------- 57608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# configuration options related to the input files 57708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten#--------------------------------------------------------------------------- 57808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 57908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# The INPUT tag can be used to specify the files and/or directories that contain 58008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# documented source files. You may enter file names like "myfile.cpp" or 58108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# directories like "/usr/src/myproject". Separate the files or directories 58208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# with spaces. 58308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 584262059f71a68edc5e510427c63f5f1623d3672a8Glenn KastenINPUT = ../src 58508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 58608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# This tag can be used to specify the character encoding of the source files 58708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is 58808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# also the default input encoding. Doxygen uses libiconv (or the iconv built 58908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for 59008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# the list of possible encodings. 59108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 59208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenINPUT_ENCODING = UTF-8 59308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 59408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the value of the INPUT tag contains directories, you can use the 59508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 59608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# and *.h) to filter out the source-files in the directories. If left 59708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# blank the following patterns are tested: 59808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx 59908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 60008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 60108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenFILE_PATTERNS = 60208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 60308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# The RECURSIVE tag can be used to turn specify whether or not subdirectories 60408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# should be searched for input files as well. Possible values are YES and NO. 60508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If left blank NO is used. 60608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 60708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenRECURSIVE = NO 60808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 60908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# The EXCLUDE tag can be used to specify files and/or directories that should 61008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# excluded from the INPUT source files. This way you can easily exclude a 61108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# subdirectory from a directory tree whose root is specified with the INPUT tag. 61208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 61308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenEXCLUDE = 61408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 61508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# The EXCLUDE_SYMLINKS tag can be used select whether or not files or 61608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# directories that are symbolic links (a Unix filesystem feature) are excluded 61708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# from the input. 61808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 61908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenEXCLUDE_SYMLINKS = NO 62008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 62108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the value of the INPUT tag contains directories, you can use the 62208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 62308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# certain files from those directories. Note that the wildcards are matched 62408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# against the file with absolute path, so to exclude all test directories 62508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# for example use the pattern */test/* 62608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 62708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenEXCLUDE_PATTERNS = 62808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 62908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 63008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# (namespaces, classes, functions, etc.) that should be excluded from the 63108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# output. The symbol name can be a fully qualified name, a word, or if the 63208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# wildcard * is used, a substring. Examples: ANamespace, AClass, 63308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# AClass::ANamespace, ANamespace::*Test 63408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 63508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenEXCLUDE_SYMBOLS = 63608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 63708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# The EXAMPLE_PATH tag can be used to specify one or more files or 63808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# directories that contain example code fragments that are included (see 63908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# the \include command). 64008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 64108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenEXAMPLE_PATH = 64208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 64308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the value of the EXAMPLE_PATH tag contains directories, you can use the 64408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 64508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# and *.h) to filter out the source-files in the directories. If left 64608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# blank all files are included. 64708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 64808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenEXAMPLE_PATTERNS = 64908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 65008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 65108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# searched for input files to be used with the \include or \dontinclude 65208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# commands irrespective of the value of the RECURSIVE tag. 65308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# Possible values are YES and NO. If left blank NO is used. 65408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 65508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenEXAMPLE_RECURSIVE = NO 65608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 65708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# The IMAGE_PATH tag can be used to specify one or more files or 65808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# directories that contain image that are included in the documentation (see 65908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# the \image command). 66008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 66108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenIMAGE_PATH = 66208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 66308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# The INPUT_FILTER tag can be used to specify a program that doxygen should 66408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# invoke to filter for each input file. Doxygen will invoke the filter program 66508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# by executing (via popen()) the command <filter> <input-file>, where <filter> 66608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# is the value of the INPUT_FILTER tag, and <input-file> is the name of an 66708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# input file. Doxygen will then use the output that the filter program writes 66808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# to standard output. 66908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If FILTER_PATTERNS is specified, this tag will be 67008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# ignored. 67108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 67208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenINPUT_FILTER = 67308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 67408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 67508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# basis. 67608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# Doxygen will compare the file name with each pattern and apply the 67708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# filter if there is a match. 67808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# The filters are a list of the form: 67908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 68008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER 68108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# is applied to all files. 68208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 68308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenFILTER_PATTERNS = 68408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 68508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 68608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# INPUT_FILTER) will be used to filter the input files when producing source 68708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# files to browse (i.e. when SOURCE_BROWSER is set to YES). 68808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 68908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenFILTER_SOURCE_FILES = NO 69008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 69108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten#--------------------------------------------------------------------------- 69208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# configuration options related to source browsing 69308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten#--------------------------------------------------------------------------- 69408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 69508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the SOURCE_BROWSER tag is set to YES then a list of source files will 69608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# be generated. Documented entities will be cross-referenced with these sources. 69708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# Note: To get rid of all source code in the generated output, make sure also 69808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# VERBATIM_HEADERS is set to NO. 69908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 70008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenSOURCE_BROWSER = NO 70108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 70208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# Setting the INLINE_SOURCES tag to YES will include the body 70308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# of functions and classes directly in the documentation. 70408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 70508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenINLINE_SOURCES = NO 70608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 70708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 70808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# doxygen to hide any special comment blocks from generated source code 70908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# fragments. Normal C and C++ comments will always remain visible. 71008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 71108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenSTRIP_CODE_COMMENTS = NO 71208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 71308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the REFERENCED_BY_RELATION tag is set to YES 71408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# then for each documented function all documented 71508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# functions referencing it will be listed. 71608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 71708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenREFERENCED_BY_RELATION = YES 71808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 71908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the REFERENCES_RELATION tag is set to YES 72008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# then for each documented function all documented entities 72108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# called/used by that function will be listed. 72208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 72308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenREFERENCES_RELATION = YES 72408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 72508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) 72608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from 72708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will 72808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# link to the source code. 72908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# Otherwise they will link to the documentation. 73008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 73108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenREFERENCES_LINK_SOURCE = YES 73208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 73308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the USE_HTAGS tag is set to YES then the references to source code 73408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# will point to the HTML generated by the htags(1) tool instead of doxygen 73508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# built-in source browser. The htags tool is part of GNU's global source 73608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# tagging system (see http://www.gnu.org/software/global/global.html). You 73708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# will need version 4.8.6 or higher. 73808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 73908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenUSE_HTAGS = NO 74008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 74108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 74208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# will generate a verbatim copy of the header file for each class for 74308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# which an include is specified. Set to NO to disable this. 74408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 74508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenVERBATIM_HEADERS = YES 74608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 74708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten#--------------------------------------------------------------------------- 74808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# configuration options related to the alphabetical class index 74908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten#--------------------------------------------------------------------------- 75008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 75108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 75208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# of all compounds will be generated. Enable this if the project 75308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# contains a lot of classes, structs, unions or interfaces. 75408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 75508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenALPHABETICAL_INDEX = YES 75608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 75708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 75808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 75908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# in which this list will be split (can be a number in the range [1..20]) 76008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 76108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenCOLS_IN_ALPHA_INDEX = 5 76208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 76308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# In case all classes in a project start with a common prefix, all 76408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# classes will be put under the same header in the alphabetical index. 76508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# The IGNORE_PREFIX tag can be used to specify one or more prefixes that 76608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# should be ignored while generating the index headers. 76708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 76808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenIGNORE_PREFIX = 76908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 77008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten#--------------------------------------------------------------------------- 77108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# configuration options related to the HTML output 77208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten#--------------------------------------------------------------------------- 77308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 77408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the GENERATE_HTML tag is set to YES (the default) Doxygen will 77508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# generate HTML output. 77608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 77708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenGENERATE_HTML = YES 77808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 77908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 78008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If a relative path is entered the value of OUTPUT_DIRECTORY will be 78108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# put in front of it. If left blank `html' will be used as the default path. 78208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 78308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenHTML_OUTPUT = html 78408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 78508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# The HTML_FILE_EXTENSION tag can be used to specify the file extension for 78608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# each generated HTML page (for example: .htm,.php,.asp). If it is left blank 78708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# doxygen will generate files with .html extension. 78808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 78908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenHTML_FILE_EXTENSION = .html 79008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 79108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# The HTML_HEADER tag can be used to specify a personal HTML header for 79208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# each generated HTML page. If it is left blank doxygen will generate a 79308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# standard header. 79408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 79508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenHTML_HEADER = 79608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 79708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# The HTML_FOOTER tag can be used to specify a personal HTML footer for 79808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# each generated HTML page. If it is left blank doxygen will generate a 79908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# standard footer. 80008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 80108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenHTML_FOOTER = 80208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 80308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# The HTML_STYLESHEET tag can be used to specify a user-defined cascading 80408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# style sheet that is used by each HTML page. It can be used to 80508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# fine-tune the look of the HTML output. If the tag is left blank doxygen 80608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# will generate a default style sheet. Note that doxygen will try to copy 80708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# the style sheet file to the HTML output directory, so don't put your own 80808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# stylesheet in the HTML output directory as well, or it will be erased! 80908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 81008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenHTML_STYLESHEET = 81108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 81208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. 81308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# Doxygen will adjust the colors in the stylesheet and background images 81408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# according to this color. Hue is specified as an angle on a colorwheel, 81508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# see http://en.wikipedia.org/wiki/Hue for more information. 81608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# For instance the value 0 represents red, 60 is yellow, 120 is green, 81708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# 180 is cyan, 240 is blue, 300 purple, and 360 is red again. 81808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# The allowed range is 0 to 359. 81908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 82008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenHTML_COLORSTYLE_HUE = 220 82108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 82208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of 82308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# the colors in the HTML output. For a value of 0 the output will use 82408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# grayscales only. A value of 255 will produce the most vivid colors. 82508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 82608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenHTML_COLORSTYLE_SAT = 100 82708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 82808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to 82908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# the luminance component of the colors in the HTML output. Values below 83008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# 100 gradually make the output lighter, whereas values above 100 make 83108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# the output darker. The value divided by 100 is the actual gamma applied, 83208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, 83308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# and 100 does not change the gamma. 83408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 83508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenHTML_COLORSTYLE_GAMMA = 80 83608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 83708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML 83808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# page will contain the date and time when the page was generated. Setting 83908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# this to NO can help when comparing the output of multiple runs. 84008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 84108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenHTML_TIMESTAMP = YES 84208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 84308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 84408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# files or namespaces will be aligned in HTML using tables. If set to 84508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# NO a bullet list will be used. 84608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 84708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenHTML_ALIGN_MEMBERS = YES 84808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 84908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 85008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# documentation will contain sections that can be hidden and shown after the 85108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# page has loaded. For this to work a browser that supports 85208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox 85308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). 85408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 85508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenHTML_DYNAMIC_SECTIONS = NO 85608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 85708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the GENERATE_DOCSET tag is set to YES, additional index files 85808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# will be generated that can be used as input for Apple's Xcode 3 85908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# integrated development environment, introduced with OSX 10.5 (Leopard). 86008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# To create a documentation set, doxygen will generate a Makefile in the 86108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# HTML output directory. Running make will produce the docset in that 86208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# directory and running "make install" will install the docset in 86308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find 86408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# it at startup. 86508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html 86608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# for more information. 86708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 86808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenGENERATE_DOCSET = NO 86908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 87008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the 87108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# feed. A documentation feed provides an umbrella under which multiple 87208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# documentation sets from a single provider (such as a company or product suite) 87308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# can be grouped. 87408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 87508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenDOCSET_FEEDNAME = "Doxygen generated docs" 87608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 87708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that 87808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# should uniquely identify the documentation set bundle. This should be a 87908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen 88008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# will append .docset to the name. 88108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 88208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenDOCSET_BUNDLE_ID = org.doxygen.Project 88308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 88408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify 88508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# the documentation publisher. This should be a reverse domain-name style 88608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# string, e.g. com.mycompany.MyDocSet.documentation. 88708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 88808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenDOCSET_PUBLISHER_ID = org.doxygen.Publisher 88908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 89008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. 89108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 89208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenDOCSET_PUBLISHER_NAME = Publisher 89308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 89408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the GENERATE_HTMLHELP tag is set to YES, additional index files 89508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# will be generated that can be used as input for tools like the 89608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) 89708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# of the generated HTML documentation. 89808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 89908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenGENERATE_HTMLHELP = NO 90008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 90108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 90208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# be used to specify the file name of the resulting .chm file. You 90308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# can add a path in front of the file if the result should not be 90408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# written to the html output directory. 90508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 90608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenCHM_FILE = 90708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 90808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 90908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# be used to specify the location (absolute path including file name) of 91008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 91108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# the HTML help compiler on the generated index.hhp. 91208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 91308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenHHC_LOCATION = 91408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 91508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 91608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# controls if a separate .chi index file is generated (YES) or that 91708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# it should be included in the master .chm file (NO). 91808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 91908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenGENERATE_CHI = NO 92008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 92108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING 92208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# is used to encode HtmlHelp index (hhk), content (hhc) and project file 92308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# content. 92408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 92508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenCHM_INDEX_ENCODING = 92608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 92708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 92808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# controls whether a binary table of contents is generated (YES) or a 92908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# normal table of contents (NO) in the .chm file. 93008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 93108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenBINARY_TOC = NO 93208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 93308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# The TOC_EXPAND flag can be set to YES to add extra items for group members 93408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# to the contents of the HTML help documentation and to the tree view. 93508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 93608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenTOC_EXPAND = NO 93708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 93808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and 93908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated 94008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# that can be used as input for Qt's qhelpgenerator to generate a 94108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# Qt Compressed Help (.qch) of the generated HTML documentation. 94208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 94308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenGENERATE_QHP = NO 94408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 94508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the QHG_LOCATION tag is specified, the QCH_FILE tag can 94608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# be used to specify the file name of the resulting .qch file. 94708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# The path specified is relative to the HTML output folder. 94808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 94908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenQCH_FILE = 95008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 95108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# The QHP_NAMESPACE tag specifies the namespace to use when generating 95208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# Qt Help Project output. For more information please see 95308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# http://doc.trolltech.com/qthelpproject.html#namespace 95408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 95508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenQHP_NAMESPACE = org.doxygen.Project 95608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 95708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating 95808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# Qt Help Project output. For more information please see 95908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# http://doc.trolltech.com/qthelpproject.html#virtual-folders 96008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 96108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenQHP_VIRTUAL_FOLDER = doc 96208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 96308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to 96408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# add. For more information please see 96508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# http://doc.trolltech.com/qthelpproject.html#custom-filters 96608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 96708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenQHP_CUST_FILTER_NAME = 96808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 96908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the 97008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# custom filter to add. For more information please see 97108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters"> 97208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# Qt Help Project / Custom Filters</a>. 97308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 97408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenQHP_CUST_FILTER_ATTRS = 97508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 97608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this 97708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# project's 97808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# filter section matches. 97908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes"> 98008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# Qt Help Project / Filter Attributes</a>. 98108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 98208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenQHP_SECT_FILTER_ATTRS = 98308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 98408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can 98508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# be used to specify the location of Qt's qhelpgenerator. 98608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If non-empty doxygen will try to run qhelpgenerator on the generated 98708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# .qhp file. 98808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 98908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenQHG_LOCATION = 99008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 99108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files 99208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# will be generated, which together with the HTML files, form an Eclipse help 99308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# plugin. To install this plugin and make it available under the help contents 99408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# menu in Eclipse, the contents of the directory containing the HTML and XML 99508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# files needs to be copied into the plugins directory of eclipse. The name of 99608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# the directory within the plugins directory should be the same as 99708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before 99808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# the help appears. 99908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 100008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenGENERATE_ECLIPSEHELP = NO 100108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 100208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# A unique identifier for the eclipse help plugin. When installing the plugin 100308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# the directory name containing the HTML and XML files should also have 100408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# this name. 100508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 100608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenECLIPSE_DOC_ID = org.doxygen.Project 100708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 100808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# The DISABLE_INDEX tag can be used to turn on/off the condensed index at 100908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# top of each HTML page. The value NO (the default) enables the index and 101008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# the value YES disables it. 101108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 101208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenDISABLE_INDEX = NO 101308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 101408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# This tag can be used to set the number of enum values (range [1..20]) 101508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# that doxygen will group on one line in the generated HTML documentation. 101608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 101708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenENUM_VALUES_PER_LINE = 4 101808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 101908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 102008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# structure should be generated to display hierarchical information. 102108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the tag value is set to YES, a side panel will be generated 102208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# containing a tree-like index structure (just like the one that 102308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# is generated for HTML Help). For this to work a browser that supports 102408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). 102508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# Windows users are probably better off using the HTML help feature. 102608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 102708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenGENERATE_TREEVIEW = NO 102808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 102908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories, 103008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# and Class Hierarchy pages using a tree view instead of an ordered list. 103108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 103208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenUSE_INLINE_TREES = NO 103308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 103408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 103508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# used to set the initial width (in pixels) of the frame in which the tree 103608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# is shown. 103708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 103808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenTREEVIEW_WIDTH = 250 103908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 104008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open 104108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# links to external symbols imported via tag files in a separate window. 104208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 104308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenEXT_LINKS_IN_WINDOW = NO 104408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 104508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# Use this tag to change the font size of Latex formulas included 104608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# as images in the HTML documentation. The default is 10. Note that 104708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# when you change the font size after a successful doxygen run you need 104808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# to manually remove any form_*.png images from the HTML output directory 104908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# to force them to be regenerated. 105008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 105108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenFORMULA_FONTSIZE = 10 105208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 105308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# Use the FORMULA_TRANPARENT tag to determine whether or not the images 105408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# generated for formulas are transparent PNGs. Transparent PNGs are 105508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# not supported properly for IE 6.0, but are supported on all modern browsers. 105608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# Note that when changing this option you need to delete any form_*.png files 105708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# in the HTML output before the changes have effect. 105808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 105908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenFORMULA_TRANSPARENT = YES 106008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 106108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# When the SEARCHENGINE tag is enabled doxygen will generate a search box 106208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# for the HTML output. The underlying search engine uses javascript 106308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# and DHTML and should work on any modern browser. Note that when using 106408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets 106508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# (GENERATE_DOCSET) there is already a search function so this one should 106608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# typically be disabled. For large projects the javascript based search engine 106708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. 106808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 106908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenSEARCHENGINE = YES 107008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 107108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# When the SERVER_BASED_SEARCH tag is enabled the search engine will be 107208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# implemented using a PHP enabled web server instead of at the web client 107308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# using Javascript. Doxygen will generate the search PHP script and index 107408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# file to put on the web server. The advantage of the server 107508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# based approach is that it scales better to large projects and allows 107608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# full text search. The disadvances is that it is more difficult to setup 107708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# and does not have live searching capabilities. 107808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 107908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenSERVER_BASED_SEARCH = NO 108008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 108108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten#--------------------------------------------------------------------------- 108208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# configuration options related to the LaTeX output 108308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten#--------------------------------------------------------------------------- 108408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 108508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 108608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# generate Latex output. 108708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 108808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenGENERATE_LATEX = NO 108908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 109008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 109108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If a relative path is entered the value of OUTPUT_DIRECTORY will be 109208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# put in front of it. If left blank `latex' will be used as the default path. 109308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 109408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenLATEX_OUTPUT = latex 109508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 109608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 109708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# invoked. If left blank `latex' will be used as the default command name. 109808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# Note that when enabling USE_PDFLATEX this option is only used for 109908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# generating bitmaps for formulas in the HTML output, but not in the 110008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# Makefile that is written to the output directory. 110108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 110208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenLATEX_CMD_NAME = latex 110308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 110408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 110508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# generate index for LaTeX. If left blank `makeindex' will be used as the 110608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# default command name. 110708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 110808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenMAKEINDEX_CMD_NAME = makeindex 110908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 111008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 111108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# LaTeX documents. This may be useful for small projects and may help to 111208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# save some trees in general. 111308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 111408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenCOMPACT_LATEX = NO 111508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 111608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# The PAPER_TYPE tag can be used to set the paper type that is used 111708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# by the printer. Possible values are: a4, a4wide, letter, legal and 111808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# executive. If left blank a4wide will be used. 111908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 112008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenPAPER_TYPE = a4wide 112108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 112208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 112308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# packages that should be included in the LaTeX output. 112408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 112508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenEXTRA_PACKAGES = 112608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 112708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# The LATEX_HEADER tag can be used to specify a personal LaTeX header for 112808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# the generated latex document. The header should contain everything until 112908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# the first chapter. If it is left blank doxygen will generate a 113008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# standard header. Notice: only use this tag if you know what you are doing! 113108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 113208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenLATEX_HEADER = 113308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 113408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 113508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# is prepared for conversion to pdf (using ps2pdf). The pdf file will 113608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# contain links (just like the HTML output) instead of page references 113708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# This makes the output suitable for online browsing using a pdf viewer. 113808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 113908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenPDF_HYPERLINKS = YES 114008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 114108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 114208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# plain latex in the generated Makefile. Set this option to YES to get a 114308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# higher quality PDF documentation. 114408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 114508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenUSE_PDFLATEX = YES 114608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 114708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 114808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# command to the generated LaTeX files. This will instruct LaTeX to keep 114908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# running if errors occur, instead of asking the user for help. 115008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# This option is also used when generating formulas in HTML. 115108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 115208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenLATEX_BATCHMODE = NO 115308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 115408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If LATEX_HIDE_INDICES is set to YES then doxygen will not 115508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# include the index chapters (such as File Index, Compound Index, etc.) 115608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# in the output. 115708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 115808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenLATEX_HIDE_INDICES = NO 115908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 116008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If LATEX_SOURCE_CODE is set to YES then doxygen will include 116108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# source code with syntax highlighting in the LaTeX output. 116208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# Note that which sources are shown also depends on other settings 116308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# such as SOURCE_BROWSER. 116408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 116508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenLATEX_SOURCE_CODE = NO 116608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 116708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten#--------------------------------------------------------------------------- 116808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# configuration options related to the RTF output 116908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten#--------------------------------------------------------------------------- 117008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 117108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 117208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# The RTF output is optimized for Word 97 and may not look very pretty with 117308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# other RTF readers or editors. 117408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 117508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenGENERATE_RTF = NO 117608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 117708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 117808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If a relative path is entered the value of OUTPUT_DIRECTORY will be 117908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# put in front of it. If left blank `rtf' will be used as the default path. 118008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 118108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenRTF_OUTPUT = rtf 118208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 118308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the COMPACT_RTF tag is set to YES Doxygen generates more compact 118408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# RTF documents. This may be useful for small projects and may help to 118508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# save some trees in general. 118608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 118708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenCOMPACT_RTF = NO 118808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 118908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 119008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# will contain hyperlink fields. The RTF file will 119108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# contain links (just like the HTML output) instead of page references. 119208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# This makes the output suitable for online browsing using WORD or other 119308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# programs which support those fields. 119408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# Note: wordpad (write) and others do not support links. 119508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 119608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenRTF_HYPERLINKS = NO 119708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 119808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# Load stylesheet definitions from file. Syntax is similar to doxygen's 119908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# config file, i.e. a series of assignments. You only have to provide 120008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# replacements, missing definitions are set to their default value. 120108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 120208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenRTF_STYLESHEET_FILE = 120308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 120408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# Set optional variables used in the generation of an rtf document. 120508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# Syntax is similar to doxygen's config file. 120608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 120708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenRTF_EXTENSIONS_FILE = 120808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 120908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten#--------------------------------------------------------------------------- 121008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# configuration options related to the man page output 121108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten#--------------------------------------------------------------------------- 121208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 121308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the GENERATE_MAN tag is set to YES (the default) Doxygen will 121408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# generate man pages 121508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 121608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenGENERATE_MAN = NO 121708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 121808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# The MAN_OUTPUT tag is used to specify where the man pages will be put. 121908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If a relative path is entered the value of OUTPUT_DIRECTORY will be 122008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# put in front of it. If left blank `man' will be used as the default path. 122108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 122208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenMAN_OUTPUT = man 122308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 122408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# The MAN_EXTENSION tag determines the extension that is added to 122508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# the generated man pages (default is the subroutine's section .3) 122608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 122708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenMAN_EXTENSION = .3 122808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 122908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the MAN_LINKS tag is set to YES and Doxygen generates man output, 123008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# then it will generate one additional man file for each entity 123108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# documented in the real man page(s). These additional files 123208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# only source the real man page, but without them the man command 123308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# would be unable to find the correct page. The default is NO. 123408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 123508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenMAN_LINKS = NO 123608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 123708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten#--------------------------------------------------------------------------- 123808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# configuration options related to the XML output 123908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten#--------------------------------------------------------------------------- 124008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 124108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the GENERATE_XML tag is set to YES Doxygen will 124208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# generate an XML file that captures the structure of 124308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# the code including all documentation. 124408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 124508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenGENERATE_XML = NO 124608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 124708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# The XML_OUTPUT tag is used to specify where the XML pages will be put. 124808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If a relative path is entered the value of OUTPUT_DIRECTORY will be 124908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# put in front of it. If left blank `xml' will be used as the default path. 125008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 125108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenXML_OUTPUT = xml 125208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 125308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# The XML_SCHEMA tag can be used to specify an XML schema, 125408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# which can be used by a validating XML parser to check the 125508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# syntax of the XML files. 125608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 125708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenXML_SCHEMA = 125808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 125908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# The XML_DTD tag can be used to specify an XML DTD, 126008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# which can be used by a validating XML parser to check the 126108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# syntax of the XML files. 126208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 126308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenXML_DTD = 126408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 126508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the XML_PROGRAMLISTING tag is set to YES Doxygen will 126608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# dump the program listings (including syntax highlighting 126708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# and cross-referencing information) to the XML output. Note that 126808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# enabling this will significantly increase the size of the XML output. 126908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 127008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenXML_PROGRAMLISTING = YES 127108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 127208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten#--------------------------------------------------------------------------- 127308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# configuration options for the AutoGen Definitions output 127408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten#--------------------------------------------------------------------------- 127508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 127608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 127708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# generate an AutoGen Definitions (see autogen.sf.net) file 127808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# that captures the structure of the code including all 127908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# documentation. Note that this feature is still experimental 128008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# and incomplete at the moment. 128108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 128208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenGENERATE_AUTOGEN_DEF = NO 128308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 128408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten#--------------------------------------------------------------------------- 128508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# configuration options related to the Perl module output 128608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten#--------------------------------------------------------------------------- 128708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 128808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the GENERATE_PERLMOD tag is set to YES Doxygen will 128908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# generate a Perl module file that captures the structure of 129008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# the code including all documentation. Note that this 129108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# feature is still experimental and incomplete at the 129208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# moment. 129308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 129408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenGENERATE_PERLMOD = NO 129508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 129608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the PERLMOD_LATEX tag is set to YES Doxygen will generate 129708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# the necessary Makefile rules, Perl scripts and LaTeX code to be able 129808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# to generate PDF and DVI output from the Perl module output. 129908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 130008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenPERLMOD_LATEX = NO 130108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 130208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 130308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# nicely formatted so it can be parsed by a human reader. 130408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# This is useful 130508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# if you want to understand what is going on. 130608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# On the other hand, if this 130708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# tag is set to NO the size of the Perl module output will be much smaller 130808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# and Perl will parse it just the same. 130908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 131008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenPERLMOD_PRETTY = YES 131108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 131208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# The names of the make variables in the generated doxyrules.make file 131308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 131408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# This is useful so different doxyrules.make files included by the same 131508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# Makefile don't overwrite each other's variables. 131608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 131708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenPERLMOD_MAKEVAR_PREFIX = 131808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 131908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten#--------------------------------------------------------------------------- 132008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# Configuration options related to the preprocessor 132108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten#--------------------------------------------------------------------------- 132208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 132308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 132408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# evaluate all C-preprocessor directives found in the sources and include 132508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# files. 132608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 132708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenENABLE_PREPROCESSING = YES 132808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 132908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 133008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# names in the source code. If set to NO (the default) only conditional 133108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# compilation will be performed. Macro expansion can be done in a controlled 133208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# way by setting EXPAND_ONLY_PREDEF to YES. 133308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 133408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenMACRO_EXPANSION = NO 133508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 133608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 133708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# then the macro expansion is limited to the macros specified with the 133808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# PREDEFINED and EXPAND_AS_DEFINED tags. 133908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 134008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenEXPAND_ONLY_PREDEF = NO 134108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 134208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 134308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# in the INCLUDE_PATH (see below) will be search if a #include is found. 134408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 134508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenSEARCH_INCLUDES = YES 134608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 134708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# The INCLUDE_PATH tag can be used to specify one or more directories that 134808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# contain include files that are not input files but should be processed by 134908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# the preprocessor. 135008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 135108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenINCLUDE_PATH = 135208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 135308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 135408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# patterns (like *.h and *.hpp) to filter out the header-files in the 135508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# directories. If left blank, the patterns specified with FILE_PATTERNS will 135608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# be used. 135708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 135808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenINCLUDE_FILE_PATTERNS = 135908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 136008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# The PREDEFINED tag can be used to specify one or more macro names that 136108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# are defined before the preprocessor is started (similar to the -D option of 136208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# gcc). The argument of the tag is a list of macros of the form: name 136308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# or name=definition (no spaces). If the definition and the = are 136408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# omitted =1 is assumed. To prevent a macro definition from being 136508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# undefined via #undef or recursively expanded use the := operator 136608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# instead of the = operator. 136708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 136808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenPREDEFINED = 136908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 137008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 137108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# this tag can be used to specify a list of macro names that should be expanded. 137208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# The macro definition that is found in the sources will be used. 137308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# Use the PREDEFINED tag if you want to use a different macro definition. 137408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 137508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenEXPAND_AS_DEFINED = 137608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 137708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 137808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# doxygen's preprocessor will remove all function-like macros that are alone 137908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# on a line, have an all uppercase name, and do not end with a semicolon. Such 138008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# function macros are typically used for boiler-plate code, and will confuse 138108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# the parser if not removed. 138208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 138308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenSKIP_FUNCTION_MACROS = YES 138408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 138508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten#--------------------------------------------------------------------------- 138608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# Configuration::additions related to external references 138708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten#--------------------------------------------------------------------------- 138808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 138908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# The TAGFILES option can be used to specify one or more tagfiles. 139008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# Optionally an initial location of the external documentation 139108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# can be added for each tagfile. The format of a tag file without 139208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# this location is as follows: 139308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# 139408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# TAGFILES = file1 file2 ... 139508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# Adding location for the tag files is done as follows: 139608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# 139708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# TAGFILES = file1=loc1 "file2 = loc2" ... 139808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# where "loc1" and "loc2" can be relative or absolute paths or 139908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# URLs. If a location is present for each tag, the installdox tool 140008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# does not have to be run to correct the links. 140108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# Note that each tag file must have a unique name 140208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# (where the name does NOT include the path) 140308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If a tag file is not located in the directory in which doxygen 140408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# is run, you must also specify the path to the tagfile here. 140508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 140608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenTAGFILES = 140708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 140808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# When a file name is specified after GENERATE_TAGFILE, doxygen will create 140908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# a tag file that is based on the input files it reads. 141008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 141108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenGENERATE_TAGFILE = 141208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 141308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the ALLEXTERNALS tag is set to YES all external classes will be listed 141408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# in the class index. If set to NO only the inherited external classes 141508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# will be listed. 141608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 141708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenALLEXTERNALS = NO 141808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 141908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 142008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# in the modules index. If set to NO, only the current project's groups will 142108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# be listed. 142208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 142308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenEXTERNAL_GROUPS = YES 142408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 142508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# The PERL_PATH should be the absolute path and name of the perl script 142608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# interpreter (i.e. the result of `which perl'). 142708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 142808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenPERL_PATH = /usr/bin/perl 142908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 143008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten#--------------------------------------------------------------------------- 143108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# Configuration options related to the dot tool 143208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten#--------------------------------------------------------------------------- 143308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 143408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 143508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base 143608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# or super classes. Setting the tag to NO turns the diagrams off. Note that 143708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# this option is superseded by the HAVE_DOT option below. This is only a 143808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# fallback. It is recommended to install and use dot, since it yields more 143908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# powerful graphs. 144008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 144108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenCLASS_DIAGRAMS = YES 144208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 144308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# You can define message sequence charts within doxygen comments using the \msc 144408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# command. Doxygen will then run the mscgen tool (see 144508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the 144608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# documentation. The MSCGEN_PATH tag allows you to specify the directory where 144708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# the mscgen tool resides. If left empty the tool is assumed to be found in the 144808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# default search path. 144908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 145008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenMSCGEN_PATH = 145108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 145208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If set to YES, the inheritance and collaboration graphs will hide 145308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# inheritance and usage relations if the target is undocumented 145408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# or is not a class. 145508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 145608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenHIDE_UNDOC_RELATIONS = YES 145708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 145808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 145908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# available from the path. This tool is part of Graphviz, a graph visualization 146008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# toolkit from AT&T and Lucent Bell Labs. The other options in this section 146108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# have no effect if this option is set to NO (the default) 146208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 146308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenHAVE_DOT = NO 146408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 146508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is 146608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# allowed to run in parallel. When set to 0 (the default) doxygen will 146708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# base this on the number of processors available in the system. You can set it 146808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# explicitly to a value larger than 0 to get control over the balance 146908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# between CPU load and processing speed. 147008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 147108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenDOT_NUM_THREADS = 0 147208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 147308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# By default doxygen will write a font called FreeSans.ttf to the output 147408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# directory and reference it in all dot files that doxygen generates. This 147508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# font does not include all possible unicode characters however, so when you need 147608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# these (or just want a differently looking font) you can specify the font name 147708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# using DOT_FONTNAME. You need need to make sure dot is able to find the font, 147808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# which can be done by putting it in a standard location or by setting the 147908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory 148008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# containing the font. 148108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 148208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenDOT_FONTNAME = FreeSans.ttf 148308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 148408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. 148508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# The default size is 10pt. 148608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 148708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenDOT_FONTSIZE = 10 148808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 148908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# By default doxygen will tell dot to use the output directory to look for the 149008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# FreeSans.ttf font (which doxygen will put there itself). If you specify a 149108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# different font using DOT_FONTNAME you can set the path where dot 149208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# can find it using this tag. 149308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 149408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenDOT_FONTPATH = 149508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 149608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 149708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# will generate a graph for each documented class showing the direct and 149808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# indirect inheritance relations. Setting this tag to YES will force the 149908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# the CLASS_DIAGRAMS tag to NO. 150008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 150108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenCLASS_GRAPH = YES 150208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 150308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 150408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# will generate a graph for each documented class showing the direct and 150508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# indirect implementation dependencies (inheritance, containment, and 150608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# class references variables) of the class with other documented classes. 150708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 150808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenCOLLABORATION_GRAPH = YES 150908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 151008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen 151108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# will generate a graph for groups, showing the direct groups dependencies 151208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 151308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenGROUP_GRAPHS = YES 151408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 151508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the UML_LOOK tag is set to YES doxygen will generate inheritance and 151608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# collaboration diagrams in a style similar to the OMG's Unified Modeling 151708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# Language. 151808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 151908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenUML_LOOK = NO 152008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 152108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If set to YES, the inheritance and collaboration graphs will show the 152208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# relations between templates and their instances. 152308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 152408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenTEMPLATE_RELATIONS = NO 152508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 152608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 152708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# tags are set to YES then doxygen will generate a graph for each documented 152808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# file showing the direct and indirect include dependencies of the file with 152908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# other documented files. 153008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 153108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenINCLUDE_GRAPH = YES 153208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 153308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 153408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# HAVE_DOT tags are set to YES then doxygen will generate a graph for each 153508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# documented header file showing the documented files that directly or 153608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# indirectly include this file. 153708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 153808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenINCLUDED_BY_GRAPH = YES 153908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 154008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the CALL_GRAPH and HAVE_DOT options are set to YES then 154108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# doxygen will generate a call dependency graph for every global function 154208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# or class method. Note that enabling this option will significantly increase 154308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# the time of a run. So in most cases it will be better to enable call graphs 154408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# for selected functions only using the \callgraph command. 154508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 154608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenCALL_GRAPH = NO 154708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 154808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then 154908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# doxygen will generate a caller dependency graph for every global function 155008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# or class method. Note that enabling this option will significantly increase 155108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# the time of a run. So in most cases it will be better to enable caller 155208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# graphs for selected functions only using the \callergraph command. 155308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 155408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenCALLER_GRAPH = NO 155508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 155608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 155708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# will graphical hierarchy of all classes instead of a textual one. 155808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 155908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenGRAPHICAL_HIERARCHY = YES 156008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 156108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES 156208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# then doxygen will show the dependencies a directory has on other directories 156308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# in a graphical way. The dependency relations are determined by the #include 156408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# relations between the files in the directories. 156508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 156608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenDIRECTORY_GRAPH = YES 156708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 156808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 156908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# generated by dot. Possible values are png, jpg, or gif 157008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If left blank png will be used. 157108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 157208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenDOT_IMAGE_FORMAT = png 157308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 157408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# The tag DOT_PATH can be used to specify the path where the dot tool can be 157508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# found. If left blank, it is assumed the dot tool can be found in the path. 157608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 157708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenDOT_PATH = 157808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 157908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# The DOTFILE_DIRS tag can be used to specify one or more directories that 158008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# contain dot files that are included in the documentation (see the 158108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# \dotfile command). 158208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 158308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenDOTFILE_DIRS = 158408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 158508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of 158608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# nodes that will be shown in the graph. If the number of nodes in a graph 158708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# becomes larger than this value, doxygen will truncate the graph, which is 158808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# visualized by representing a node as a red box. Note that doxygen if the 158908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# number of direct children of the root node in a graph is already larger than 159008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note 159108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. 159208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 159308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenDOT_GRAPH_MAX_NODES = 50 159408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 159508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 159608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# graphs generated by dot. A depth value of 3 means that only nodes reachable 159708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# from the root by following a path via at most 3 edges will be shown. Nodes 159808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# that lay further from the root node will be omitted. Note that setting this 159908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# option to 1 or 2 may greatly reduce the computation time needed for large 160008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# code bases. Also note that the size of a graph can be further restricted by 160108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. 160208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 160308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenMAX_DOT_GRAPH_DEPTH = 0 160408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 160508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 160608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# background. This is disabled by default, because dot on Windows does not 160708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# seem to support this out of the box. Warning: Depending on the platform used, 160808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# enabling this option may lead to badly anti-aliased labels on the edges of 160908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# a graph (i.e. they become hard to read). 161008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 161108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenDOT_TRANSPARENT = NO 161208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 161308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output 161408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# files in one run (i.e. multiple -o and -T options on the command line). This 161508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# makes dot run faster, but since only newer versions of dot (>1.8.10) 161608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# support this, this feature is disabled by default. 161708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 161808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenDOT_MULTI_TARGETS = NO 161908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 162008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 162108b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# generate a legend page explaining the meaning of the various boxes and 162208b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# arrows in the dot generated graphs. 162308b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 162408b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenGENERATE_LEGEND = YES 162508b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 162608b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 162708b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# remove the intermediate dot files that are used to generate 162808b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten# the various graphs. 162908b03f82de606abe3d9926bd7b18def5a2b0854bGlenn Kasten 163008b03f82de606abe3d9926bd7b18def5a2b0854bGlenn KastenDOT_CLEANUP = YES 1631