19888Sandreas@sandberg.pp.se# Doxyfile 1.8.1.2 29888Sandreas@sandberg.pp.se 39888Sandreas@sandberg.pp.se# This file describes the settings to be used by the documentation system 49888Sandreas@sandberg.pp.se# doxygen (www.doxygen.org) for a project. 59888Sandreas@sandberg.pp.se# 69888Sandreas@sandberg.pp.se# All text after a hash (#) is considered a comment and will be ignored. 79888Sandreas@sandberg.pp.se# The format is: 89888Sandreas@sandberg.pp.se# TAG = value [value, ...] 99888Sandreas@sandberg.pp.se# For lists items can also be appended using: 109888Sandreas@sandberg.pp.se# TAG += value [value, ...] 119888Sandreas@sandberg.pp.se# Values that contain spaces should be placed between quotes (" "). 129888Sandreas@sandberg.pp.se 139888Sandreas@sandberg.pp.se#--------------------------------------------------------------------------- 149888Sandreas@sandberg.pp.se# Project related configuration options 159888Sandreas@sandberg.pp.se#--------------------------------------------------------------------------- 169888Sandreas@sandberg.pp.se 179888Sandreas@sandberg.pp.se# This tag specifies the encoding used for all characters in the config file 189888Sandreas@sandberg.pp.se# that follow. The default is UTF-8 which is also the encoding used for all 199888Sandreas@sandberg.pp.se# text before the first occurrence of this tag. Doxygen uses libiconv (or the 209888Sandreas@sandberg.pp.se# iconv built into libc) for the transcoding. See 219888Sandreas@sandberg.pp.se# http://www.gnu.org/software/libiconv for the list of possible encodings. 229888Sandreas@sandberg.pp.se 239888Sandreas@sandberg.pp.seDOXYFILE_ENCODING = UTF-8 249888Sandreas@sandberg.pp.se 259888Sandreas@sandberg.pp.se# The PROJECT_NAME tag is a single word (or sequence of words) that should 269888Sandreas@sandberg.pp.se# identify the project. Note that if you do not use Doxywizard you need 279888Sandreas@sandberg.pp.se# to put quotes around the project name if it contains spaces. 289888Sandreas@sandberg.pp.se 299888Sandreas@sandberg.pp.sePROJECT_NAME = "@PACKAGE_STRING@" 309888Sandreas@sandberg.pp.se 319888Sandreas@sandberg.pp.se# The PROJECT_NUMBER tag can be used to enter a project or revision number. 329888Sandreas@sandberg.pp.se# This could be handy for archiving the generated documentation or 339888Sandreas@sandberg.pp.se# if some version control system is used. 349888Sandreas@sandberg.pp.se 359888Sandreas@sandberg.pp.sePROJECT_NUMBER = 369888Sandreas@sandberg.pp.se 379888Sandreas@sandberg.pp.se# Using the PROJECT_BRIEF tag one can provide an optional one line description 389888Sandreas@sandberg.pp.se# for a project that appears at the top of each page and should give viewer 399888Sandreas@sandberg.pp.se# a quick idea about the purpose of the project. Keep the description short. 409888Sandreas@sandberg.pp.se 419888Sandreas@sandberg.pp.sePROJECT_BRIEF = 429888Sandreas@sandberg.pp.se 439888Sandreas@sandberg.pp.se# With the PROJECT_LOGO tag one can specify an logo or icon that is 449888Sandreas@sandberg.pp.se# included in the documentation. The maximum height of the logo should not 459888Sandreas@sandberg.pp.se# exceed 55 pixels and the maximum width should not exceed 200 pixels. 469888Sandreas@sandberg.pp.se# Doxygen will copy the logo to the output directory. 479888Sandreas@sandberg.pp.se 489888Sandreas@sandberg.pp.sePROJECT_LOGO = 499888Sandreas@sandberg.pp.se 509888Sandreas@sandberg.pp.se# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 519888Sandreas@sandberg.pp.se# base path where the generated documentation will be put. 529888Sandreas@sandberg.pp.se# If a relative path is entered, it will be relative to the location 539888Sandreas@sandberg.pp.se# where doxygen was started. If left blank the current directory will be used. 549888Sandreas@sandberg.pp.se 559888Sandreas@sandberg.pp.seOUTPUT_DIRECTORY = @DX_DOCDIR@ 569888Sandreas@sandberg.pp.se 579888Sandreas@sandberg.pp.se# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 589888Sandreas@sandberg.pp.se# 4096 sub-directories (in 2 levels) under the output directory of each output 599888Sandreas@sandberg.pp.se# format and will distribute the generated files over these directories. 609888Sandreas@sandberg.pp.se# Enabling this option can be useful when feeding doxygen a huge amount of 619888Sandreas@sandberg.pp.se# source files, where putting all generated files in the same directory would 629888Sandreas@sandberg.pp.se# otherwise cause performance problems for the file system. 639888Sandreas@sandberg.pp.se 649888Sandreas@sandberg.pp.seCREATE_SUBDIRS = NO 659888Sandreas@sandberg.pp.se 669888Sandreas@sandberg.pp.se# The OUTPUT_LANGUAGE tag is used to specify the language in which all 679888Sandreas@sandberg.pp.se# documentation generated by doxygen is written. Doxygen will use this 689888Sandreas@sandberg.pp.se# information to generate all constant output in the proper language. 699888Sandreas@sandberg.pp.se# The default language is English, other supported languages are: 709888Sandreas@sandberg.pp.se# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, 719888Sandreas@sandberg.pp.se# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, 729888Sandreas@sandberg.pp.se# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English 739888Sandreas@sandberg.pp.se# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, 749888Sandreas@sandberg.pp.se# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, 759888Sandreas@sandberg.pp.se# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. 769888Sandreas@sandberg.pp.se 779888Sandreas@sandberg.pp.seOUTPUT_LANGUAGE = English 789888Sandreas@sandberg.pp.se 799888Sandreas@sandberg.pp.se# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 809888Sandreas@sandberg.pp.se# include brief member descriptions after the members that are listed in 819888Sandreas@sandberg.pp.se# the file and class documentation (similar to JavaDoc). 829888Sandreas@sandberg.pp.se# Set to NO to disable this. 839888Sandreas@sandberg.pp.se 849888Sandreas@sandberg.pp.seBRIEF_MEMBER_DESC = YES 859888Sandreas@sandberg.pp.se 869888Sandreas@sandberg.pp.se# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 879888Sandreas@sandberg.pp.se# the brief description of a member or function before the detailed description. 889888Sandreas@sandberg.pp.se# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 899888Sandreas@sandberg.pp.se# brief descriptions will be completely suppressed. 909888Sandreas@sandberg.pp.se 919888Sandreas@sandberg.pp.seREPEAT_BRIEF = YES 929888Sandreas@sandberg.pp.se 939888Sandreas@sandberg.pp.se# This tag implements a quasi-intelligent brief description abbreviator 949888Sandreas@sandberg.pp.se# that is used to form the text in various listings. Each string 959888Sandreas@sandberg.pp.se# in this list, if found as the leading text of the brief description, will be 969888Sandreas@sandberg.pp.se# stripped from the text and the result after processing the whole list, is 979888Sandreas@sandberg.pp.se# used as the annotated text. Otherwise, the brief description is used as-is. 989888Sandreas@sandberg.pp.se# If left blank, the following values are used ("$name" is automatically 999888Sandreas@sandberg.pp.se# replaced with the name of the entity): "The $name class" "The $name widget" 1009888Sandreas@sandberg.pp.se# "The $name file" "is" "provides" "specifies" "contains" 1019888Sandreas@sandberg.pp.se# "represents" "a" "an" "the" 1029888Sandreas@sandberg.pp.se 1039888Sandreas@sandberg.pp.seABBREVIATE_BRIEF = 1049888Sandreas@sandberg.pp.se 1059888Sandreas@sandberg.pp.se# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 1069888Sandreas@sandberg.pp.se# Doxygen will generate a detailed section even if there is only a brief 1079888Sandreas@sandberg.pp.se# description. 1089888Sandreas@sandberg.pp.se 1099888Sandreas@sandberg.pp.seALWAYS_DETAILED_SEC = NO 1109888Sandreas@sandberg.pp.se 1119888Sandreas@sandberg.pp.se# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 1129888Sandreas@sandberg.pp.se# inherited members of a class in the documentation of that class as if those 1139888Sandreas@sandberg.pp.se# members were ordinary class members. Constructors, destructors and assignment 1149888Sandreas@sandberg.pp.se# operators of the base classes will not be shown. 1159888Sandreas@sandberg.pp.se 1169888Sandreas@sandberg.pp.seINLINE_INHERITED_MEMB = NO 1179888Sandreas@sandberg.pp.se 1189888Sandreas@sandberg.pp.se# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 1199888Sandreas@sandberg.pp.se# path before files name in the file list and in the header files. If set 1209888Sandreas@sandberg.pp.se# to NO the shortest path that makes the file name unique will be used. 1219888Sandreas@sandberg.pp.se 1229888Sandreas@sandberg.pp.seFULL_PATH_NAMES = YES 1239888Sandreas@sandberg.pp.se 1249888Sandreas@sandberg.pp.se# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 1259888Sandreas@sandberg.pp.se# can be used to strip a user-defined part of the path. Stripping is 1269888Sandreas@sandberg.pp.se# only done if one of the specified strings matches the left-hand part of 1279888Sandreas@sandberg.pp.se# the path. The tag can be used to show relative paths in the file list. 1289888Sandreas@sandberg.pp.se# If left blank the directory from which doxygen is run is used as the 1299888Sandreas@sandberg.pp.se# path to strip. 1309888Sandreas@sandberg.pp.se 1319888Sandreas@sandberg.pp.seSTRIP_FROM_PATH = 1329888Sandreas@sandberg.pp.se 1339888Sandreas@sandberg.pp.se# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 1349888Sandreas@sandberg.pp.se# the path mentioned in the documentation of a class, which tells 1359888Sandreas@sandberg.pp.se# the reader which header file to include in order to use a class. 1369888Sandreas@sandberg.pp.se# If left blank only the name of the header file containing the class 1379888Sandreas@sandberg.pp.se# definition is used. Otherwise one should specify the include paths that 1389888Sandreas@sandberg.pp.se# are normally passed to the compiler using the -I flag. 1399888Sandreas@sandberg.pp.se 1409888Sandreas@sandberg.pp.seSTRIP_FROM_INC_PATH = 1419888Sandreas@sandberg.pp.se 1429888Sandreas@sandberg.pp.se# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 1439888Sandreas@sandberg.pp.se# (but less readable) file names. This can be useful if your file system 1449888Sandreas@sandberg.pp.se# doesn't support long names like on DOS, Mac, or CD-ROM. 1459888Sandreas@sandberg.pp.se 1469888Sandreas@sandberg.pp.seSHORT_NAMES = NO 1479888Sandreas@sandberg.pp.se 1489888Sandreas@sandberg.pp.se# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 1499888Sandreas@sandberg.pp.se# will interpret the first line (until the first dot) of a JavaDoc-style 1509888Sandreas@sandberg.pp.se# comment as the brief description. If set to NO, the JavaDoc 1519888Sandreas@sandberg.pp.se# comments will behave just like regular Qt-style comments 1529888Sandreas@sandberg.pp.se# (thus requiring an explicit @brief command for a brief description.) 1539888Sandreas@sandberg.pp.se 1549888Sandreas@sandberg.pp.seJAVADOC_AUTOBRIEF = NO 1559888Sandreas@sandberg.pp.se 1569888Sandreas@sandberg.pp.se# If the QT_AUTOBRIEF tag is set to YES then Doxygen will 1579888Sandreas@sandberg.pp.se# interpret the first line (until the first dot) of a Qt-style 1589888Sandreas@sandberg.pp.se# comment as the brief description. If set to NO, the comments 1599888Sandreas@sandberg.pp.se# will behave just like regular Qt-style comments (thus requiring 1609888Sandreas@sandberg.pp.se# an explicit \brief command for a brief description.) 1619888Sandreas@sandberg.pp.se 1629888Sandreas@sandberg.pp.seQT_AUTOBRIEF = NO 1639888Sandreas@sandberg.pp.se 1649888Sandreas@sandberg.pp.se# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 1659888Sandreas@sandberg.pp.se# treat a multi-line C++ special comment block (i.e. a block of //! or /// 1669888Sandreas@sandberg.pp.se# comments) as a brief description. This used to be the default behaviour. 1679888Sandreas@sandberg.pp.se# The new default is to treat a multi-line C++ comment block as a detailed 1689888Sandreas@sandberg.pp.se# description. Set this tag to YES if you prefer the old behaviour instead. 1699888Sandreas@sandberg.pp.se 1709888Sandreas@sandberg.pp.seMULTILINE_CPP_IS_BRIEF = NO 1719888Sandreas@sandberg.pp.se 1729888Sandreas@sandberg.pp.se# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 1739888Sandreas@sandberg.pp.se# member inherits the documentation from any documented member that it 1749888Sandreas@sandberg.pp.se# re-implements. 1759888Sandreas@sandberg.pp.se 1769888Sandreas@sandberg.pp.seINHERIT_DOCS = YES 1779888Sandreas@sandberg.pp.se 1789888Sandreas@sandberg.pp.se# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce 1799888Sandreas@sandberg.pp.se# a new page for each member. If set to NO, the documentation of a member will 1809888Sandreas@sandberg.pp.se# be part of the file/class/namespace that contains it. 1819888Sandreas@sandberg.pp.se 1829888Sandreas@sandberg.pp.seSEPARATE_MEMBER_PAGES = NO 1839888Sandreas@sandberg.pp.se 1849888Sandreas@sandberg.pp.se# The TAB_SIZE tag can be used to set the number of spaces in a tab. 1859888Sandreas@sandberg.pp.se# Doxygen uses this value to replace tabs by spaces in code fragments. 1869888Sandreas@sandberg.pp.se 1879888Sandreas@sandberg.pp.seTAB_SIZE = 8 1889888Sandreas@sandberg.pp.se 1899888Sandreas@sandberg.pp.se# This tag can be used to specify a number of aliases that acts 1909888Sandreas@sandberg.pp.se# as commands in the documentation. An alias has the form "name=value". 1919888Sandreas@sandberg.pp.se# For example adding "sideeffect=\par Side Effects:\n" will allow you to 1929888Sandreas@sandberg.pp.se# put the command \sideeffect (or @sideeffect) in the documentation, which 1939888Sandreas@sandberg.pp.se# will result in a user-defined paragraph with heading "Side Effects:". 1949888Sandreas@sandberg.pp.se# You can put \n's in the value part of an alias to insert newlines. 1959888Sandreas@sandberg.pp.se 1969888Sandreas@sandberg.pp.seALIASES = 1979888Sandreas@sandberg.pp.se 1989888Sandreas@sandberg.pp.se# This tag can be used to specify a number of word-keyword mappings (TCL only). 1999888Sandreas@sandberg.pp.se# A mapping has the form "name=value". For example adding 2009888Sandreas@sandberg.pp.se# "class=itcl::class" will allow you to use the command class in the 2019888Sandreas@sandberg.pp.se# itcl::class meaning. 2029888Sandreas@sandberg.pp.se 2039888Sandreas@sandberg.pp.seTCL_SUBST = 2049888Sandreas@sandberg.pp.se 2059888Sandreas@sandberg.pp.se# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 2069888Sandreas@sandberg.pp.se# sources only. Doxygen will then generate output that is more tailored for C. 2079888Sandreas@sandberg.pp.se# For instance, some of the names that are used will be different. The list 2089888Sandreas@sandberg.pp.se# of all members will be omitted, etc. 2099888Sandreas@sandberg.pp.se 2109888Sandreas@sandberg.pp.seOPTIMIZE_OUTPUT_FOR_C = NO 2119888Sandreas@sandberg.pp.se 2129888Sandreas@sandberg.pp.se# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java 2139888Sandreas@sandberg.pp.se# sources only. Doxygen will then generate output that is more tailored for 2149888Sandreas@sandberg.pp.se# Java. For instance, namespaces will be presented as packages, qualified 2159888Sandreas@sandberg.pp.se# scopes will look different, etc. 2169888Sandreas@sandberg.pp.se 2179888Sandreas@sandberg.pp.seOPTIMIZE_OUTPUT_JAVA = NO 2189888Sandreas@sandberg.pp.se 2199888Sandreas@sandberg.pp.se# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 2209888Sandreas@sandberg.pp.se# sources only. Doxygen will then generate output that is more tailored for 2219888Sandreas@sandberg.pp.se# Fortran. 2229888Sandreas@sandberg.pp.se 2239888Sandreas@sandberg.pp.seOPTIMIZE_FOR_FORTRAN = NO 2249888Sandreas@sandberg.pp.se 2259888Sandreas@sandberg.pp.se# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 2269888Sandreas@sandberg.pp.se# sources. Doxygen will then generate output that is tailored for 2279888Sandreas@sandberg.pp.se# VHDL. 2289888Sandreas@sandberg.pp.se 2299888Sandreas@sandberg.pp.seOPTIMIZE_OUTPUT_VHDL = NO 2309888Sandreas@sandberg.pp.se 2319888Sandreas@sandberg.pp.se# Doxygen selects the parser to use depending on the extension of the files it 2329888Sandreas@sandberg.pp.se# parses. With this tag you can assign which parser to use for a given extension. 2339888Sandreas@sandberg.pp.se# Doxygen has a built-in mapping, but you can override or extend it using this 2349888Sandreas@sandberg.pp.se# tag. The format is ext=language, where ext is a file extension, and language 2359888Sandreas@sandberg.pp.se# is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C, 2369888Sandreas@sandberg.pp.se# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make 2379888Sandreas@sandberg.pp.se# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C 2389888Sandreas@sandberg.pp.se# (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions 2399888Sandreas@sandberg.pp.se# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen. 2409888Sandreas@sandberg.pp.se 2419888Sandreas@sandberg.pp.seEXTENSION_MAPPING = 2429888Sandreas@sandberg.pp.se 2439888Sandreas@sandberg.pp.se# If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all 2449888Sandreas@sandberg.pp.se# comments according to the Markdown format, which allows for more readable 2459888Sandreas@sandberg.pp.se# documentation. See http://daringfireball.net/projects/markdown/ for details. 2469888Sandreas@sandberg.pp.se# The output of markdown processing is further processed by doxygen, so you 2479888Sandreas@sandberg.pp.se# can mix doxygen, HTML, and XML commands with Markdown formatting. 2489888Sandreas@sandberg.pp.se# Disable only in case of backward compatibilities issues. 2499888Sandreas@sandberg.pp.se 2509888Sandreas@sandberg.pp.seMARKDOWN_SUPPORT = YES 2519888Sandreas@sandberg.pp.se 2529888Sandreas@sandberg.pp.se# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 2539888Sandreas@sandberg.pp.se# to include (a tag file for) the STL sources as input, then you should 2549888Sandreas@sandberg.pp.se# set this tag to YES in order to let doxygen match functions declarations and 2559888Sandreas@sandberg.pp.se# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. 2569888Sandreas@sandberg.pp.se# func(std::string) {}). This also makes the inheritance and collaboration 2579888Sandreas@sandberg.pp.se# diagrams that involve STL classes more complete and accurate. 2589888Sandreas@sandberg.pp.se 2599888Sandreas@sandberg.pp.seBUILTIN_STL_SUPPORT = NO 2609888Sandreas@sandberg.pp.se 2619888Sandreas@sandberg.pp.se# If you use Microsoft's C++/CLI language, you should set this option to YES to 2629888Sandreas@sandberg.pp.se# enable parsing support. 2639888Sandreas@sandberg.pp.se 2649888Sandreas@sandberg.pp.seCPP_CLI_SUPPORT = NO 2659888Sandreas@sandberg.pp.se 2669888Sandreas@sandberg.pp.se# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. 2679888Sandreas@sandberg.pp.se# Doxygen will parse them like normal C++ but will assume all classes use public 2689888Sandreas@sandberg.pp.se# instead of private inheritance when no explicit protection keyword is present. 2699888Sandreas@sandberg.pp.se 2709888Sandreas@sandberg.pp.seSIP_SUPPORT = NO 2719888Sandreas@sandberg.pp.se 2729888Sandreas@sandberg.pp.se# For Microsoft's IDL there are propget and propput attributes to indicate getter 2739888Sandreas@sandberg.pp.se# and setter methods for a property. Setting this option to YES (the default) 2749888Sandreas@sandberg.pp.se# will make doxygen replace the get and set methods by a property in the 2759888Sandreas@sandberg.pp.se# documentation. This will only work if the methods are indeed getting or 2769888Sandreas@sandberg.pp.se# setting a simple type. If this is not the case, or you want to show the 2779888Sandreas@sandberg.pp.se# methods anyway, you should set this option to NO. 2789888Sandreas@sandberg.pp.se 2799888Sandreas@sandberg.pp.seIDL_PROPERTY_SUPPORT = YES 2809888Sandreas@sandberg.pp.se 2819888Sandreas@sandberg.pp.se# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 2829888Sandreas@sandberg.pp.se# tag is set to YES, then doxygen will reuse the documentation of the first 2839888Sandreas@sandberg.pp.se# member in the group (if any) for the other members of the group. By default 2849888Sandreas@sandberg.pp.se# all members of a group must be documented explicitly. 2859888Sandreas@sandberg.pp.se 2869888Sandreas@sandberg.pp.seDISTRIBUTE_GROUP_DOC = NO 2879888Sandreas@sandberg.pp.se 2889888Sandreas@sandberg.pp.se# Set the SUBGROUPING tag to YES (the default) to allow class member groups of 2899888Sandreas@sandberg.pp.se# the same type (for instance a group of public functions) to be put as a 2909888Sandreas@sandberg.pp.se# subgroup of that type (e.g. under the Public Functions section). Set it to 2919888Sandreas@sandberg.pp.se# NO to prevent subgrouping. Alternatively, this can be done per class using 2929888Sandreas@sandberg.pp.se# the \nosubgrouping command. 2939888Sandreas@sandberg.pp.se 2949888Sandreas@sandberg.pp.seSUBGROUPING = YES 2959888Sandreas@sandberg.pp.se 2969888Sandreas@sandberg.pp.se# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and 2979888Sandreas@sandberg.pp.se# unions are shown inside the group in which they are included (e.g. using 2989888Sandreas@sandberg.pp.se# @ingroup) instead of on a separate page (for HTML and Man pages) or 2999888Sandreas@sandberg.pp.se# section (for LaTeX and RTF). 3009888Sandreas@sandberg.pp.se 3019888Sandreas@sandberg.pp.seINLINE_GROUPED_CLASSES = NO 3029888Sandreas@sandberg.pp.se 3039888Sandreas@sandberg.pp.se# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and 3049888Sandreas@sandberg.pp.se# unions with only public data fields will be shown inline in the documentation 3059888Sandreas@sandberg.pp.se# of the scope in which they are defined (i.e. file, namespace, or group 3069888Sandreas@sandberg.pp.se# documentation), provided this scope is documented. If set to NO (the default), 3079888Sandreas@sandberg.pp.se# structs, classes, and unions are shown on a separate page (for HTML and Man 3089888Sandreas@sandberg.pp.se# pages) or section (for LaTeX and RTF). 3099888Sandreas@sandberg.pp.se 3109888Sandreas@sandberg.pp.seINLINE_SIMPLE_STRUCTS = NO 3119888Sandreas@sandberg.pp.se 3129888Sandreas@sandberg.pp.se# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum 3139888Sandreas@sandberg.pp.se# is documented as struct, union, or enum with the name of the typedef. So 3149888Sandreas@sandberg.pp.se# typedef struct TypeS {} TypeT, will appear in the documentation as a struct 3159888Sandreas@sandberg.pp.se# with name TypeT. When disabled the typedef will appear as a member of a file, 3169888Sandreas@sandberg.pp.se# namespace, or class. And the struct will be named TypeS. This can typically 3179888Sandreas@sandberg.pp.se# be useful for C code in case the coding convention dictates that all compound 3189888Sandreas@sandberg.pp.se# types are typedef'ed and only the typedef is referenced, never the tag name. 3199888Sandreas@sandberg.pp.se 3209888Sandreas@sandberg.pp.seTYPEDEF_HIDES_STRUCT = NO 3219888Sandreas@sandberg.pp.se 3229888Sandreas@sandberg.pp.se# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to 3239888Sandreas@sandberg.pp.se# determine which symbols to keep in memory and which to flush to disk. 3249888Sandreas@sandberg.pp.se# When the cache is full, less often used symbols will be written to disk. 3259888Sandreas@sandberg.pp.se# For small to medium size projects (<1000 input files) the default value is 3269888Sandreas@sandberg.pp.se# probably good enough. For larger projects a too small cache size can cause 3279888Sandreas@sandberg.pp.se# doxygen to be busy swapping symbols to and from disk most of the time 3289888Sandreas@sandberg.pp.se# causing a significant performance penalty. 3299888Sandreas@sandberg.pp.se# If the system has enough physical memory increasing the cache will improve the 3309888Sandreas@sandberg.pp.se# performance by keeping more symbols in memory. Note that the value works on 3319888Sandreas@sandberg.pp.se# a logarithmic scale so increasing the size by one will roughly double the 3329888Sandreas@sandberg.pp.se# memory usage. The cache size is given by this formula: 3339888Sandreas@sandberg.pp.se# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, 3349888Sandreas@sandberg.pp.se# corresponding to a cache size of 2^16 = 65536 symbols. 3359888Sandreas@sandberg.pp.se 3369888Sandreas@sandberg.pp.seSYMBOL_CACHE_SIZE = 0 3379888Sandreas@sandberg.pp.se 3389888Sandreas@sandberg.pp.se# Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be 3399888Sandreas@sandberg.pp.se# set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given 3409888Sandreas@sandberg.pp.se# their name and scope. Since this can be an expensive process and often the 3419888Sandreas@sandberg.pp.se# same symbol appear multiple times in the code, doxygen keeps a cache of 3429888Sandreas@sandberg.pp.se# pre-resolved symbols. If the cache is too small doxygen will become slower. 3439888Sandreas@sandberg.pp.se# If the cache is too large, memory is wasted. The cache size is given by this 3449888Sandreas@sandberg.pp.se# formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0, 3459888Sandreas@sandberg.pp.se# corresponding to a cache size of 2^16 = 65536 symbols. 3469888Sandreas@sandberg.pp.se 3479888Sandreas@sandberg.pp.seLOOKUP_CACHE_SIZE = 0 3489888Sandreas@sandberg.pp.se 3499888Sandreas@sandberg.pp.se#--------------------------------------------------------------------------- 3509888Sandreas@sandberg.pp.se# Build related configuration options 3519888Sandreas@sandberg.pp.se#--------------------------------------------------------------------------- 3529888Sandreas@sandberg.pp.se 3539888Sandreas@sandberg.pp.se# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 3549888Sandreas@sandberg.pp.se# documentation are documented, even if no documentation was available. 3559888Sandreas@sandberg.pp.se# Private class members and static file members will be hidden unless 3569888Sandreas@sandberg.pp.se# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES 3579888Sandreas@sandberg.pp.se 3589888Sandreas@sandberg.pp.seEXTRACT_ALL = NO 3599888Sandreas@sandberg.pp.se 3609888Sandreas@sandberg.pp.se# If the EXTRACT_PRIVATE tag is set to YES all private members of a class 3619888Sandreas@sandberg.pp.se# will be included in the documentation. 3629888Sandreas@sandberg.pp.se 3639888Sandreas@sandberg.pp.seEXTRACT_PRIVATE = NO 3649888Sandreas@sandberg.pp.se 3659888Sandreas@sandberg.pp.se# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal scope will be included in the documentation. 3669888Sandreas@sandberg.pp.se 3679888Sandreas@sandberg.pp.seEXTRACT_PACKAGE = NO 3689888Sandreas@sandberg.pp.se 3699888Sandreas@sandberg.pp.se# If the EXTRACT_STATIC tag is set to YES all static members of a file 3709888Sandreas@sandberg.pp.se# will be included in the documentation. 3719888Sandreas@sandberg.pp.se 3729888Sandreas@sandberg.pp.seEXTRACT_STATIC = NO 3739888Sandreas@sandberg.pp.se 3749888Sandreas@sandberg.pp.se# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 3759888Sandreas@sandberg.pp.se# defined locally in source files will be included in the documentation. 3769888Sandreas@sandberg.pp.se# If set to NO only classes defined in header files are included. 3779888Sandreas@sandberg.pp.se 3789888Sandreas@sandberg.pp.seEXTRACT_LOCAL_CLASSES = YES 3799888Sandreas@sandberg.pp.se 3809888Sandreas@sandberg.pp.se# This flag is only useful for Objective-C code. When set to YES local 3819888Sandreas@sandberg.pp.se# methods, which are defined in the implementation section but not in 3829888Sandreas@sandberg.pp.se# the interface are included in the documentation. 3839888Sandreas@sandberg.pp.se# If set to NO (the default) only methods in the interface are included. 3849888Sandreas@sandberg.pp.se 3859888Sandreas@sandberg.pp.seEXTRACT_LOCAL_METHODS = NO 3869888Sandreas@sandberg.pp.se 3879888Sandreas@sandberg.pp.se# If this flag is set to YES, the members of anonymous namespaces will be 3889888Sandreas@sandberg.pp.se# extracted and appear in the documentation as a namespace called 3899888Sandreas@sandberg.pp.se# 'anonymous_namespace{file}', where file will be replaced with the base 3909888Sandreas@sandberg.pp.se# name of the file that contains the anonymous namespace. By default 3919888Sandreas@sandberg.pp.se# anonymous namespaces are hidden. 3929888Sandreas@sandberg.pp.se 3939888Sandreas@sandberg.pp.seEXTRACT_ANON_NSPACES = NO 3949888Sandreas@sandberg.pp.se 3959888Sandreas@sandberg.pp.se# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 3969888Sandreas@sandberg.pp.se# undocumented members of documented classes, files or namespaces. 3979888Sandreas@sandberg.pp.se# If set to NO (the default) these members will be included in the 3989888Sandreas@sandberg.pp.se# various overviews, but no documentation section is generated. 3999888Sandreas@sandberg.pp.se# This option has no effect if EXTRACT_ALL is enabled. 4009888Sandreas@sandberg.pp.se 4019888Sandreas@sandberg.pp.seHIDE_UNDOC_MEMBERS = NO 4029888Sandreas@sandberg.pp.se 4039888Sandreas@sandberg.pp.se# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 4049888Sandreas@sandberg.pp.se# undocumented classes that are normally visible in the class hierarchy. 4059888Sandreas@sandberg.pp.se# If set to NO (the default) these classes will be included in the various 4069888Sandreas@sandberg.pp.se# overviews. This option has no effect if EXTRACT_ALL is enabled. 4079888Sandreas@sandberg.pp.se 4089888Sandreas@sandberg.pp.seHIDE_UNDOC_CLASSES = NO 4099888Sandreas@sandberg.pp.se 4109888Sandreas@sandberg.pp.se# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 4119888Sandreas@sandberg.pp.se# friend (class|struct|union) declarations. 4129888Sandreas@sandberg.pp.se# If set to NO (the default) these declarations will be included in the 4139888Sandreas@sandberg.pp.se# documentation. 4149888Sandreas@sandberg.pp.se 4159888Sandreas@sandberg.pp.seHIDE_FRIEND_COMPOUNDS = NO 4169888Sandreas@sandberg.pp.se 4179888Sandreas@sandberg.pp.se# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 4189888Sandreas@sandberg.pp.se# documentation blocks found inside the body of a function. 4199888Sandreas@sandberg.pp.se# If set to NO (the default) these blocks will be appended to the 4209888Sandreas@sandberg.pp.se# function's detailed documentation block. 4219888Sandreas@sandberg.pp.se 4229888Sandreas@sandberg.pp.seHIDE_IN_BODY_DOCS = NO 4239888Sandreas@sandberg.pp.se 4249888Sandreas@sandberg.pp.se# The INTERNAL_DOCS tag determines if documentation 4259888Sandreas@sandberg.pp.se# that is typed after a \internal command is included. If the tag is set 4269888Sandreas@sandberg.pp.se# to NO (the default) then the documentation will be excluded. 4279888Sandreas@sandberg.pp.se# Set it to YES to include the internal documentation. 4289888Sandreas@sandberg.pp.se 4299888Sandreas@sandberg.pp.seINTERNAL_DOCS = NO 4309888Sandreas@sandberg.pp.se 4319888Sandreas@sandberg.pp.se# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 4329888Sandreas@sandberg.pp.se# file names in lower-case letters. If set to YES upper-case letters are also 4339888Sandreas@sandberg.pp.se# allowed. This is useful if you have classes or files whose names only differ 4349888Sandreas@sandberg.pp.se# in case and if your file system supports case sensitive file names. Windows 4359888Sandreas@sandberg.pp.se# and Mac users are advised to set this option to NO. 4369888Sandreas@sandberg.pp.se 4379888Sandreas@sandberg.pp.seCASE_SENSE_NAMES = YES 4389888Sandreas@sandberg.pp.se 4399888Sandreas@sandberg.pp.se# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 4409888Sandreas@sandberg.pp.se# will show members with their full class and namespace scopes in the 4419888Sandreas@sandberg.pp.se# documentation. If set to YES the scope will be hidden. 4429888Sandreas@sandberg.pp.se 4439888Sandreas@sandberg.pp.seHIDE_SCOPE_NAMES = NO 4449888Sandreas@sandberg.pp.se 4459888Sandreas@sandberg.pp.se# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 4469888Sandreas@sandberg.pp.se# will put a list of the files that are included by a file in the documentation 4479888Sandreas@sandberg.pp.se# of that file. 4489888Sandreas@sandberg.pp.se 4499888Sandreas@sandberg.pp.seSHOW_INCLUDE_FILES = YES 4509888Sandreas@sandberg.pp.se 4519888Sandreas@sandberg.pp.se# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen 4529888Sandreas@sandberg.pp.se# will list include files with double quotes in the documentation 4539888Sandreas@sandberg.pp.se# rather than with sharp brackets. 4549888Sandreas@sandberg.pp.se 4559888Sandreas@sandberg.pp.seFORCE_LOCAL_INCLUDES = NO 4569888Sandreas@sandberg.pp.se 4579888Sandreas@sandberg.pp.se# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 4589888Sandreas@sandberg.pp.se# is inserted in the documentation for inline members. 4599888Sandreas@sandberg.pp.se 4609888Sandreas@sandberg.pp.seINLINE_INFO = YES 4619888Sandreas@sandberg.pp.se 4629888Sandreas@sandberg.pp.se# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 4639888Sandreas@sandberg.pp.se# will sort the (detailed) documentation of file and class members 4649888Sandreas@sandberg.pp.se# alphabetically by member name. If set to NO the members will appear in 4659888Sandreas@sandberg.pp.se# declaration order. 4669888Sandreas@sandberg.pp.se 4679888Sandreas@sandberg.pp.seSORT_MEMBER_DOCS = YES 4689888Sandreas@sandberg.pp.se 4699888Sandreas@sandberg.pp.se# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 4709888Sandreas@sandberg.pp.se# brief documentation of file, namespace and class members alphabetically 4719888Sandreas@sandberg.pp.se# by member name. If set to NO (the default) the members will appear in 4729888Sandreas@sandberg.pp.se# declaration order. 4739888Sandreas@sandberg.pp.se 4749888Sandreas@sandberg.pp.seSORT_BRIEF_DOCS = NO 4759888Sandreas@sandberg.pp.se 4769888Sandreas@sandberg.pp.se# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen 4779888Sandreas@sandberg.pp.se# will sort the (brief and detailed) documentation of class members so that 4789888Sandreas@sandberg.pp.se# constructors and destructors are listed first. If set to NO (the default) 4799888Sandreas@sandberg.pp.se# the constructors will appear in the respective orders defined by 4809888Sandreas@sandberg.pp.se# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. 4819888Sandreas@sandberg.pp.se# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO 4829888Sandreas@sandberg.pp.se# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. 4839888Sandreas@sandberg.pp.se 4849888Sandreas@sandberg.pp.seSORT_MEMBERS_CTORS_1ST = NO 4859888Sandreas@sandberg.pp.se 4869888Sandreas@sandberg.pp.se# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the 4879888Sandreas@sandberg.pp.se# hierarchy of group names into alphabetical order. If set to NO (the default) 4889888Sandreas@sandberg.pp.se# the group names will appear in their defined order. 4899888Sandreas@sandberg.pp.se 4909888Sandreas@sandberg.pp.seSORT_GROUP_NAMES = NO 4919888Sandreas@sandberg.pp.se 4929888Sandreas@sandberg.pp.se# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 4939888Sandreas@sandberg.pp.se# sorted by fully-qualified names, including namespaces. If set to 4949888Sandreas@sandberg.pp.se# NO (the default), the class list will be sorted only by class name, 4959888Sandreas@sandberg.pp.se# not including the namespace part. 4969888Sandreas@sandberg.pp.se# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 4979888Sandreas@sandberg.pp.se# Note: This option applies only to the class list, not to the 4989888Sandreas@sandberg.pp.se# alphabetical list. 4999888Sandreas@sandberg.pp.se 5009888Sandreas@sandberg.pp.seSORT_BY_SCOPE_NAME = NO 5019888Sandreas@sandberg.pp.se 5029888Sandreas@sandberg.pp.se# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to 5039888Sandreas@sandberg.pp.se# do proper type resolution of all parameters of a function it will reject a 5049888Sandreas@sandberg.pp.se# match between the prototype and the implementation of a member function even 5059888Sandreas@sandberg.pp.se# if there is only one candidate or it is obvious which candidate to choose 5069888Sandreas@sandberg.pp.se# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen 5079888Sandreas@sandberg.pp.se# will still accept a match between prototype and implementation in such cases. 5089888Sandreas@sandberg.pp.se 5099888Sandreas@sandberg.pp.seSTRICT_PROTO_MATCHING = NO 5109888Sandreas@sandberg.pp.se 5119888Sandreas@sandberg.pp.se# The GENERATE_TODOLIST tag can be used to enable (YES) or 5129888Sandreas@sandberg.pp.se# disable (NO) the todo list. This list is created by putting \todo 5139888Sandreas@sandberg.pp.se# commands in the documentation. 5149888Sandreas@sandberg.pp.se 5159888Sandreas@sandberg.pp.seGENERATE_TODOLIST = YES 5169888Sandreas@sandberg.pp.se 5179888Sandreas@sandberg.pp.se# The GENERATE_TESTLIST tag can be used to enable (YES) or 5189888Sandreas@sandberg.pp.se# disable (NO) the test list. This list is created by putting \test 5199888Sandreas@sandberg.pp.se# commands in the documentation. 5209888Sandreas@sandberg.pp.se 5219888Sandreas@sandberg.pp.seGENERATE_TESTLIST = YES 5229888Sandreas@sandberg.pp.se 5239888Sandreas@sandberg.pp.se# The GENERATE_BUGLIST tag can be used to enable (YES) or 5249888Sandreas@sandberg.pp.se# disable (NO) the bug list. This list is created by putting \bug 5259888Sandreas@sandberg.pp.se# commands in the documentation. 5269888Sandreas@sandberg.pp.se 5279888Sandreas@sandberg.pp.seGENERATE_BUGLIST = YES 5289888Sandreas@sandberg.pp.se 5299888Sandreas@sandberg.pp.se# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 5309888Sandreas@sandberg.pp.se# disable (NO) the deprecated list. This list is created by putting 5319888Sandreas@sandberg.pp.se# \deprecated commands in the documentation. 5329888Sandreas@sandberg.pp.se 5339888Sandreas@sandberg.pp.seGENERATE_DEPRECATEDLIST= YES 5349888Sandreas@sandberg.pp.se 5359888Sandreas@sandberg.pp.se# The ENABLED_SECTIONS tag can be used to enable conditional 5369888Sandreas@sandberg.pp.se# documentation sections, marked by \if sectionname ... \endif. 5379888Sandreas@sandberg.pp.se 5389888Sandreas@sandberg.pp.seENABLED_SECTIONS = 5399888Sandreas@sandberg.pp.se 5409888Sandreas@sandberg.pp.se# The MAX_INITIALIZER_LINES tag determines the maximum number of lines 5419888Sandreas@sandberg.pp.se# the initial value of a variable or macro consists of for it to appear in 5429888Sandreas@sandberg.pp.se# the documentation. If the initializer consists of more lines than specified 5439888Sandreas@sandberg.pp.se# here it will be hidden. Use a value of 0 to hide initializers completely. 5449888Sandreas@sandberg.pp.se# The appearance of the initializer of individual variables and macros in the 5459888Sandreas@sandberg.pp.se# documentation can be controlled using \showinitializer or \hideinitializer 5469888Sandreas@sandberg.pp.se# command in the documentation regardless of this setting. 5479888Sandreas@sandberg.pp.se 5489888Sandreas@sandberg.pp.seMAX_INITIALIZER_LINES = 30 5499888Sandreas@sandberg.pp.se 5509888Sandreas@sandberg.pp.se# Set the SHOW_USED_FILES tag to NO to disable the list of files generated 5519888Sandreas@sandberg.pp.se# at the bottom of the documentation of classes and structs. If set to YES the 5529888Sandreas@sandberg.pp.se# list will mention the files that were used to generate the documentation. 5539888Sandreas@sandberg.pp.se 5549888Sandreas@sandberg.pp.seSHOW_USED_FILES = YES 5559888Sandreas@sandberg.pp.se 5569888Sandreas@sandberg.pp.se# Set the SHOW_FILES tag to NO to disable the generation of the Files page. 5579888Sandreas@sandberg.pp.se# This will remove the Files entry from the Quick Index and from the 5589888Sandreas@sandberg.pp.se# Folder Tree View (if specified). The default is YES. 5599888Sandreas@sandberg.pp.se 5609888Sandreas@sandberg.pp.seSHOW_FILES = YES 5619888Sandreas@sandberg.pp.se 5629888Sandreas@sandberg.pp.se# Set the SHOW_NAMESPACES tag to NO to disable the generation of the 5639888Sandreas@sandberg.pp.se# Namespaces page. 5649888Sandreas@sandberg.pp.se# This will remove the Namespaces entry from the Quick Index 5659888Sandreas@sandberg.pp.se# and from the Folder Tree View (if specified). The default is YES. 5669888Sandreas@sandberg.pp.se 5679888Sandreas@sandberg.pp.seSHOW_NAMESPACES = YES 5689888Sandreas@sandberg.pp.se 5699888Sandreas@sandberg.pp.se# The FILE_VERSION_FILTER tag can be used to specify a program or script that 5709888Sandreas@sandberg.pp.se# doxygen should invoke to get the current version for each file (typically from 5719888Sandreas@sandberg.pp.se# the version control system). Doxygen will invoke the program by executing (via 5729888Sandreas@sandberg.pp.se# popen()) the command <command> <input-file>, where <command> is the value of 5739888Sandreas@sandberg.pp.se# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file 5749888Sandreas@sandberg.pp.se# provided by doxygen. Whatever the program writes to standard output 5759888Sandreas@sandberg.pp.se# is used as the file version. See the manual for examples. 5769888Sandreas@sandberg.pp.se 5779888Sandreas@sandberg.pp.seFILE_VERSION_FILTER = 5789888Sandreas@sandberg.pp.se 5799888Sandreas@sandberg.pp.se# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed 5809888Sandreas@sandberg.pp.se# by doxygen. The layout file controls the global structure of the generated 5819888Sandreas@sandberg.pp.se# output files in an output format independent way. To create the layout file 5829888Sandreas@sandberg.pp.se# that represents doxygen's defaults, run doxygen with the -l option. 5839888Sandreas@sandberg.pp.se# You can optionally specify a file name after the option, if omitted 5849888Sandreas@sandberg.pp.se# DoxygenLayout.xml will be used as the name of the layout file. 5859888Sandreas@sandberg.pp.se 5869888Sandreas@sandberg.pp.seLAYOUT_FILE = 5879888Sandreas@sandberg.pp.se 5889888Sandreas@sandberg.pp.se# The CITE_BIB_FILES tag can be used to specify one or more bib files 5899888Sandreas@sandberg.pp.se# containing the references data. This must be a list of .bib files. The 5909888Sandreas@sandberg.pp.se# .bib extension is automatically appended if omitted. Using this command 5919888Sandreas@sandberg.pp.se# requires the bibtex tool to be installed. See also 5929888Sandreas@sandberg.pp.se# http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style 5939888Sandreas@sandberg.pp.se# of the bibliography can be controlled using LATEX_BIB_STYLE. To use this 5949888Sandreas@sandberg.pp.se# feature you need bibtex and perl available in the search path. 5959888Sandreas@sandberg.pp.se 5969888Sandreas@sandberg.pp.seCITE_BIB_FILES = 5979888Sandreas@sandberg.pp.se 5989888Sandreas@sandberg.pp.se#--------------------------------------------------------------------------- 5999888Sandreas@sandberg.pp.se# configuration options related to warning and progress messages 6009888Sandreas@sandberg.pp.se#--------------------------------------------------------------------------- 6019888Sandreas@sandberg.pp.se 6029888Sandreas@sandberg.pp.se# The QUIET tag can be used to turn on/off the messages that are generated 6039888Sandreas@sandberg.pp.se# by doxygen. Possible values are YES and NO. If left blank NO is used. 6049888Sandreas@sandberg.pp.se 6059888Sandreas@sandberg.pp.seQUIET = NO 6069888Sandreas@sandberg.pp.se 6079888Sandreas@sandberg.pp.se# The WARNINGS tag can be used to turn on/off the warning messages that are 6089888Sandreas@sandberg.pp.se# generated by doxygen. Possible values are YES and NO. If left blank 6099888Sandreas@sandberg.pp.se# NO is used. 6109888Sandreas@sandberg.pp.se 6119888Sandreas@sandberg.pp.seWARNINGS = YES 6129888Sandreas@sandberg.pp.se 6139888Sandreas@sandberg.pp.se# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 6149888Sandreas@sandberg.pp.se# for undocumented members. If EXTRACT_ALL is set to YES then this flag will 6159888Sandreas@sandberg.pp.se# automatically be disabled. 6169888Sandreas@sandberg.pp.se 6179888Sandreas@sandberg.pp.seWARN_IF_UNDOCUMENTED = YES 6189888Sandreas@sandberg.pp.se 6199888Sandreas@sandberg.pp.se# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 6209888Sandreas@sandberg.pp.se# potential errors in the documentation, such as not documenting some 6219888Sandreas@sandberg.pp.se# parameters in a documented function, or documenting parameters that 6229888Sandreas@sandberg.pp.se# don't exist or using markup commands wrongly. 6239888Sandreas@sandberg.pp.se 6249888Sandreas@sandberg.pp.seWARN_IF_DOC_ERROR = YES 6259888Sandreas@sandberg.pp.se 6269888Sandreas@sandberg.pp.se# The WARN_NO_PARAMDOC option can be enabled to get warnings for 6279888Sandreas@sandberg.pp.se# functions that are documented, but have no documentation for their parameters 6289888Sandreas@sandberg.pp.se# or return value. If set to NO (the default) doxygen will only warn about 6299888Sandreas@sandberg.pp.se# wrong or incomplete parameter documentation, but not about the absence of 6309888Sandreas@sandberg.pp.se# documentation. 6319888Sandreas@sandberg.pp.se 6329888Sandreas@sandberg.pp.seWARN_NO_PARAMDOC = YES 6339888Sandreas@sandberg.pp.se 6349888Sandreas@sandberg.pp.se# The WARN_FORMAT tag determines the format of the warning messages that 6359888Sandreas@sandberg.pp.se# doxygen can produce. The string should contain the $file, $line, and $text 6369888Sandreas@sandberg.pp.se# tags, which will be replaced by the file and line number from which the 6379888Sandreas@sandberg.pp.se# warning originated and the warning text. Optionally the format may contain 6389888Sandreas@sandberg.pp.se# $version, which will be replaced by the version of the file (if it could 6399888Sandreas@sandberg.pp.se# be obtained via FILE_VERSION_FILTER) 6409888Sandreas@sandberg.pp.se 6419888Sandreas@sandberg.pp.seWARN_FORMAT = "$file:$line: $text" 6429888Sandreas@sandberg.pp.se 6439888Sandreas@sandberg.pp.se# The WARN_LOGFILE tag can be used to specify a file to which warning 6449888Sandreas@sandberg.pp.se# and error messages should be written. If left blank the output is written 6459888Sandreas@sandberg.pp.se# to stderr. 6469888Sandreas@sandberg.pp.se 6479888Sandreas@sandberg.pp.seWARN_LOGFILE = 6489888Sandreas@sandberg.pp.se 6499888Sandreas@sandberg.pp.se#--------------------------------------------------------------------------- 6509888Sandreas@sandberg.pp.se# configuration options related to the input files 6519888Sandreas@sandberg.pp.se#--------------------------------------------------------------------------- 6529888Sandreas@sandberg.pp.se 6539888Sandreas@sandberg.pp.se# The INPUT tag can be used to specify the files and/or directories that contain 6549888Sandreas@sandberg.pp.se# documented source files. You may enter file names like "myfile.cpp" or 6559888Sandreas@sandberg.pp.se# directories like "/usr/src/myproject". Separate the files or directories 6569888Sandreas@sandberg.pp.se# with spaces. 6579888Sandreas@sandberg.pp.se 6589888Sandreas@sandberg.pp.seINPUT = @top_srcdir@/ 6599888Sandreas@sandberg.pp.se 6609888Sandreas@sandberg.pp.se# This tag can be used to specify the character encoding of the source files 6619888Sandreas@sandberg.pp.se# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is 6629888Sandreas@sandberg.pp.se# also the default input encoding. Doxygen uses libiconv (or the iconv built 6639888Sandreas@sandberg.pp.se# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for 6649888Sandreas@sandberg.pp.se# the list of possible encodings. 6659888Sandreas@sandberg.pp.se 6669888Sandreas@sandberg.pp.seINPUT_ENCODING = UTF-8 6679888Sandreas@sandberg.pp.se 6689888Sandreas@sandberg.pp.se# If the value of the INPUT tag contains directories, you can use the 6699888Sandreas@sandberg.pp.se# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 6709888Sandreas@sandberg.pp.se# and *.h) to filter out the source-files in the directories. If left 6719888Sandreas@sandberg.pp.se# blank the following patterns are tested: 6729888Sandreas@sandberg.pp.se# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh 6739888Sandreas@sandberg.pp.se# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py 6749888Sandreas@sandberg.pp.se# *.f90 *.f *.for *.vhd *.vhdl 6759888Sandreas@sandberg.pp.se 6769888Sandreas@sandberg.pp.seFILE_PATTERNS = *.c *.h 6779888Sandreas@sandberg.pp.se 6789888Sandreas@sandberg.pp.se# The RECURSIVE tag can be used to turn specify whether or not subdirectories 6799888Sandreas@sandberg.pp.se# should be searched for input files as well. Possible values are YES and NO. 6809888Sandreas@sandberg.pp.se# If left blank NO is used. 6819888Sandreas@sandberg.pp.se 6829888Sandreas@sandberg.pp.seRECURSIVE = YES 6839888Sandreas@sandberg.pp.se 6849888Sandreas@sandberg.pp.se# The EXCLUDE tag can be used to specify files and/or directories that should be 6859888Sandreas@sandberg.pp.se# excluded from the INPUT source files. This way you can easily exclude a 6869888Sandreas@sandberg.pp.se# subdirectory from a directory tree whose root is specified with the INPUT tag. 6879888Sandreas@sandberg.pp.se# Note that relative paths are relative to the directory from which doxygen is 6889888Sandreas@sandberg.pp.se# run. 6899888Sandreas@sandberg.pp.se 6909888Sandreas@sandberg.pp.seEXCLUDE = config.h 6919888Sandreas@sandberg.pp.se 6929888Sandreas@sandberg.pp.se# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or 6939888Sandreas@sandberg.pp.se# directories that are symbolic links (a Unix file system feature) are excluded 6949888Sandreas@sandberg.pp.se# from the input. 6959888Sandreas@sandberg.pp.se 6969888Sandreas@sandberg.pp.seEXCLUDE_SYMLINKS = NO 6979888Sandreas@sandberg.pp.se 6989888Sandreas@sandberg.pp.se# If the value of the INPUT tag contains directories, you can use the 6999888Sandreas@sandberg.pp.se# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 7009888Sandreas@sandberg.pp.se# certain files from those directories. Note that the wildcards are matched 7019888Sandreas@sandberg.pp.se# against the file with absolute path, so to exclude all test directories 7029888Sandreas@sandberg.pp.se# for example use the pattern */test/* 7039888Sandreas@sandberg.pp.se 7049888Sandreas@sandberg.pp.seEXCLUDE_PATTERNS = 7059888Sandreas@sandberg.pp.se 7069888Sandreas@sandberg.pp.se# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 7079888Sandreas@sandberg.pp.se# (namespaces, classes, functions, etc.) that should be excluded from the 7089888Sandreas@sandberg.pp.se# output. The symbol name can be a fully qualified name, a word, or if the 7099888Sandreas@sandberg.pp.se# wildcard * is used, a substring. Examples: ANamespace, AClass, 7109888Sandreas@sandberg.pp.se# AClass::ANamespace, ANamespace::*Test 7119888Sandreas@sandberg.pp.se 7129888Sandreas@sandberg.pp.seEXCLUDE_SYMBOLS = 7139888Sandreas@sandberg.pp.se 7149888Sandreas@sandberg.pp.se# The EXAMPLE_PATH tag can be used to specify one or more files or 7159888Sandreas@sandberg.pp.se# directories that contain example code fragments that are included (see 7169888Sandreas@sandberg.pp.se# the \include command). 7179888Sandreas@sandberg.pp.se 7189888Sandreas@sandberg.pp.seEXAMPLE_PATH = 7199888Sandreas@sandberg.pp.se 7209888Sandreas@sandberg.pp.se# If the value of the EXAMPLE_PATH tag contains directories, you can use the 7219888Sandreas@sandberg.pp.se# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 7229888Sandreas@sandberg.pp.se# and *.h) to filter out the source-files in the directories. If left 7239888Sandreas@sandberg.pp.se# blank all files are included. 7249888Sandreas@sandberg.pp.se 7259888Sandreas@sandberg.pp.seEXAMPLE_PATTERNS = 7269888Sandreas@sandberg.pp.se 7279888Sandreas@sandberg.pp.se# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 7289888Sandreas@sandberg.pp.se# searched for input files to be used with the \include or \dontinclude 7299888Sandreas@sandberg.pp.se# commands irrespective of the value of the RECURSIVE tag. 7309888Sandreas@sandberg.pp.se# Possible values are YES and NO. If left blank NO is used. 7319888Sandreas@sandberg.pp.se 7329888Sandreas@sandberg.pp.seEXAMPLE_RECURSIVE = NO 7339888Sandreas@sandberg.pp.se 7349888Sandreas@sandberg.pp.se# The IMAGE_PATH tag can be used to specify one or more files or 7359888Sandreas@sandberg.pp.se# directories that contain image that are included in the documentation (see 7369888Sandreas@sandberg.pp.se# the \image command). 7379888Sandreas@sandberg.pp.se 7389888Sandreas@sandberg.pp.seIMAGE_PATH = 7399888Sandreas@sandberg.pp.se 7409888Sandreas@sandberg.pp.se# The INPUT_FILTER tag can be used to specify a program that doxygen should 7419888Sandreas@sandberg.pp.se# invoke to filter for each input file. Doxygen will invoke the filter program 7429888Sandreas@sandberg.pp.se# by executing (via popen()) the command <filter> <input-file>, where <filter> 7439888Sandreas@sandberg.pp.se# is the value of the INPUT_FILTER tag, and <input-file> is the name of an 7449888Sandreas@sandberg.pp.se# input file. Doxygen will then use the output that the filter program writes 7459888Sandreas@sandberg.pp.se# to standard output. 7469888Sandreas@sandberg.pp.se# If FILTER_PATTERNS is specified, this tag will be 7479888Sandreas@sandberg.pp.se# ignored. 7489888Sandreas@sandberg.pp.se 7499888Sandreas@sandberg.pp.seINPUT_FILTER = 7509888Sandreas@sandberg.pp.se 7519888Sandreas@sandberg.pp.se# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 7529888Sandreas@sandberg.pp.se# basis. 7539888Sandreas@sandberg.pp.se# Doxygen will compare the file name with each pattern and apply the 7549888Sandreas@sandberg.pp.se# filter if there is a match. 7559888Sandreas@sandberg.pp.se# The filters are a list of the form: 7569888Sandreas@sandberg.pp.se# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 7579888Sandreas@sandberg.pp.se# info on how filters are used. If FILTER_PATTERNS is empty or if 7589888Sandreas@sandberg.pp.se# non of the patterns match the file name, INPUT_FILTER is applied. 7599888Sandreas@sandberg.pp.se 7609888Sandreas@sandberg.pp.seFILTER_PATTERNS = 7619888Sandreas@sandberg.pp.se 7629888Sandreas@sandberg.pp.se# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 7639888Sandreas@sandberg.pp.se# INPUT_FILTER) will be used to filter the input files when producing source 7649888Sandreas@sandberg.pp.se# files to browse (i.e. when SOURCE_BROWSER is set to YES). 7659888Sandreas@sandberg.pp.se 7669888Sandreas@sandberg.pp.seFILTER_SOURCE_FILES = NO 7679888Sandreas@sandberg.pp.se 7689888Sandreas@sandberg.pp.se# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file 7699888Sandreas@sandberg.pp.se# pattern. A pattern will override the setting for FILTER_PATTERN (if any) 7709888Sandreas@sandberg.pp.se# and it is also possible to disable source filtering for a specific pattern 7719888Sandreas@sandberg.pp.se# using *.ext= (so without naming a filter). This option only has effect when 7729888Sandreas@sandberg.pp.se# FILTER_SOURCE_FILES is enabled. 7739888Sandreas@sandberg.pp.se 7749888Sandreas@sandberg.pp.seFILTER_SOURCE_PATTERNS = 7759888Sandreas@sandberg.pp.se 7769888Sandreas@sandberg.pp.se#--------------------------------------------------------------------------- 7779888Sandreas@sandberg.pp.se# configuration options related to source browsing 7789888Sandreas@sandberg.pp.se#--------------------------------------------------------------------------- 7799888Sandreas@sandberg.pp.se 7809888Sandreas@sandberg.pp.se# If the SOURCE_BROWSER tag is set to YES then a list of source files will 7819888Sandreas@sandberg.pp.se# be generated. Documented entities will be cross-referenced with these sources. 7829888Sandreas@sandberg.pp.se# Note: To get rid of all source code in the generated output, make sure also 7839888Sandreas@sandberg.pp.se# VERBATIM_HEADERS is set to NO. 7849888Sandreas@sandberg.pp.se 7859888Sandreas@sandberg.pp.seSOURCE_BROWSER = NO 7869888Sandreas@sandberg.pp.se 7879888Sandreas@sandberg.pp.se# Setting the INLINE_SOURCES tag to YES will include the body 7889888Sandreas@sandberg.pp.se# of functions and classes directly in the documentation. 7899888Sandreas@sandberg.pp.se 7909888Sandreas@sandberg.pp.seINLINE_SOURCES = NO 7919888Sandreas@sandberg.pp.se 7929888Sandreas@sandberg.pp.se# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 7939888Sandreas@sandberg.pp.se# doxygen to hide any special comment blocks from generated source code 7949888Sandreas@sandberg.pp.se# fragments. Normal C, C++ and Fortran comments will always remain visible. 7959888Sandreas@sandberg.pp.se 7969888Sandreas@sandberg.pp.seSTRIP_CODE_COMMENTS = NO 7979888Sandreas@sandberg.pp.se 7989888Sandreas@sandberg.pp.se# If the REFERENCED_BY_RELATION tag is set to YES 7999888Sandreas@sandberg.pp.se# then for each documented function all documented 8009888Sandreas@sandberg.pp.se# functions referencing it will be listed. 8019888Sandreas@sandberg.pp.se 8029888Sandreas@sandberg.pp.seREFERENCED_BY_RELATION = NO 8039888Sandreas@sandberg.pp.se 8049888Sandreas@sandberg.pp.se# If the REFERENCES_RELATION tag is set to YES 8059888Sandreas@sandberg.pp.se# then for each documented function all documented entities 8069888Sandreas@sandberg.pp.se# called/used by that function will be listed. 8079888Sandreas@sandberg.pp.se 8089888Sandreas@sandberg.pp.seREFERENCES_RELATION = NO 8099888Sandreas@sandberg.pp.se 8109888Sandreas@sandberg.pp.se# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) 8119888Sandreas@sandberg.pp.se# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from 8129888Sandreas@sandberg.pp.se# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will 8139888Sandreas@sandberg.pp.se# link to the source code. 8149888Sandreas@sandberg.pp.se# Otherwise they will link to the documentation. 8159888Sandreas@sandberg.pp.se 8169888Sandreas@sandberg.pp.seREFERENCES_LINK_SOURCE = YES 8179888Sandreas@sandberg.pp.se 8189888Sandreas@sandberg.pp.se# If the USE_HTAGS tag is set to YES then the references to source code 8199888Sandreas@sandberg.pp.se# will point to the HTML generated by the htags(1) tool instead of doxygen 8209888Sandreas@sandberg.pp.se# built-in source browser. The htags tool is part of GNU's global source 8219888Sandreas@sandberg.pp.se# tagging system (see http://www.gnu.org/software/global/global.html). You 8229888Sandreas@sandberg.pp.se# will need version 4.8.6 or higher. 8239888Sandreas@sandberg.pp.se 8249888Sandreas@sandberg.pp.seUSE_HTAGS = NO 8259888Sandreas@sandberg.pp.se 8269888Sandreas@sandberg.pp.se# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 8279888Sandreas@sandberg.pp.se# will generate a verbatim copy of the header file for each class for 8289888Sandreas@sandberg.pp.se# which an include is specified. Set to NO to disable this. 8299888Sandreas@sandberg.pp.se 8309888Sandreas@sandberg.pp.seVERBATIM_HEADERS = YES 8319888Sandreas@sandberg.pp.se 8329888Sandreas@sandberg.pp.se#--------------------------------------------------------------------------- 8339888Sandreas@sandberg.pp.se# configuration options related to the alphabetical class index 8349888Sandreas@sandberg.pp.se#--------------------------------------------------------------------------- 8359888Sandreas@sandberg.pp.se 8369888Sandreas@sandberg.pp.se# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 8379888Sandreas@sandberg.pp.se# of all compounds will be generated. Enable this if the project 8389888Sandreas@sandberg.pp.se# contains a lot of classes, structs, unions or interfaces. 8399888Sandreas@sandberg.pp.se 8409888Sandreas@sandberg.pp.seALPHABETICAL_INDEX = YES 8419888Sandreas@sandberg.pp.se 8429888Sandreas@sandberg.pp.se# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 8439888Sandreas@sandberg.pp.se# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 8449888Sandreas@sandberg.pp.se# in which this list will be split (can be a number in the range [1..20]) 8459888Sandreas@sandberg.pp.se 8469888Sandreas@sandberg.pp.seCOLS_IN_ALPHA_INDEX = 5 8479888Sandreas@sandberg.pp.se 8489888Sandreas@sandberg.pp.se# In case all classes in a project start with a common prefix, all 8499888Sandreas@sandberg.pp.se# classes will be put under the same header in the alphabetical index. 8509888Sandreas@sandberg.pp.se# The IGNORE_PREFIX tag can be used to specify one or more prefixes that 8519888Sandreas@sandberg.pp.se# should be ignored while generating the index headers. 8529888Sandreas@sandberg.pp.se 8539888Sandreas@sandberg.pp.seIGNORE_PREFIX = 8549888Sandreas@sandberg.pp.se 8559888Sandreas@sandberg.pp.se#--------------------------------------------------------------------------- 8569888Sandreas@sandberg.pp.se# configuration options related to the HTML output 8579888Sandreas@sandberg.pp.se#--------------------------------------------------------------------------- 8589888Sandreas@sandberg.pp.se 8599888Sandreas@sandberg.pp.se# If the GENERATE_HTML tag is set to YES (the default) Doxygen will 8609888Sandreas@sandberg.pp.se# generate HTML output. 8619888Sandreas@sandberg.pp.se 8629888Sandreas@sandberg.pp.seGENERATE_HTML = YES 8639888Sandreas@sandberg.pp.se 8649888Sandreas@sandberg.pp.se# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 8659888Sandreas@sandberg.pp.se# If a relative path is entered the value of OUTPUT_DIRECTORY will be 8669888Sandreas@sandberg.pp.se# put in front of it. If left blank `html' will be used as the default path. 8679888Sandreas@sandberg.pp.se 8689888Sandreas@sandberg.pp.seHTML_OUTPUT = html 8699888Sandreas@sandberg.pp.se 8709888Sandreas@sandberg.pp.se# The HTML_FILE_EXTENSION tag can be used to specify the file extension for 8719888Sandreas@sandberg.pp.se# each generated HTML page (for example: .htm,.php,.asp). If it is left blank 8729888Sandreas@sandberg.pp.se# doxygen will generate files with .html extension. 8739888Sandreas@sandberg.pp.se 8749888Sandreas@sandberg.pp.seHTML_FILE_EXTENSION = .html 8759888Sandreas@sandberg.pp.se 8769888Sandreas@sandberg.pp.se# The HTML_HEADER tag can be used to specify a personal HTML header for 8779888Sandreas@sandberg.pp.se# each generated HTML page. If it is left blank doxygen will generate a 8789888Sandreas@sandberg.pp.se# standard header. Note that when using a custom header you are responsible 8799888Sandreas@sandberg.pp.se# for the proper inclusion of any scripts and style sheets that doxygen 8809888Sandreas@sandberg.pp.se# needs, which is dependent on the configuration options used. 8819888Sandreas@sandberg.pp.se# It is advised to generate a default header using "doxygen -w html 8829888Sandreas@sandberg.pp.se# header.html footer.html stylesheet.css YourConfigFile" and then modify 8839888Sandreas@sandberg.pp.se# that header. Note that the header is subject to change so you typically 8849888Sandreas@sandberg.pp.se# have to redo this when upgrading to a newer version of doxygen or when 8859888Sandreas@sandberg.pp.se# changing the value of configuration settings such as GENERATE_TREEVIEW! 8869888Sandreas@sandberg.pp.se 8879888Sandreas@sandberg.pp.seHTML_HEADER = 8889888Sandreas@sandberg.pp.se 8899888Sandreas@sandberg.pp.se# The HTML_FOOTER tag can be used to specify a personal HTML footer for 8909888Sandreas@sandberg.pp.se# each generated HTML page. If it is left blank doxygen will generate a 8919888Sandreas@sandberg.pp.se# standard footer. 8929888Sandreas@sandberg.pp.se 8939888Sandreas@sandberg.pp.seHTML_FOOTER = 8949888Sandreas@sandberg.pp.se 8959888Sandreas@sandberg.pp.se# The HTML_STYLESHEET tag can be used to specify a user-defined cascading 8969888Sandreas@sandberg.pp.se# style sheet that is used by each HTML page. It can be used to 8979888Sandreas@sandberg.pp.se# fine-tune the look of the HTML output. If the tag is left blank doxygen 8989888Sandreas@sandberg.pp.se# will generate a default style sheet. Note that doxygen will try to copy 8999888Sandreas@sandberg.pp.se# the style sheet file to the HTML output directory, so don't put your own 9009888Sandreas@sandberg.pp.se# style sheet in the HTML output directory as well, or it will be erased! 9019888Sandreas@sandberg.pp.se 9029888Sandreas@sandberg.pp.seHTML_STYLESHEET = 9039888Sandreas@sandberg.pp.se 9049888Sandreas@sandberg.pp.se# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or 9059888Sandreas@sandberg.pp.se# other source files which should be copied to the HTML output directory. Note 9069888Sandreas@sandberg.pp.se# that these files will be copied to the base HTML output directory. Use the 9079888Sandreas@sandberg.pp.se# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these 9089888Sandreas@sandberg.pp.se# files. In the HTML_STYLESHEET file, use the file name only. Also note that 9099888Sandreas@sandberg.pp.se# the files will be copied as-is; there are no commands or markers available. 9109888Sandreas@sandberg.pp.se 9119888Sandreas@sandberg.pp.seHTML_EXTRA_FILES = 9129888Sandreas@sandberg.pp.se 9139888Sandreas@sandberg.pp.se# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. 9149888Sandreas@sandberg.pp.se# Doxygen will adjust the colors in the style sheet and background images 9159888Sandreas@sandberg.pp.se# according to this color. Hue is specified as an angle on a colorwheel, 9169888Sandreas@sandberg.pp.se# see http://en.wikipedia.org/wiki/Hue for more information. 9179888Sandreas@sandberg.pp.se# For instance the value 0 represents red, 60 is yellow, 120 is green, 9189888Sandreas@sandberg.pp.se# 180 is cyan, 240 is blue, 300 purple, and 360 is red again. 9199888Sandreas@sandberg.pp.se# The allowed range is 0 to 359. 9209888Sandreas@sandberg.pp.se 9219888Sandreas@sandberg.pp.seHTML_COLORSTYLE_HUE = 220 9229888Sandreas@sandberg.pp.se 9239888Sandreas@sandberg.pp.se# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of 9249888Sandreas@sandberg.pp.se# the colors in the HTML output. For a value of 0 the output will use 9259888Sandreas@sandberg.pp.se# grayscales only. A value of 255 will produce the most vivid colors. 9269888Sandreas@sandberg.pp.se 9279888Sandreas@sandberg.pp.seHTML_COLORSTYLE_SAT = 100 9289888Sandreas@sandberg.pp.se 9299888Sandreas@sandberg.pp.se# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to 9309888Sandreas@sandberg.pp.se# the luminance component of the colors in the HTML output. Values below 9319888Sandreas@sandberg.pp.se# 100 gradually make the output lighter, whereas values above 100 make 9329888Sandreas@sandberg.pp.se# the output darker. The value divided by 100 is the actual gamma applied, 9339888Sandreas@sandberg.pp.se# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, 9349888Sandreas@sandberg.pp.se# and 100 does not change the gamma. 9359888Sandreas@sandberg.pp.se 9369888Sandreas@sandberg.pp.seHTML_COLORSTYLE_GAMMA = 80 9379888Sandreas@sandberg.pp.se 9389888Sandreas@sandberg.pp.se# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML 9399888Sandreas@sandberg.pp.se# page will contain the date and time when the page was generated. Setting 9409888Sandreas@sandberg.pp.se# this to NO can help when comparing the output of multiple runs. 9419888Sandreas@sandberg.pp.se 9429888Sandreas@sandberg.pp.seHTML_TIMESTAMP = YES 9439888Sandreas@sandberg.pp.se 9449888Sandreas@sandberg.pp.se# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 9459888Sandreas@sandberg.pp.se# documentation will contain sections that can be hidden and shown after the 9469888Sandreas@sandberg.pp.se# page has loaded. 9479888Sandreas@sandberg.pp.se 9489888Sandreas@sandberg.pp.seHTML_DYNAMIC_SECTIONS = NO 9499888Sandreas@sandberg.pp.se 9509888Sandreas@sandberg.pp.se# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of 9519888Sandreas@sandberg.pp.se# entries shown in the various tree structured indices initially; the user 9529888Sandreas@sandberg.pp.se# can expand and collapse entries dynamically later on. Doxygen will expand 9539888Sandreas@sandberg.pp.se# the tree to such a level that at most the specified number of entries are 9549888Sandreas@sandberg.pp.se# visible (unless a fully collapsed tree already exceeds this amount). 9559888Sandreas@sandberg.pp.se# So setting the number of entries 1 will produce a full collapsed tree by 9569888Sandreas@sandberg.pp.se# default. 0 is a special value representing an infinite number of entries 9579888Sandreas@sandberg.pp.se# and will result in a full expanded tree by default. 9589888Sandreas@sandberg.pp.se 9599888Sandreas@sandberg.pp.seHTML_INDEX_NUM_ENTRIES = 100 9609888Sandreas@sandberg.pp.se 9619888Sandreas@sandberg.pp.se# If the GENERATE_DOCSET tag is set to YES, additional index files 9629888Sandreas@sandberg.pp.se# will be generated that can be used as input for Apple's Xcode 3 9639888Sandreas@sandberg.pp.se# integrated development environment, introduced with OSX 10.5 (Leopard). 9649888Sandreas@sandberg.pp.se# To create a documentation set, doxygen will generate a Makefile in the 9659888Sandreas@sandberg.pp.se# HTML output directory. Running make will produce the docset in that 9669888Sandreas@sandberg.pp.se# directory and running "make install" will install the docset in 9679888Sandreas@sandberg.pp.se# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find 9689888Sandreas@sandberg.pp.se# it at startup. 9699888Sandreas@sandberg.pp.se# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html 9709888Sandreas@sandberg.pp.se# for more information. 9719888Sandreas@sandberg.pp.se 9729888Sandreas@sandberg.pp.seGENERATE_DOCSET = NO 9739888Sandreas@sandberg.pp.se 9749888Sandreas@sandberg.pp.se# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the 9759888Sandreas@sandberg.pp.se# feed. A documentation feed provides an umbrella under which multiple 9769888Sandreas@sandberg.pp.se# documentation sets from a single provider (such as a company or product suite) 9779888Sandreas@sandberg.pp.se# can be grouped. 9789888Sandreas@sandberg.pp.se 9799888Sandreas@sandberg.pp.seDOCSET_FEEDNAME = "Doxygen generated docs" 9809888Sandreas@sandberg.pp.se 9819888Sandreas@sandberg.pp.se# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that 9829888Sandreas@sandberg.pp.se# should uniquely identify the documentation set bundle. This should be a 9839888Sandreas@sandberg.pp.se# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen 9849888Sandreas@sandberg.pp.se# will append .docset to the name. 9859888Sandreas@sandberg.pp.se 9869888Sandreas@sandberg.pp.seDOCSET_BUNDLE_ID = org.doxygen.Project 9879888Sandreas@sandberg.pp.se 9889888Sandreas@sandberg.pp.se# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify 9899888Sandreas@sandberg.pp.se# the documentation publisher. This should be a reverse domain-name style 9909888Sandreas@sandberg.pp.se# string, e.g. com.mycompany.MyDocSet.documentation. 9919888Sandreas@sandberg.pp.se 9929888Sandreas@sandberg.pp.seDOCSET_PUBLISHER_ID = org.doxygen.Publisher 9939888Sandreas@sandberg.pp.se 9949888Sandreas@sandberg.pp.se# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. 9959888Sandreas@sandberg.pp.se 9969888Sandreas@sandberg.pp.seDOCSET_PUBLISHER_NAME = Publisher 9979888Sandreas@sandberg.pp.se 9989888Sandreas@sandberg.pp.se# If the GENERATE_HTMLHELP tag is set to YES, additional index files 9999888Sandreas@sandberg.pp.se# will be generated that can be used as input for tools like the 10009888Sandreas@sandberg.pp.se# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) 10019888Sandreas@sandberg.pp.se# of the generated HTML documentation. 10029888Sandreas@sandberg.pp.se 10039888Sandreas@sandberg.pp.seGENERATE_HTMLHELP = NO 10049888Sandreas@sandberg.pp.se 10059888Sandreas@sandberg.pp.se# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 10069888Sandreas@sandberg.pp.se# be used to specify the file name of the resulting .chm file. You 10079888Sandreas@sandberg.pp.se# can add a path in front of the file if the result should not be 10089888Sandreas@sandberg.pp.se# written to the html output directory. 10099888Sandreas@sandberg.pp.se 10109888Sandreas@sandberg.pp.seCHM_FILE = 10119888Sandreas@sandberg.pp.se 10129888Sandreas@sandberg.pp.se# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 10139888Sandreas@sandberg.pp.se# be used to specify the location (absolute path including file name) of 10149888Sandreas@sandberg.pp.se# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 10159888Sandreas@sandberg.pp.se# the HTML help compiler on the generated index.hhp. 10169888Sandreas@sandberg.pp.se 10179888Sandreas@sandberg.pp.seHHC_LOCATION = 10189888Sandreas@sandberg.pp.se 10199888Sandreas@sandberg.pp.se# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 10209888Sandreas@sandberg.pp.se# controls if a separate .chi index file is generated (YES) or that 10219888Sandreas@sandberg.pp.se# it should be included in the master .chm file (NO). 10229888Sandreas@sandberg.pp.se 10239888Sandreas@sandberg.pp.seGENERATE_CHI = NO 10249888Sandreas@sandberg.pp.se 10259888Sandreas@sandberg.pp.se# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING 10269888Sandreas@sandberg.pp.se# is used to encode HtmlHelp index (hhk), content (hhc) and project file 10279888Sandreas@sandberg.pp.se# content. 10289888Sandreas@sandberg.pp.se 10299888Sandreas@sandberg.pp.seCHM_INDEX_ENCODING = 10309888Sandreas@sandberg.pp.se 10319888Sandreas@sandberg.pp.se# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 10329888Sandreas@sandberg.pp.se# controls whether a binary table of contents is generated (YES) or a 10339888Sandreas@sandberg.pp.se# normal table of contents (NO) in the .chm file. 10349888Sandreas@sandberg.pp.se 10359888Sandreas@sandberg.pp.seBINARY_TOC = NO 10369888Sandreas@sandberg.pp.se 10379888Sandreas@sandberg.pp.se# The TOC_EXPAND flag can be set to YES to add extra items for group members 10389888Sandreas@sandberg.pp.se# to the contents of the HTML help documentation and to the tree view. 10399888Sandreas@sandberg.pp.se 10409888Sandreas@sandberg.pp.seTOC_EXPAND = NO 10419888Sandreas@sandberg.pp.se 10429888Sandreas@sandberg.pp.se# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and 10439888Sandreas@sandberg.pp.se# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated 10449888Sandreas@sandberg.pp.se# that can be used as input for Qt's qhelpgenerator to generate a 10459888Sandreas@sandberg.pp.se# Qt Compressed Help (.qch) of the generated HTML documentation. 10469888Sandreas@sandberg.pp.se 10479888Sandreas@sandberg.pp.seGENERATE_QHP = NO 10489888Sandreas@sandberg.pp.se 10499888Sandreas@sandberg.pp.se# If the QHG_LOCATION tag is specified, the QCH_FILE tag can 10509888Sandreas@sandberg.pp.se# be used to specify the file name of the resulting .qch file. 10519888Sandreas@sandberg.pp.se# The path specified is relative to the HTML output folder. 10529888Sandreas@sandberg.pp.se 10539888Sandreas@sandberg.pp.seQCH_FILE = 10549888Sandreas@sandberg.pp.se 10559888Sandreas@sandberg.pp.se# The QHP_NAMESPACE tag specifies the namespace to use when generating 10569888Sandreas@sandberg.pp.se# Qt Help Project output. For more information please see 10579888Sandreas@sandberg.pp.se# http://doc.trolltech.com/qthelpproject.html#namespace 10589888Sandreas@sandberg.pp.se 10599888Sandreas@sandberg.pp.seQHP_NAMESPACE = org.doxygen.Project 10609888Sandreas@sandberg.pp.se 10619888Sandreas@sandberg.pp.se# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating 10629888Sandreas@sandberg.pp.se# Qt Help Project output. For more information please see 10639888Sandreas@sandberg.pp.se# http://doc.trolltech.com/qthelpproject.html#virtual-folders 10649888Sandreas@sandberg.pp.se 10659888Sandreas@sandberg.pp.seQHP_VIRTUAL_FOLDER = doc 10669888Sandreas@sandberg.pp.se 10679888Sandreas@sandberg.pp.se# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to 10689888Sandreas@sandberg.pp.se# add. For more information please see 10699888Sandreas@sandberg.pp.se# http://doc.trolltech.com/qthelpproject.html#custom-filters 10709888Sandreas@sandberg.pp.se 10719888Sandreas@sandberg.pp.seQHP_CUST_FILTER_NAME = 10729888Sandreas@sandberg.pp.se 10739888Sandreas@sandberg.pp.se# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the 10749888Sandreas@sandberg.pp.se# custom filter to add. For more information please see 10759888Sandreas@sandberg.pp.se# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters"> 10769888Sandreas@sandberg.pp.se# Qt Help Project / Custom Filters</a>. 10779888Sandreas@sandberg.pp.se 10789888Sandreas@sandberg.pp.seQHP_CUST_FILTER_ATTRS = 10799888Sandreas@sandberg.pp.se 10809888Sandreas@sandberg.pp.se# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this 10819888Sandreas@sandberg.pp.se# project's 10829888Sandreas@sandberg.pp.se# filter section matches. 10839888Sandreas@sandberg.pp.se# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes"> 10849888Sandreas@sandberg.pp.se# Qt Help Project / Filter Attributes</a>. 10859888Sandreas@sandberg.pp.se 10869888Sandreas@sandberg.pp.seQHP_SECT_FILTER_ATTRS = 10879888Sandreas@sandberg.pp.se 10889888Sandreas@sandberg.pp.se# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can 10899888Sandreas@sandberg.pp.se# be used to specify the location of Qt's qhelpgenerator. 10909888Sandreas@sandberg.pp.se# If non-empty doxygen will try to run qhelpgenerator on the generated 10919888Sandreas@sandberg.pp.se# .qhp file. 10929888Sandreas@sandberg.pp.se 10939888Sandreas@sandberg.pp.seQHG_LOCATION = 10949888Sandreas@sandberg.pp.se 10959888Sandreas@sandberg.pp.se# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files 10969888Sandreas@sandberg.pp.se# will be generated, which together with the HTML files, form an Eclipse help 10979888Sandreas@sandberg.pp.se# plugin. To install this plugin and make it available under the help contents 10989888Sandreas@sandberg.pp.se# menu in Eclipse, the contents of the directory containing the HTML and XML 10999888Sandreas@sandberg.pp.se# files needs to be copied into the plugins directory of eclipse. The name of 11009888Sandreas@sandberg.pp.se# the directory within the plugins directory should be the same as 11019888Sandreas@sandberg.pp.se# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before 11029888Sandreas@sandberg.pp.se# the help appears. 11039888Sandreas@sandberg.pp.se 11049888Sandreas@sandberg.pp.seGENERATE_ECLIPSEHELP = NO 11059888Sandreas@sandberg.pp.se 11069888Sandreas@sandberg.pp.se# A unique identifier for the eclipse help plugin. When installing the plugin 11079888Sandreas@sandberg.pp.se# the directory name containing the HTML and XML files should also have 11089888Sandreas@sandberg.pp.se# this name. 11099888Sandreas@sandberg.pp.se 11109888Sandreas@sandberg.pp.seECLIPSE_DOC_ID = org.doxygen.Project 11119888Sandreas@sandberg.pp.se 11129888Sandreas@sandberg.pp.se# The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) 11139888Sandreas@sandberg.pp.se# at top of each HTML page. The value NO (the default) enables the index and 11149888Sandreas@sandberg.pp.se# the value YES disables it. Since the tabs have the same information as the 11159888Sandreas@sandberg.pp.se# navigation tree you can set this option to NO if you already set 11169888Sandreas@sandberg.pp.se# GENERATE_TREEVIEW to YES. 11179888Sandreas@sandberg.pp.se 11189888Sandreas@sandberg.pp.seDISABLE_INDEX = NO 11199888Sandreas@sandberg.pp.se 11209888Sandreas@sandberg.pp.se# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 11219888Sandreas@sandberg.pp.se# structure should be generated to display hierarchical information. 11229888Sandreas@sandberg.pp.se# If the tag value is set to YES, a side panel will be generated 11239888Sandreas@sandberg.pp.se# containing a tree-like index structure (just like the one that 11249888Sandreas@sandberg.pp.se# is generated for HTML Help). For this to work a browser that supports 11259888Sandreas@sandberg.pp.se# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). 11269888Sandreas@sandberg.pp.se# Windows users are probably better off using the HTML help feature. 11279888Sandreas@sandberg.pp.se# Since the tree basically has the same information as the tab index you 11289888Sandreas@sandberg.pp.se# could consider to set DISABLE_INDEX to NO when enabling this option. 11299888Sandreas@sandberg.pp.se 11309888Sandreas@sandberg.pp.seGENERATE_TREEVIEW = NO 11319888Sandreas@sandberg.pp.se 11329888Sandreas@sandberg.pp.se# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values 11339888Sandreas@sandberg.pp.se# (range [0,1..20]) that doxygen will group on one line in the generated HTML 11349888Sandreas@sandberg.pp.se# documentation. Note that a value of 0 will completely suppress the enum 11359888Sandreas@sandberg.pp.se# values from appearing in the overview section. 11369888Sandreas@sandberg.pp.se 11379888Sandreas@sandberg.pp.seENUM_VALUES_PER_LINE = 4 11389888Sandreas@sandberg.pp.se 11399888Sandreas@sandberg.pp.se# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 11409888Sandreas@sandberg.pp.se# used to set the initial width (in pixels) of the frame in which the tree 11419888Sandreas@sandberg.pp.se# is shown. 11429888Sandreas@sandberg.pp.se 11439888Sandreas@sandberg.pp.seTREEVIEW_WIDTH = 250 11449888Sandreas@sandberg.pp.se 11459888Sandreas@sandberg.pp.se# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open 11469888Sandreas@sandberg.pp.se# links to external symbols imported via tag files in a separate window. 11479888Sandreas@sandberg.pp.se 11489888Sandreas@sandberg.pp.seEXT_LINKS_IN_WINDOW = NO 11499888Sandreas@sandberg.pp.se 11509888Sandreas@sandberg.pp.se# Use this tag to change the font size of Latex formulas included 11519888Sandreas@sandberg.pp.se# as images in the HTML documentation. The default is 10. Note that 11529888Sandreas@sandberg.pp.se# when you change the font size after a successful doxygen run you need 11539888Sandreas@sandberg.pp.se# to manually remove any form_*.png images from the HTML output directory 11549888Sandreas@sandberg.pp.se# to force them to be regenerated. 11559888Sandreas@sandberg.pp.se 11569888Sandreas@sandberg.pp.seFORMULA_FONTSIZE = 10 11579888Sandreas@sandberg.pp.se 11589888Sandreas@sandberg.pp.se# Use the FORMULA_TRANPARENT tag to determine whether or not the images 11599888Sandreas@sandberg.pp.se# generated for formulas are transparent PNGs. Transparent PNGs are 11609888Sandreas@sandberg.pp.se# not supported properly for IE 6.0, but are supported on all modern browsers. 11619888Sandreas@sandberg.pp.se# Note that when changing this option you need to delete any form_*.png files 11629888Sandreas@sandberg.pp.se# in the HTML output before the changes have effect. 11639888Sandreas@sandberg.pp.se 11649888Sandreas@sandberg.pp.seFORMULA_TRANSPARENT = YES 11659888Sandreas@sandberg.pp.se 11669888Sandreas@sandberg.pp.se# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax 11679888Sandreas@sandberg.pp.se# (see http://www.mathjax.org) which uses client side Javascript for the 11689888Sandreas@sandberg.pp.se# rendering instead of using prerendered bitmaps. Use this if you do not 11699888Sandreas@sandberg.pp.se# have LaTeX installed or if you want to formulas look prettier in the HTML 11709888Sandreas@sandberg.pp.se# output. When enabled you may also need to install MathJax separately and 11719888Sandreas@sandberg.pp.se# configure the path to it using the MATHJAX_RELPATH option. 11729888Sandreas@sandberg.pp.se 11739888Sandreas@sandberg.pp.seUSE_MATHJAX = NO 11749888Sandreas@sandberg.pp.se 11759888Sandreas@sandberg.pp.se# When MathJax is enabled you need to specify the location relative to the 11769888Sandreas@sandberg.pp.se# HTML output directory using the MATHJAX_RELPATH option. The destination 11779888Sandreas@sandberg.pp.se# directory should contain the MathJax.js script. For instance, if the mathjax 11789888Sandreas@sandberg.pp.se# directory is located at the same level as the HTML output directory, then 11799888Sandreas@sandberg.pp.se# MATHJAX_RELPATH should be ../mathjax. The default value points to 11809888Sandreas@sandberg.pp.se# the MathJax Content Delivery Network so you can quickly see the result without 11819888Sandreas@sandberg.pp.se# installing MathJax. 11829888Sandreas@sandberg.pp.se# However, it is strongly recommended to install a local 11839888Sandreas@sandberg.pp.se# copy of MathJax from http://www.mathjax.org before deployment. 11849888Sandreas@sandberg.pp.se 11859888Sandreas@sandberg.pp.seMATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest 11869888Sandreas@sandberg.pp.se 11879888Sandreas@sandberg.pp.se# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension 11889888Sandreas@sandberg.pp.se# names that should be enabled during MathJax rendering. 11899888Sandreas@sandberg.pp.se 11909888Sandreas@sandberg.pp.seMATHJAX_EXTENSIONS = 11919888Sandreas@sandberg.pp.se 11929888Sandreas@sandberg.pp.se# When the SEARCHENGINE tag is enabled doxygen will generate a search box 11939888Sandreas@sandberg.pp.se# for the HTML output. The underlying search engine uses javascript 11949888Sandreas@sandberg.pp.se# and DHTML and should work on any modern browser. Note that when using 11959888Sandreas@sandberg.pp.se# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets 11969888Sandreas@sandberg.pp.se# (GENERATE_DOCSET) there is already a search function so this one should 11979888Sandreas@sandberg.pp.se# typically be disabled. For large projects the javascript based search engine 11989888Sandreas@sandberg.pp.se# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. 11999888Sandreas@sandberg.pp.se 12009888Sandreas@sandberg.pp.seSEARCHENGINE = YES 12019888Sandreas@sandberg.pp.se 12029888Sandreas@sandberg.pp.se# When the SERVER_BASED_SEARCH tag is enabled the search engine will be 12039888Sandreas@sandberg.pp.se# implemented using a PHP enabled web server instead of at the web client 12049888Sandreas@sandberg.pp.se# using Javascript. Doxygen will generate the search PHP script and index 12059888Sandreas@sandberg.pp.se# file to put on the web server. The advantage of the server 12069888Sandreas@sandberg.pp.se# based approach is that it scales better to large projects and allows 12079888Sandreas@sandberg.pp.se# full text search. The disadvantages are that it is more difficult to setup 12089888Sandreas@sandberg.pp.se# and does not have live searching capabilities. 12099888Sandreas@sandberg.pp.se 12109888Sandreas@sandberg.pp.seSERVER_BASED_SEARCH = NO 12119888Sandreas@sandberg.pp.se 12129888Sandreas@sandberg.pp.se#--------------------------------------------------------------------------- 12139888Sandreas@sandberg.pp.se# configuration options related to the LaTeX output 12149888Sandreas@sandberg.pp.se#--------------------------------------------------------------------------- 12159888Sandreas@sandberg.pp.se 12169888Sandreas@sandberg.pp.se# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 12179888Sandreas@sandberg.pp.se# generate Latex output. 12189888Sandreas@sandberg.pp.se 12199888Sandreas@sandberg.pp.seGENERATE_LATEX = NO 12209888Sandreas@sandberg.pp.se 12219888Sandreas@sandberg.pp.se# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 12229888Sandreas@sandberg.pp.se# If a relative path is entered the value of OUTPUT_DIRECTORY will be 12239888Sandreas@sandberg.pp.se# put in front of it. If left blank `latex' will be used as the default path. 12249888Sandreas@sandberg.pp.se 12259888Sandreas@sandberg.pp.seLATEX_OUTPUT = latex 12269888Sandreas@sandberg.pp.se 12279888Sandreas@sandberg.pp.se# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 12289888Sandreas@sandberg.pp.se# invoked. If left blank `latex' will be used as the default command name. 12299888Sandreas@sandberg.pp.se# Note that when enabling USE_PDFLATEX this option is only used for 12309888Sandreas@sandberg.pp.se# generating bitmaps for formulas in the HTML output, but not in the 12319888Sandreas@sandberg.pp.se# Makefile that is written to the output directory. 12329888Sandreas@sandberg.pp.se 12339888Sandreas@sandberg.pp.seLATEX_CMD_NAME = latex 12349888Sandreas@sandberg.pp.se 12359888Sandreas@sandberg.pp.se# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 12369888Sandreas@sandberg.pp.se# generate index for LaTeX. If left blank `makeindex' will be used as the 12379888Sandreas@sandberg.pp.se# default command name. 12389888Sandreas@sandberg.pp.se 12399888Sandreas@sandberg.pp.seMAKEINDEX_CMD_NAME = makeindex 12409888Sandreas@sandberg.pp.se 12419888Sandreas@sandberg.pp.se# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 12429888Sandreas@sandberg.pp.se# LaTeX documents. This may be useful for small projects and may help to 12439888Sandreas@sandberg.pp.se# save some trees in general. 12449888Sandreas@sandberg.pp.se 12459888Sandreas@sandberg.pp.seCOMPACT_LATEX = NO 12469888Sandreas@sandberg.pp.se 12479888Sandreas@sandberg.pp.se# The PAPER_TYPE tag can be used to set the paper type that is used 12489888Sandreas@sandberg.pp.se# by the printer. Possible values are: a4, letter, legal and 12499888Sandreas@sandberg.pp.se# executive. If left blank a4wide will be used. 12509888Sandreas@sandberg.pp.se 12519888Sandreas@sandberg.pp.sePAPER_TYPE = a4 12529888Sandreas@sandberg.pp.se 12539888Sandreas@sandberg.pp.se# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 12549888Sandreas@sandberg.pp.se# packages that should be included in the LaTeX output. 12559888Sandreas@sandberg.pp.se 12569888Sandreas@sandberg.pp.seEXTRA_PACKAGES = 12579888Sandreas@sandberg.pp.se 12589888Sandreas@sandberg.pp.se# The LATEX_HEADER tag can be used to specify a personal LaTeX header for 12599888Sandreas@sandberg.pp.se# the generated latex document. The header should contain everything until 12609888Sandreas@sandberg.pp.se# the first chapter. If it is left blank doxygen will generate a 12619888Sandreas@sandberg.pp.se# standard header. Notice: only use this tag if you know what you are doing! 12629888Sandreas@sandberg.pp.se 12639888Sandreas@sandberg.pp.seLATEX_HEADER = 12649888Sandreas@sandberg.pp.se 12659888Sandreas@sandberg.pp.se# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for 12669888Sandreas@sandberg.pp.se# the generated latex document. The footer should contain everything after 12679888Sandreas@sandberg.pp.se# the last chapter. If it is left blank doxygen will generate a 12689888Sandreas@sandberg.pp.se# standard footer. Notice: only use this tag if you know what you are doing! 12699888Sandreas@sandberg.pp.se 12709888Sandreas@sandberg.pp.seLATEX_FOOTER = 12719888Sandreas@sandberg.pp.se 12729888Sandreas@sandberg.pp.se# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 12739888Sandreas@sandberg.pp.se# is prepared for conversion to pdf (using ps2pdf). The pdf file will 12749888Sandreas@sandberg.pp.se# contain links (just like the HTML output) instead of page references 12759888Sandreas@sandberg.pp.se# This makes the output suitable for online browsing using a pdf viewer. 12769888Sandreas@sandberg.pp.se 12779888Sandreas@sandberg.pp.sePDF_HYPERLINKS = YES 12789888Sandreas@sandberg.pp.se 12799888Sandreas@sandberg.pp.se# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 12809888Sandreas@sandberg.pp.se# plain latex in the generated Makefile. Set this option to YES to get a 12819888Sandreas@sandberg.pp.se# higher quality PDF documentation. 12829888Sandreas@sandberg.pp.se 12839888Sandreas@sandberg.pp.seUSE_PDFLATEX = YES 12849888Sandreas@sandberg.pp.se 12859888Sandreas@sandberg.pp.se# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 12869888Sandreas@sandberg.pp.se# command to the generated LaTeX files. This will instruct LaTeX to keep 12879888Sandreas@sandberg.pp.se# running if errors occur, instead of asking the user for help. 12889888Sandreas@sandberg.pp.se# This option is also used when generating formulas in HTML. 12899888Sandreas@sandberg.pp.se 12909888Sandreas@sandberg.pp.seLATEX_BATCHMODE = NO 12919888Sandreas@sandberg.pp.se 12929888Sandreas@sandberg.pp.se# If LATEX_HIDE_INDICES is set to YES then doxygen will not 12939888Sandreas@sandberg.pp.se# include the index chapters (such as File Index, Compound Index, etc.) 12949888Sandreas@sandberg.pp.se# in the output. 12959888Sandreas@sandberg.pp.se 12969888Sandreas@sandberg.pp.seLATEX_HIDE_INDICES = NO 12979888Sandreas@sandberg.pp.se 12989888Sandreas@sandberg.pp.se# If LATEX_SOURCE_CODE is set to YES then doxygen will include 12999888Sandreas@sandberg.pp.se# source code with syntax highlighting in the LaTeX output. 13009888Sandreas@sandberg.pp.se# Note that which sources are shown also depends on other settings 13019888Sandreas@sandberg.pp.se# such as SOURCE_BROWSER. 13029888Sandreas@sandberg.pp.se 13039888Sandreas@sandberg.pp.seLATEX_SOURCE_CODE = NO 13049888Sandreas@sandberg.pp.se 13059888Sandreas@sandberg.pp.se# The LATEX_BIB_STYLE tag can be used to specify the style to use for the 13069888Sandreas@sandberg.pp.se# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See 13079888Sandreas@sandberg.pp.se# http://en.wikipedia.org/wiki/BibTeX for more info. 13089888Sandreas@sandberg.pp.se 13099888Sandreas@sandberg.pp.seLATEX_BIB_STYLE = plain 13109888Sandreas@sandberg.pp.se 13119888Sandreas@sandberg.pp.se#--------------------------------------------------------------------------- 13129888Sandreas@sandberg.pp.se# configuration options related to the RTF output 13139888Sandreas@sandberg.pp.se#--------------------------------------------------------------------------- 13149888Sandreas@sandberg.pp.se 13159888Sandreas@sandberg.pp.se# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 13169888Sandreas@sandberg.pp.se# The RTF output is optimized for Word 97 and may not look very pretty with 13179888Sandreas@sandberg.pp.se# other RTF readers or editors. 13189888Sandreas@sandberg.pp.se 13199888Sandreas@sandberg.pp.seGENERATE_RTF = NO 13209888Sandreas@sandberg.pp.se 13219888Sandreas@sandberg.pp.se# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 13229888Sandreas@sandberg.pp.se# If a relative path is entered the value of OUTPUT_DIRECTORY will be 13239888Sandreas@sandberg.pp.se# put in front of it. If left blank `rtf' will be used as the default path. 13249888Sandreas@sandberg.pp.se 13259888Sandreas@sandberg.pp.seRTF_OUTPUT = rtf 13269888Sandreas@sandberg.pp.se 13279888Sandreas@sandberg.pp.se# If the COMPACT_RTF tag is set to YES Doxygen generates more compact 13289888Sandreas@sandberg.pp.se# RTF documents. This may be useful for small projects and may help to 13299888Sandreas@sandberg.pp.se# save some trees in general. 13309888Sandreas@sandberg.pp.se 13319888Sandreas@sandberg.pp.seCOMPACT_RTF = NO 13329888Sandreas@sandberg.pp.se 13339888Sandreas@sandberg.pp.se# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 13349888Sandreas@sandberg.pp.se# will contain hyperlink fields. The RTF file will 13359888Sandreas@sandberg.pp.se# contain links (just like the HTML output) instead of page references. 13369888Sandreas@sandberg.pp.se# This makes the output suitable for online browsing using WORD or other 13379888Sandreas@sandberg.pp.se# programs which support those fields. 13389888Sandreas@sandberg.pp.se# Note: wordpad (write) and others do not support links. 13399888Sandreas@sandberg.pp.se 13409888Sandreas@sandberg.pp.seRTF_HYPERLINKS = NO 13419888Sandreas@sandberg.pp.se 13429888Sandreas@sandberg.pp.se# Load style sheet definitions from file. Syntax is similar to doxygen's 13439888Sandreas@sandberg.pp.se# config file, i.e. a series of assignments. You only have to provide 13449888Sandreas@sandberg.pp.se# replacements, missing definitions are set to their default value. 13459888Sandreas@sandberg.pp.se 13469888Sandreas@sandberg.pp.seRTF_STYLESHEET_FILE = 13479888Sandreas@sandberg.pp.se 13489888Sandreas@sandberg.pp.se# Set optional variables used in the generation of an rtf document. 13499888Sandreas@sandberg.pp.se# Syntax is similar to doxygen's config file. 13509888Sandreas@sandberg.pp.se 13519888Sandreas@sandberg.pp.seRTF_EXTENSIONS_FILE = 13529888Sandreas@sandberg.pp.se 13539888Sandreas@sandberg.pp.se#--------------------------------------------------------------------------- 13549888Sandreas@sandberg.pp.se# configuration options related to the man page output 13559888Sandreas@sandberg.pp.se#--------------------------------------------------------------------------- 13569888Sandreas@sandberg.pp.se 13579888Sandreas@sandberg.pp.se# If the GENERATE_MAN tag is set to YES (the default) Doxygen will 13589888Sandreas@sandberg.pp.se# generate man pages 13599888Sandreas@sandberg.pp.se 13609888Sandreas@sandberg.pp.seGENERATE_MAN = NO 13619888Sandreas@sandberg.pp.se 13629888Sandreas@sandberg.pp.se# The MAN_OUTPUT tag is used to specify where the man pages will be put. 13639888Sandreas@sandberg.pp.se# If a relative path is entered the value of OUTPUT_DIRECTORY will be 13649888Sandreas@sandberg.pp.se# put in front of it. If left blank `man' will be used as the default path. 13659888Sandreas@sandberg.pp.se 13669888Sandreas@sandberg.pp.seMAN_OUTPUT = man 13679888Sandreas@sandberg.pp.se 13689888Sandreas@sandberg.pp.se# The MAN_EXTENSION tag determines the extension that is added to 13699888Sandreas@sandberg.pp.se# the generated man pages (default is the subroutine's section .3) 13709888Sandreas@sandberg.pp.se 13719888Sandreas@sandberg.pp.seMAN_EXTENSION = .3 13729888Sandreas@sandberg.pp.se 13739888Sandreas@sandberg.pp.se# If the MAN_LINKS tag is set to YES and Doxygen generates man output, 13749888Sandreas@sandberg.pp.se# then it will generate one additional man file for each entity 13759888Sandreas@sandberg.pp.se# documented in the real man page(s). These additional files 13769888Sandreas@sandberg.pp.se# only source the real man page, but without them the man command 13779888Sandreas@sandberg.pp.se# would be unable to find the correct page. The default is NO. 13789888Sandreas@sandberg.pp.se 13799888Sandreas@sandberg.pp.seMAN_LINKS = NO 13809888Sandreas@sandberg.pp.se 13819888Sandreas@sandberg.pp.se#--------------------------------------------------------------------------- 13829888Sandreas@sandberg.pp.se# configuration options related to the XML output 13839888Sandreas@sandberg.pp.se#--------------------------------------------------------------------------- 13849888Sandreas@sandberg.pp.se 13859888Sandreas@sandberg.pp.se# If the GENERATE_XML tag is set to YES Doxygen will 13869888Sandreas@sandberg.pp.se# generate an XML file that captures the structure of 13879888Sandreas@sandberg.pp.se# the code including all documentation. 13889888Sandreas@sandberg.pp.se 13899888Sandreas@sandberg.pp.seGENERATE_XML = NO 13909888Sandreas@sandberg.pp.se 13919888Sandreas@sandberg.pp.se# The XML_OUTPUT tag is used to specify where the XML pages will be put. 13929888Sandreas@sandberg.pp.se# If a relative path is entered the value of OUTPUT_DIRECTORY will be 13939888Sandreas@sandberg.pp.se# put in front of it. If left blank `xml' will be used as the default path. 13949888Sandreas@sandberg.pp.se 13959888Sandreas@sandberg.pp.seXML_OUTPUT = xml 13969888Sandreas@sandberg.pp.se 13979888Sandreas@sandberg.pp.se# The XML_SCHEMA tag can be used to specify an XML schema, 13989888Sandreas@sandberg.pp.se# which can be used by a validating XML parser to check the 13999888Sandreas@sandberg.pp.se# syntax of the XML files. 14009888Sandreas@sandberg.pp.se 14019888Sandreas@sandberg.pp.seXML_SCHEMA = 14029888Sandreas@sandberg.pp.se 14039888Sandreas@sandberg.pp.se# The XML_DTD tag can be used to specify an XML DTD, 14049888Sandreas@sandberg.pp.se# which can be used by a validating XML parser to check the 14059888Sandreas@sandberg.pp.se# syntax of the XML files. 14069888Sandreas@sandberg.pp.se 14079888Sandreas@sandberg.pp.seXML_DTD = 14089888Sandreas@sandberg.pp.se 14099888Sandreas@sandberg.pp.se# If the XML_PROGRAMLISTING tag is set to YES Doxygen will 14109888Sandreas@sandberg.pp.se# dump the program listings (including syntax highlighting 14119888Sandreas@sandberg.pp.se# and cross-referencing information) to the XML output. Note that 14129888Sandreas@sandberg.pp.se# enabling this will significantly increase the size of the XML output. 14139888Sandreas@sandberg.pp.se 14149888Sandreas@sandberg.pp.seXML_PROGRAMLISTING = YES 14159888Sandreas@sandberg.pp.se 14169888Sandreas@sandberg.pp.se#--------------------------------------------------------------------------- 14179888Sandreas@sandberg.pp.se# configuration options for the AutoGen Definitions output 14189888Sandreas@sandberg.pp.se#--------------------------------------------------------------------------- 14199888Sandreas@sandberg.pp.se 14209888Sandreas@sandberg.pp.se# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 14219888Sandreas@sandberg.pp.se# generate an AutoGen Definitions (see autogen.sf.net) file 14229888Sandreas@sandberg.pp.se# that captures the structure of the code including all 14239888Sandreas@sandberg.pp.se# documentation. Note that this feature is still experimental 14249888Sandreas@sandberg.pp.se# and incomplete at the moment. 14259888Sandreas@sandberg.pp.se 14269888Sandreas@sandberg.pp.seGENERATE_AUTOGEN_DEF = NO 14279888Sandreas@sandberg.pp.se 14289888Sandreas@sandberg.pp.se#--------------------------------------------------------------------------- 14299888Sandreas@sandberg.pp.se# configuration options related to the Perl module output 14309888Sandreas@sandberg.pp.se#--------------------------------------------------------------------------- 14319888Sandreas@sandberg.pp.se 14329888Sandreas@sandberg.pp.se# If the GENERATE_PERLMOD tag is set to YES Doxygen will 14339888Sandreas@sandberg.pp.se# generate a Perl module file that captures the structure of 14349888Sandreas@sandberg.pp.se# the code including all documentation. Note that this 14359888Sandreas@sandberg.pp.se# feature is still experimental and incomplete at the 14369888Sandreas@sandberg.pp.se# moment. 14379888Sandreas@sandberg.pp.se 14389888Sandreas@sandberg.pp.seGENERATE_PERLMOD = NO 14399888Sandreas@sandberg.pp.se 14409888Sandreas@sandberg.pp.se# If the PERLMOD_LATEX tag is set to YES Doxygen will generate 14419888Sandreas@sandberg.pp.se# the necessary Makefile rules, Perl scripts and LaTeX code to be able 14429888Sandreas@sandberg.pp.se# to generate PDF and DVI output from the Perl module output. 14439888Sandreas@sandberg.pp.se 14449888Sandreas@sandberg.pp.sePERLMOD_LATEX = NO 14459888Sandreas@sandberg.pp.se 14469888Sandreas@sandberg.pp.se# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 14479888Sandreas@sandberg.pp.se# nicely formatted so it can be parsed by a human reader. 14489888Sandreas@sandberg.pp.se# This is useful 14499888Sandreas@sandberg.pp.se# if you want to understand what is going on. 14509888Sandreas@sandberg.pp.se# On the other hand, if this 14519888Sandreas@sandberg.pp.se# tag is set to NO the size of the Perl module output will be much smaller 14529888Sandreas@sandberg.pp.se# and Perl will parse it just the same. 14539888Sandreas@sandberg.pp.se 14549888Sandreas@sandberg.pp.sePERLMOD_PRETTY = YES 14559888Sandreas@sandberg.pp.se 14569888Sandreas@sandberg.pp.se# The names of the make variables in the generated doxyrules.make file 14579888Sandreas@sandberg.pp.se# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 14589888Sandreas@sandberg.pp.se# This is useful so different doxyrules.make files included by the same 14599888Sandreas@sandberg.pp.se# Makefile don't overwrite each other's variables. 14609888Sandreas@sandberg.pp.se 14619888Sandreas@sandberg.pp.sePERLMOD_MAKEVAR_PREFIX = 14629888Sandreas@sandberg.pp.se 14639888Sandreas@sandberg.pp.se#--------------------------------------------------------------------------- 14649888Sandreas@sandberg.pp.se# Configuration options related to the preprocessor 14659888Sandreas@sandberg.pp.se#--------------------------------------------------------------------------- 14669888Sandreas@sandberg.pp.se 14679888Sandreas@sandberg.pp.se# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 14689888Sandreas@sandberg.pp.se# evaluate all C-preprocessor directives found in the sources and include 14699888Sandreas@sandberg.pp.se# files. 14709888Sandreas@sandberg.pp.se 14719888Sandreas@sandberg.pp.seENABLE_PREPROCESSING = YES 14729888Sandreas@sandberg.pp.se 14739888Sandreas@sandberg.pp.se# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 14749888Sandreas@sandberg.pp.se# names in the source code. If set to NO (the default) only conditional 14759888Sandreas@sandberg.pp.se# compilation will be performed. Macro expansion can be done in a controlled 14769888Sandreas@sandberg.pp.se# way by setting EXPAND_ONLY_PREDEF to YES. 14779888Sandreas@sandberg.pp.se 14789888Sandreas@sandberg.pp.seMACRO_EXPANSION = NO 14799888Sandreas@sandberg.pp.se 14809888Sandreas@sandberg.pp.se# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 14819888Sandreas@sandberg.pp.se# then the macro expansion is limited to the macros specified with the 14829888Sandreas@sandberg.pp.se# PREDEFINED and EXPAND_AS_DEFINED tags. 14839888Sandreas@sandberg.pp.se 14849888Sandreas@sandberg.pp.seEXPAND_ONLY_PREDEF = NO 14859888Sandreas@sandberg.pp.se 14869888Sandreas@sandberg.pp.se# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 14879888Sandreas@sandberg.pp.se# pointed to by INCLUDE_PATH will be searched when a #include is found. 14889888Sandreas@sandberg.pp.se 14899888Sandreas@sandberg.pp.seSEARCH_INCLUDES = YES 14909888Sandreas@sandberg.pp.se 14919888Sandreas@sandberg.pp.se# The INCLUDE_PATH tag can be used to specify one or more directories that 14929888Sandreas@sandberg.pp.se# contain include files that are not input files but should be processed by 14939888Sandreas@sandberg.pp.se# the preprocessor. 14949888Sandreas@sandberg.pp.se 14959888Sandreas@sandberg.pp.seINCLUDE_PATH = include/ 14969888Sandreas@sandberg.pp.se 14979888Sandreas@sandberg.pp.se# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 14989888Sandreas@sandberg.pp.se# patterns (like *.h and *.hpp) to filter out the header-files in the 14999888Sandreas@sandberg.pp.se# directories. If left blank, the patterns specified with FILE_PATTERNS will 15009888Sandreas@sandberg.pp.se# be used. 15019888Sandreas@sandberg.pp.se 15029888Sandreas@sandberg.pp.seINCLUDE_FILE_PATTERNS = 15039888Sandreas@sandberg.pp.se 15049888Sandreas@sandberg.pp.se# The PREDEFINED tag can be used to specify one or more macro names that 15059888Sandreas@sandberg.pp.se# are defined before the preprocessor is started (similar to the -D option of 15069888Sandreas@sandberg.pp.se# gcc). The argument of the tag is a list of macros of the form: name 15079888Sandreas@sandberg.pp.se# or name=definition (no spaces). If the definition and the = are 15089888Sandreas@sandberg.pp.se# omitted =1 is assumed. To prevent a macro definition from being 15099888Sandreas@sandberg.pp.se# undefined via #undef or recursively expanded use the := operator 15109888Sandreas@sandberg.pp.se# instead of the = operator. 15119888Sandreas@sandberg.pp.se 15129888Sandreas@sandberg.pp.sePREDEFINED = 15139888Sandreas@sandberg.pp.se 15149888Sandreas@sandberg.pp.se# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 15159888Sandreas@sandberg.pp.se# this tag can be used to specify a list of macro names that should be expanded. 15169888Sandreas@sandberg.pp.se# The macro definition that is found in the sources will be used. 15179888Sandreas@sandberg.pp.se# Use the PREDEFINED tag if you want to use a different macro definition that 15189888Sandreas@sandberg.pp.se# overrules the definition found in the source code. 15199888Sandreas@sandberg.pp.se 15209888Sandreas@sandberg.pp.seEXPAND_AS_DEFINED = 15219888Sandreas@sandberg.pp.se 15229888Sandreas@sandberg.pp.se# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 15239888Sandreas@sandberg.pp.se# doxygen's preprocessor will remove all references to function-like macros 15249888Sandreas@sandberg.pp.se# that are alone on a line, have an all uppercase name, and do not end with a 15259888Sandreas@sandberg.pp.se# semicolon, because these will confuse the parser if not removed. 15269888Sandreas@sandberg.pp.se 15279888Sandreas@sandberg.pp.seSKIP_FUNCTION_MACROS = YES 15289888Sandreas@sandberg.pp.se 15299888Sandreas@sandberg.pp.se#--------------------------------------------------------------------------- 15309888Sandreas@sandberg.pp.se# Configuration::additions related to external references 15319888Sandreas@sandberg.pp.se#--------------------------------------------------------------------------- 15329888Sandreas@sandberg.pp.se 15339888Sandreas@sandberg.pp.se# The TAGFILES option can be used to specify one or more tagfiles. For each 15349888Sandreas@sandberg.pp.se# tag file the location of the external documentation should be added. The 15359888Sandreas@sandberg.pp.se# format of a tag file without this location is as follows: 15369888Sandreas@sandberg.pp.se# 15379888Sandreas@sandberg.pp.se# TAGFILES = file1 file2 ... 15389888Sandreas@sandberg.pp.se# Adding location for the tag files is done as follows: 15399888Sandreas@sandberg.pp.se# 15409888Sandreas@sandberg.pp.se# TAGFILES = file1=loc1 "file2 = loc2" ... 15419888Sandreas@sandberg.pp.se# where "loc1" and "loc2" can be relative or absolute paths 15429888Sandreas@sandberg.pp.se# or URLs. Note that each tag file must have a unique name (where the name does 15439888Sandreas@sandberg.pp.se# NOT include the path). If a tag file is not located in the directory in which 15449888Sandreas@sandberg.pp.se# doxygen is run, you must also specify the path to the tagfile here. 15459888Sandreas@sandberg.pp.se 15469888Sandreas@sandberg.pp.seTAGFILES = 15479888Sandreas@sandberg.pp.se 15489888Sandreas@sandberg.pp.se# When a file name is specified after GENERATE_TAGFILE, doxygen will create 15499888Sandreas@sandberg.pp.se# a tag file that is based on the input files it reads. 15509888Sandreas@sandberg.pp.se 15519888Sandreas@sandberg.pp.seGENERATE_TAGFILE = 15529888Sandreas@sandberg.pp.se 15539888Sandreas@sandberg.pp.se# If the ALLEXTERNALS tag is set to YES all external classes will be listed 15549888Sandreas@sandberg.pp.se# in the class index. If set to NO only the inherited external classes 15559888Sandreas@sandberg.pp.se# will be listed. 15569888Sandreas@sandberg.pp.se 15579888Sandreas@sandberg.pp.seALLEXTERNALS = NO 15589888Sandreas@sandberg.pp.se 15599888Sandreas@sandberg.pp.se# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 15609888Sandreas@sandberg.pp.se# in the modules index. If set to NO, only the current project's groups will 15619888Sandreas@sandberg.pp.se# be listed. 15629888Sandreas@sandberg.pp.se 15639888Sandreas@sandberg.pp.seEXTERNAL_GROUPS = YES 15649888Sandreas@sandberg.pp.se 15659888Sandreas@sandberg.pp.se# The PERL_PATH should be the absolute path and name of the perl script 15669888Sandreas@sandberg.pp.se# interpreter (i.e. the result of `which perl'). 15679888Sandreas@sandberg.pp.se 15689888Sandreas@sandberg.pp.sePERL_PATH = /usr/bin/perl 15699888Sandreas@sandberg.pp.se 15709888Sandreas@sandberg.pp.se#--------------------------------------------------------------------------- 15719888Sandreas@sandberg.pp.se# Configuration options related to the dot tool 15729888Sandreas@sandberg.pp.se#--------------------------------------------------------------------------- 15739888Sandreas@sandberg.pp.se 15749888Sandreas@sandberg.pp.se# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 15759888Sandreas@sandberg.pp.se# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base 15769888Sandreas@sandberg.pp.se# or super classes. Setting the tag to NO turns the diagrams off. Note that 15779888Sandreas@sandberg.pp.se# this option also works with HAVE_DOT disabled, but it is recommended to 15789888Sandreas@sandberg.pp.se# install and use dot, since it yields more powerful graphs. 15799888Sandreas@sandberg.pp.se 15809888Sandreas@sandberg.pp.seCLASS_DIAGRAMS = YES 15819888Sandreas@sandberg.pp.se 15829888Sandreas@sandberg.pp.se# You can define message sequence charts within doxygen comments using the \msc 15839888Sandreas@sandberg.pp.se# command. Doxygen will then run the mscgen tool (see 15849888Sandreas@sandberg.pp.se# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the 15859888Sandreas@sandberg.pp.se# documentation. The MSCGEN_PATH tag allows you to specify the directory where 15869888Sandreas@sandberg.pp.se# the mscgen tool resides. If left empty the tool is assumed to be found in the 15879888Sandreas@sandberg.pp.se# default search path. 15889888Sandreas@sandberg.pp.se 15899888Sandreas@sandberg.pp.seMSCGEN_PATH = 15909888Sandreas@sandberg.pp.se 15919888Sandreas@sandberg.pp.se# If set to YES, the inheritance and collaboration graphs will hide 15929888Sandreas@sandberg.pp.se# inheritance and usage relations if the target is undocumented 15939888Sandreas@sandberg.pp.se# or is not a class. 15949888Sandreas@sandberg.pp.se 15959888Sandreas@sandberg.pp.seHIDE_UNDOC_RELATIONS = YES 15969888Sandreas@sandberg.pp.se 15979888Sandreas@sandberg.pp.se# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 15989888Sandreas@sandberg.pp.se# available from the path. This tool is part of Graphviz, a graph visualization 15999888Sandreas@sandberg.pp.se# toolkit from AT&T and Lucent Bell Labs. The other options in this section 16009888Sandreas@sandberg.pp.se# have no effect if this option is set to NO (the default) 16019888Sandreas@sandberg.pp.se 16029888Sandreas@sandberg.pp.seHAVE_DOT = NO 16039888Sandreas@sandberg.pp.se 16049888Sandreas@sandberg.pp.se# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is 16059888Sandreas@sandberg.pp.se# allowed to run in parallel. When set to 0 (the default) doxygen will 16069888Sandreas@sandberg.pp.se# base this on the number of processors available in the system. You can set it 16079888Sandreas@sandberg.pp.se# explicitly to a value larger than 0 to get control over the balance 16089888Sandreas@sandberg.pp.se# between CPU load and processing speed. 16099888Sandreas@sandberg.pp.se 16109888Sandreas@sandberg.pp.seDOT_NUM_THREADS = 0 16119888Sandreas@sandberg.pp.se 16129888Sandreas@sandberg.pp.se# By default doxygen will use the Helvetica font for all dot files that 16139888Sandreas@sandberg.pp.se# doxygen generates. When you want a differently looking font you can specify 16149888Sandreas@sandberg.pp.se# the font name using DOT_FONTNAME. You need to make sure dot is able to find 16159888Sandreas@sandberg.pp.se# the font, which can be done by putting it in a standard location or by setting 16169888Sandreas@sandberg.pp.se# the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the 16179888Sandreas@sandberg.pp.se# directory containing the font. 16189888Sandreas@sandberg.pp.se 16199888Sandreas@sandberg.pp.seDOT_FONTNAME = Helvetica 16209888Sandreas@sandberg.pp.se 16219888Sandreas@sandberg.pp.se# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. 16229888Sandreas@sandberg.pp.se# The default size is 10pt. 16239888Sandreas@sandberg.pp.se 16249888Sandreas@sandberg.pp.seDOT_FONTSIZE = 10 16259888Sandreas@sandberg.pp.se 16269888Sandreas@sandberg.pp.se# By default doxygen will tell dot to use the Helvetica font. 16279888Sandreas@sandberg.pp.se# If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to 16289888Sandreas@sandberg.pp.se# set the path where dot can find it. 16299888Sandreas@sandberg.pp.se 16309888Sandreas@sandberg.pp.seDOT_FONTPATH = 16319888Sandreas@sandberg.pp.se 16329888Sandreas@sandberg.pp.se# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 16339888Sandreas@sandberg.pp.se# will generate a graph for each documented class showing the direct and 16349888Sandreas@sandberg.pp.se# indirect inheritance relations. Setting this tag to YES will force the 16359888Sandreas@sandberg.pp.se# CLASS_DIAGRAMS tag to NO. 16369888Sandreas@sandberg.pp.se 16379888Sandreas@sandberg.pp.seCLASS_GRAPH = YES 16389888Sandreas@sandberg.pp.se 16399888Sandreas@sandberg.pp.se# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 16409888Sandreas@sandberg.pp.se# will generate a graph for each documented class showing the direct and 16419888Sandreas@sandberg.pp.se# indirect implementation dependencies (inheritance, containment, and 16429888Sandreas@sandberg.pp.se# class references variables) of the class with other documented classes. 16439888Sandreas@sandberg.pp.se 16449888Sandreas@sandberg.pp.seCOLLABORATION_GRAPH = YES 16459888Sandreas@sandberg.pp.se 16469888Sandreas@sandberg.pp.se# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen 16479888Sandreas@sandberg.pp.se# will generate a graph for groups, showing the direct groups dependencies 16489888Sandreas@sandberg.pp.se 16499888Sandreas@sandberg.pp.seGROUP_GRAPHS = YES 16509888Sandreas@sandberg.pp.se 16519888Sandreas@sandberg.pp.se# If the UML_LOOK tag is set to YES doxygen will generate inheritance and 16529888Sandreas@sandberg.pp.se# collaboration diagrams in a style similar to the OMG's Unified Modeling 16539888Sandreas@sandberg.pp.se# Language. 16549888Sandreas@sandberg.pp.se 16559888Sandreas@sandberg.pp.seUML_LOOK = NO 16569888Sandreas@sandberg.pp.se 16579888Sandreas@sandberg.pp.se# If the UML_LOOK tag is enabled, the fields and methods are shown inside 16589888Sandreas@sandberg.pp.se# the class node. If there are many fields or methods and many nodes the 16599888Sandreas@sandberg.pp.se# graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS 16609888Sandreas@sandberg.pp.se# threshold limits the number of items for each type to make the size more 16619888Sandreas@sandberg.pp.se# managable. Set this to 0 for no limit. Note that the threshold may be 16629888Sandreas@sandberg.pp.se# exceeded by 50% before the limit is enforced. 16639888Sandreas@sandberg.pp.se 16649888Sandreas@sandberg.pp.seUML_LIMIT_NUM_FIELDS = 10 16659888Sandreas@sandberg.pp.se 16669888Sandreas@sandberg.pp.se# If set to YES, the inheritance and collaboration graphs will show the 16679888Sandreas@sandberg.pp.se# relations between templates and their instances. 16689888Sandreas@sandberg.pp.se 16699888Sandreas@sandberg.pp.seTEMPLATE_RELATIONS = NO 16709888Sandreas@sandberg.pp.se 16719888Sandreas@sandberg.pp.se# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 16729888Sandreas@sandberg.pp.se# tags are set to YES then doxygen will generate a graph for each documented 16739888Sandreas@sandberg.pp.se# file showing the direct and indirect include dependencies of the file with 16749888Sandreas@sandberg.pp.se# other documented files. 16759888Sandreas@sandberg.pp.se 16769888Sandreas@sandberg.pp.seINCLUDE_GRAPH = YES 16779888Sandreas@sandberg.pp.se 16789888Sandreas@sandberg.pp.se# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 16799888Sandreas@sandberg.pp.se# HAVE_DOT tags are set to YES then doxygen will generate a graph for each 16809888Sandreas@sandberg.pp.se# documented header file showing the documented files that directly or 16819888Sandreas@sandberg.pp.se# indirectly include this file. 16829888Sandreas@sandberg.pp.se 16839888Sandreas@sandberg.pp.seINCLUDED_BY_GRAPH = YES 16849888Sandreas@sandberg.pp.se 16859888Sandreas@sandberg.pp.se# If the CALL_GRAPH and HAVE_DOT options are set to YES then 16869888Sandreas@sandberg.pp.se# doxygen will generate a call dependency graph for every global function 16879888Sandreas@sandberg.pp.se# or class method. Note that enabling this option will significantly increase 16889888Sandreas@sandberg.pp.se# the time of a run. So in most cases it will be better to enable call graphs 16899888Sandreas@sandberg.pp.se# for selected functions only using the \callgraph command. 16909888Sandreas@sandberg.pp.se 16919888Sandreas@sandberg.pp.seCALL_GRAPH = NO 16929888Sandreas@sandberg.pp.se 16939888Sandreas@sandberg.pp.se# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then 16949888Sandreas@sandberg.pp.se# doxygen will generate a caller dependency graph for every global function 16959888Sandreas@sandberg.pp.se# or class method. Note that enabling this option will significantly increase 16969888Sandreas@sandberg.pp.se# the time of a run. So in most cases it will be better to enable caller 16979888Sandreas@sandberg.pp.se# graphs for selected functions only using the \callergraph command. 16989888Sandreas@sandberg.pp.se 16999888Sandreas@sandberg.pp.seCALLER_GRAPH = NO 17009888Sandreas@sandberg.pp.se 17019888Sandreas@sandberg.pp.se# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 17029888Sandreas@sandberg.pp.se# will generate a graphical hierarchy of all classes instead of a textual one. 17039888Sandreas@sandberg.pp.se 17049888Sandreas@sandberg.pp.seGRAPHICAL_HIERARCHY = YES 17059888Sandreas@sandberg.pp.se 17069888Sandreas@sandberg.pp.se# If the DIRECTORY_GRAPH and HAVE_DOT tags are set to YES 17079888Sandreas@sandberg.pp.se# then doxygen will show the dependencies a directory has on other directories 17089888Sandreas@sandberg.pp.se# in a graphical way. The dependency relations are determined by the #include 17099888Sandreas@sandberg.pp.se# relations between the files in the directories. 17109888Sandreas@sandberg.pp.se 17119888Sandreas@sandberg.pp.seDIRECTORY_GRAPH = YES 17129888Sandreas@sandberg.pp.se 17139888Sandreas@sandberg.pp.se# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 17149888Sandreas@sandberg.pp.se# generated by dot. Possible values are svg, png, jpg, or gif. 17159888Sandreas@sandberg.pp.se# If left blank png will be used. If you choose svg you need to set 17169888Sandreas@sandberg.pp.se# HTML_FILE_EXTENSION to xhtml in order to make the SVG files 17179888Sandreas@sandberg.pp.se# visible in IE 9+ (other browsers do not have this requirement). 17189888Sandreas@sandberg.pp.se 17199888Sandreas@sandberg.pp.seDOT_IMAGE_FORMAT = png 17209888Sandreas@sandberg.pp.se 17219888Sandreas@sandberg.pp.se# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to 17229888Sandreas@sandberg.pp.se# enable generation of interactive SVG images that allow zooming and panning. 17239888Sandreas@sandberg.pp.se# Note that this requires a modern browser other than Internet Explorer. 17249888Sandreas@sandberg.pp.se# Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you 17259888Sandreas@sandberg.pp.se# need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files 17269888Sandreas@sandberg.pp.se# visible. Older versions of IE do not have SVG support. 17279888Sandreas@sandberg.pp.se 17289888Sandreas@sandberg.pp.seINTERACTIVE_SVG = NO 17299888Sandreas@sandberg.pp.se 17309888Sandreas@sandberg.pp.se# The tag DOT_PATH can be used to specify the path where the dot tool can be 17319888Sandreas@sandberg.pp.se# found. If left blank, it is assumed the dot tool can be found in the path. 17329888Sandreas@sandberg.pp.se 17339888Sandreas@sandberg.pp.seDOT_PATH = 17349888Sandreas@sandberg.pp.se 17359888Sandreas@sandberg.pp.se# The DOTFILE_DIRS tag can be used to specify one or more directories that 17369888Sandreas@sandberg.pp.se# contain dot files that are included in the documentation (see the 17379888Sandreas@sandberg.pp.se# \dotfile command). 17389888Sandreas@sandberg.pp.se 17399888Sandreas@sandberg.pp.seDOTFILE_DIRS = 17409888Sandreas@sandberg.pp.se 17419888Sandreas@sandberg.pp.se# The MSCFILE_DIRS tag can be used to specify one or more directories that 17429888Sandreas@sandberg.pp.se# contain msc files that are included in the documentation (see the 17439888Sandreas@sandberg.pp.se# \mscfile command). 17449888Sandreas@sandberg.pp.se 17459888Sandreas@sandberg.pp.seMSCFILE_DIRS = 17469888Sandreas@sandberg.pp.se 17479888Sandreas@sandberg.pp.se# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of 17489888Sandreas@sandberg.pp.se# nodes that will be shown in the graph. If the number of nodes in a graph 17499888Sandreas@sandberg.pp.se# becomes larger than this value, doxygen will truncate the graph, which is 17509888Sandreas@sandberg.pp.se# visualized by representing a node as a red box. Note that doxygen if the 17519888Sandreas@sandberg.pp.se# number of direct children of the root node in a graph is already larger than 17529888Sandreas@sandberg.pp.se# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note 17539888Sandreas@sandberg.pp.se# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. 17549888Sandreas@sandberg.pp.se 17559888Sandreas@sandberg.pp.seDOT_GRAPH_MAX_NODES = 50 17569888Sandreas@sandberg.pp.se 17579888Sandreas@sandberg.pp.se# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 17589888Sandreas@sandberg.pp.se# graphs generated by dot. A depth value of 3 means that only nodes reachable 17599888Sandreas@sandberg.pp.se# from the root by following a path via at most 3 edges will be shown. Nodes 17609888Sandreas@sandberg.pp.se# that lay further from the root node will be omitted. Note that setting this 17619888Sandreas@sandberg.pp.se# option to 1 or 2 may greatly reduce the computation time needed for large 17629888Sandreas@sandberg.pp.se# code bases. Also note that the size of a graph can be further restricted by 17639888Sandreas@sandberg.pp.se# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. 17649888Sandreas@sandberg.pp.se 17659888Sandreas@sandberg.pp.seMAX_DOT_GRAPH_DEPTH = 0 17669888Sandreas@sandberg.pp.se 17679888Sandreas@sandberg.pp.se# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 17689888Sandreas@sandberg.pp.se# background. This is disabled by default, because dot on Windows does not 17699888Sandreas@sandberg.pp.se# seem to support this out of the box. Warning: Depending on the platform used, 17709888Sandreas@sandberg.pp.se# enabling this option may lead to badly anti-aliased labels on the edges of 17719888Sandreas@sandberg.pp.se# a graph (i.e. they become hard to read). 17729888Sandreas@sandberg.pp.se 17739888Sandreas@sandberg.pp.seDOT_TRANSPARENT = NO 17749888Sandreas@sandberg.pp.se 17759888Sandreas@sandberg.pp.se# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output 17769888Sandreas@sandberg.pp.se# files in one run (i.e. multiple -o and -T options on the command line). This 17779888Sandreas@sandberg.pp.se# makes dot run faster, but since only newer versions of dot (>1.8.10) 17789888Sandreas@sandberg.pp.se# support this, this feature is disabled by default. 17799888Sandreas@sandberg.pp.se 17809888Sandreas@sandberg.pp.seDOT_MULTI_TARGETS = YES 17819888Sandreas@sandberg.pp.se 17829888Sandreas@sandberg.pp.se# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 17839888Sandreas@sandberg.pp.se# generate a legend page explaining the meaning of the various boxes and 17849888Sandreas@sandberg.pp.se# arrows in the dot generated graphs. 17859888Sandreas@sandberg.pp.se 17869888Sandreas@sandberg.pp.seGENERATE_LEGEND = YES 17879888Sandreas@sandberg.pp.se 17889888Sandreas@sandberg.pp.se# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 17899888Sandreas@sandberg.pp.se# remove the intermediate dot files that are used to generate 17909888Sandreas@sandberg.pp.se# the various graphs. 17919888Sandreas@sandberg.pp.se 17929888Sandreas@sandberg.pp.seDOT_CLEANUP = YES 1793