110915Sandreas.sandberg@arm.com# Doxyfile 1.7.6.1
210915Sandreas.sandberg@arm.com
310915Sandreas.sandberg@arm.com# This file describes the settings to be used by the documentation system
410915Sandreas.sandberg@arm.com# doxygen (www.doxygen.org) for a project.
510915Sandreas.sandberg@arm.com#
610915Sandreas.sandberg@arm.com# All text after a hash (#) is considered a comment and will be ignored.
710915Sandreas.sandberg@arm.com# The format is:
810915Sandreas.sandberg@arm.com#       TAG = value [value, ...]
910915Sandreas.sandberg@arm.com# For lists items can also be appended using:
1010915Sandreas.sandberg@arm.com#       TAG += value [value, ...]
1110915Sandreas.sandberg@arm.com# Values that contain spaces should be placed between quotes (" ").
1210915Sandreas.sandberg@arm.com
1310915Sandreas.sandberg@arm.com#---------------------------------------------------------------------------
1410915Sandreas.sandberg@arm.com# Project related configuration options
1510915Sandreas.sandberg@arm.com#---------------------------------------------------------------------------
1610915Sandreas.sandberg@arm.com
1710915Sandreas.sandberg@arm.com# This tag specifies the encoding used for all characters in the config file
1810915Sandreas.sandberg@arm.com# that follow. The default is UTF-8 which is also the encoding used for all
1910915Sandreas.sandberg@arm.com# text before the first occurrence of this tag. Doxygen uses libiconv (or the
2010915Sandreas.sandberg@arm.com# iconv built into libc) for the transcoding. See
2110915Sandreas.sandberg@arm.com# http://www.gnu.org/software/libiconv for the list of possible encodings.
2210915Sandreas.sandberg@arm.com
2310915Sandreas.sandberg@arm.comDOXYFILE_ENCODING      = UTF-8
2410915Sandreas.sandberg@arm.com
2510915Sandreas.sandberg@arm.com# The PROJECT_NAME tag is a single word (or sequence of words) that should
2610915Sandreas.sandberg@arm.com# identify the project. Note that if you do not use Doxywizard you need
2710915Sandreas.sandberg@arm.com# to put quotes around the project name if it contains spaces.
2810915Sandreas.sandberg@arm.com
2910915Sandreas.sandberg@arm.comPROJECT_NAME           = "NoMali Device Model"
3010915Sandreas.sandberg@arm.com
3110915Sandreas.sandberg@arm.com# The PROJECT_NUMBER tag can be used to enter a project or revision number.
3210915Sandreas.sandberg@arm.com# This could be handy for archiving the generated documentation or
3310915Sandreas.sandberg@arm.com# if some version control system is used.
3410915Sandreas.sandberg@arm.com
3510915Sandreas.sandberg@arm.comPROJECT_NUMBER         =
3610915Sandreas.sandberg@arm.com
3710915Sandreas.sandberg@arm.com# Using the PROJECT_BRIEF tag one can provide an optional one line description
3810915Sandreas.sandberg@arm.com# for a project that appears at the top of each page and should give viewer
3910915Sandreas.sandberg@arm.com# a quick idea about the purpose of the project. Keep the description short.
4010915Sandreas.sandberg@arm.com
4110915Sandreas.sandberg@arm.comPROJECT_BRIEF          =
4210915Sandreas.sandberg@arm.com
4310915Sandreas.sandberg@arm.com# With the PROJECT_LOGO tag one can specify an logo or icon that is
4410915Sandreas.sandberg@arm.com# included in the documentation. The maximum height of the logo should not
4510915Sandreas.sandberg@arm.com# exceed 55 pixels and the maximum width should not exceed 200 pixels.
4610915Sandreas.sandberg@arm.com# Doxygen will copy the logo to the output directory.
4710915Sandreas.sandberg@arm.com
4810915Sandreas.sandberg@arm.comPROJECT_LOGO           =
4910915Sandreas.sandberg@arm.com
5010915Sandreas.sandberg@arm.com# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
5110915Sandreas.sandberg@arm.com# base path where the generated documentation will be put.
5210915Sandreas.sandberg@arm.com# If a relative path is entered, it will be relative to the location
5310915Sandreas.sandberg@arm.com# where doxygen was started. If left blank the current directory will be used.
5410915Sandreas.sandberg@arm.com
5510915Sandreas.sandberg@arm.comOUTPUT_DIRECTORY       = docs/
5610915Sandreas.sandberg@arm.com
5710915Sandreas.sandberg@arm.com# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
5810915Sandreas.sandberg@arm.com# 4096 sub-directories (in 2 levels) under the output directory of each output
5910915Sandreas.sandberg@arm.com# format and will distribute the generated files over these directories.
6010915Sandreas.sandberg@arm.com# Enabling this option can be useful when feeding doxygen a huge amount of
6110915Sandreas.sandberg@arm.com# source files, where putting all generated files in the same directory would
6210915Sandreas.sandberg@arm.com# otherwise cause performance problems for the file system.
6310915Sandreas.sandberg@arm.com
6410915Sandreas.sandberg@arm.comCREATE_SUBDIRS         = NO
6510915Sandreas.sandberg@arm.com
6610915Sandreas.sandberg@arm.com# The OUTPUT_LANGUAGE tag is used to specify the language in which all
6710915Sandreas.sandberg@arm.com# documentation generated by doxygen is written. Doxygen will use this
6810915Sandreas.sandberg@arm.com# information to generate all constant output in the proper language.
6910915Sandreas.sandberg@arm.com# The default language is English, other supported languages are:
7010915Sandreas.sandberg@arm.com# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
7110915Sandreas.sandberg@arm.com# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
7210915Sandreas.sandberg@arm.com# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
7310915Sandreas.sandberg@arm.com# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
7410915Sandreas.sandberg@arm.com# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak,
7510915Sandreas.sandberg@arm.com# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
7610915Sandreas.sandberg@arm.com
7710915Sandreas.sandberg@arm.comOUTPUT_LANGUAGE        = English
7810915Sandreas.sandberg@arm.com
7910915Sandreas.sandberg@arm.com# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
8010915Sandreas.sandberg@arm.com# include brief member descriptions after the members that are listed in
8110915Sandreas.sandberg@arm.com# the file and class documentation (similar to JavaDoc).
8210915Sandreas.sandberg@arm.com# Set to NO to disable this.
8310915Sandreas.sandberg@arm.com
8410915Sandreas.sandberg@arm.comBRIEF_MEMBER_DESC      = YES
8510915Sandreas.sandberg@arm.com
8610915Sandreas.sandberg@arm.com# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
8710915Sandreas.sandberg@arm.com# the brief description of a member or function before the detailed description.
8810915Sandreas.sandberg@arm.com# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
8910915Sandreas.sandberg@arm.com# brief descriptions will be completely suppressed.
9010915Sandreas.sandberg@arm.com
9110915Sandreas.sandberg@arm.comREPEAT_BRIEF           = YES
9210915Sandreas.sandberg@arm.com
9310915Sandreas.sandberg@arm.com# This tag implements a quasi-intelligent brief description abbreviator
9410915Sandreas.sandberg@arm.com# that is used to form the text in various listings. Each string
9510915Sandreas.sandberg@arm.com# in this list, if found as the leading text of the brief description, will be
9610915Sandreas.sandberg@arm.com# stripped from the text and the result after processing the whole list, is
9710915Sandreas.sandberg@arm.com# used as the annotated text. Otherwise, the brief description is used as-is.
9810915Sandreas.sandberg@arm.com# If left blank, the following values are used ("$name" is automatically
9910915Sandreas.sandberg@arm.com# replaced with the name of the entity): "The $name class" "The $name widget"
10010915Sandreas.sandberg@arm.com# "The $name file" "is" "provides" "specifies" "contains"
10110915Sandreas.sandberg@arm.com# "represents" "a" "an" "the"
10210915Sandreas.sandberg@arm.com
10310915Sandreas.sandberg@arm.comABBREVIATE_BRIEF       =
10410915Sandreas.sandberg@arm.com
10510915Sandreas.sandberg@arm.com# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
10610915Sandreas.sandberg@arm.com# Doxygen will generate a detailed section even if there is only a brief
10710915Sandreas.sandberg@arm.com# description.
10810915Sandreas.sandberg@arm.com
10910915Sandreas.sandberg@arm.comALWAYS_DETAILED_SEC    = NO
11010915Sandreas.sandberg@arm.com
11110915Sandreas.sandberg@arm.com# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
11210915Sandreas.sandberg@arm.com# inherited members of a class in the documentation of that class as if those
11310915Sandreas.sandberg@arm.com# members were ordinary class members. Constructors, destructors and assignment
11410915Sandreas.sandberg@arm.com# operators of the base classes will not be shown.
11510915Sandreas.sandberg@arm.com
11610915Sandreas.sandberg@arm.comINLINE_INHERITED_MEMB  = NO
11710915Sandreas.sandberg@arm.com
11810915Sandreas.sandberg@arm.com# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
11910915Sandreas.sandberg@arm.com# path before files name in the file list and in the header files. If set
12010915Sandreas.sandberg@arm.com# to NO the shortest path that makes the file name unique will be used.
12110915Sandreas.sandberg@arm.com
12210915Sandreas.sandberg@arm.comFULL_PATH_NAMES        = YES
12310915Sandreas.sandberg@arm.com
12410915Sandreas.sandberg@arm.com# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
12510915Sandreas.sandberg@arm.com# can be used to strip a user-defined part of the path. Stripping is
12610915Sandreas.sandberg@arm.com# only done if one of the specified strings matches the left-hand part of
12710915Sandreas.sandberg@arm.com# the path. The tag can be used to show relative paths in the file list.
12810915Sandreas.sandberg@arm.com# If left blank the directory from which doxygen is run is used as the
12910915Sandreas.sandberg@arm.com# path to strip.
13010915Sandreas.sandberg@arm.com
13110915Sandreas.sandberg@arm.comSTRIP_FROM_PATH        =
13210915Sandreas.sandberg@arm.com
13310915Sandreas.sandberg@arm.com# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
13410915Sandreas.sandberg@arm.com# the path mentioned in the documentation of a class, which tells
13510915Sandreas.sandberg@arm.com# the reader which header file to include in order to use a class.
13610915Sandreas.sandberg@arm.com# If left blank only the name of the header file containing the class
13710915Sandreas.sandberg@arm.com# definition is used. Otherwise one should specify the include paths that
13810915Sandreas.sandberg@arm.com# are normally passed to the compiler using the -I flag.
13910915Sandreas.sandberg@arm.com
14010915Sandreas.sandberg@arm.comSTRIP_FROM_INC_PATH    =
14110915Sandreas.sandberg@arm.com
14210915Sandreas.sandberg@arm.com# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
14310915Sandreas.sandberg@arm.com# (but less readable) file names. This can be useful if your file system
14410915Sandreas.sandberg@arm.com# doesn't support long names like on DOS, Mac, or CD-ROM.
14510915Sandreas.sandberg@arm.com
14610915Sandreas.sandberg@arm.comSHORT_NAMES            = NO
14710915Sandreas.sandberg@arm.com
14810915Sandreas.sandberg@arm.com# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
14910915Sandreas.sandberg@arm.com# will interpret the first line (until the first dot) of a JavaDoc-style
15010915Sandreas.sandberg@arm.com# comment as the brief description. If set to NO, the JavaDoc
15110915Sandreas.sandberg@arm.com# comments will behave just like regular Qt-style comments
15210915Sandreas.sandberg@arm.com# (thus requiring an explicit @brief command for a brief description.)
15310915Sandreas.sandberg@arm.com
15410915Sandreas.sandberg@arm.comJAVADOC_AUTOBRIEF      = NO
15510915Sandreas.sandberg@arm.com
15610915Sandreas.sandberg@arm.com# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
15710915Sandreas.sandberg@arm.com# interpret the first line (until the first dot) of a Qt-style
15810915Sandreas.sandberg@arm.com# comment as the brief description. If set to NO, the comments
15910915Sandreas.sandberg@arm.com# will behave just like regular Qt-style comments (thus requiring
16010915Sandreas.sandberg@arm.com# an explicit \brief command for a brief description.)
16110915Sandreas.sandberg@arm.com
16210915Sandreas.sandberg@arm.comQT_AUTOBRIEF           = NO
16310915Sandreas.sandberg@arm.com
16410915Sandreas.sandberg@arm.com# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
16510915Sandreas.sandberg@arm.com# treat a multi-line C++ special comment block (i.e. a block of //! or ///
16610915Sandreas.sandberg@arm.com# comments) as a brief description. This used to be the default behaviour.
16710915Sandreas.sandberg@arm.com# The new default is to treat a multi-line C++ comment block as a detailed
16810915Sandreas.sandberg@arm.com# description. Set this tag to YES if you prefer the old behaviour instead.
16910915Sandreas.sandberg@arm.com
17010915Sandreas.sandberg@arm.comMULTILINE_CPP_IS_BRIEF = NO
17110915Sandreas.sandberg@arm.com
17210915Sandreas.sandberg@arm.com# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
17310915Sandreas.sandberg@arm.com# member inherits the documentation from any documented member that it
17410915Sandreas.sandberg@arm.com# re-implements.
17510915Sandreas.sandberg@arm.com
17610915Sandreas.sandberg@arm.comINHERIT_DOCS           = YES
17710915Sandreas.sandberg@arm.com
17810915Sandreas.sandberg@arm.com# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
17910915Sandreas.sandberg@arm.com# a new page for each member. If set to NO, the documentation of a member will
18010915Sandreas.sandberg@arm.com# be part of the file/class/namespace that contains it.
18110915Sandreas.sandberg@arm.com
18210915Sandreas.sandberg@arm.comSEPARATE_MEMBER_PAGES  = NO
18310915Sandreas.sandberg@arm.com
18410915Sandreas.sandberg@arm.com# The TAB_SIZE tag can be used to set the number of spaces in a tab.
18510915Sandreas.sandberg@arm.com# Doxygen uses this value to replace tabs by spaces in code fragments.
18610915Sandreas.sandberg@arm.com
18710915Sandreas.sandberg@arm.comTAB_SIZE               = 8
18810915Sandreas.sandberg@arm.com
18910915Sandreas.sandberg@arm.com# This tag can be used to specify a number of aliases that acts
19010915Sandreas.sandberg@arm.com# as commands in the documentation. An alias has the form "name=value".
19110915Sandreas.sandberg@arm.com# For example adding "sideeffect=\par Side Effects:\n" will allow you to
19210915Sandreas.sandberg@arm.com# put the command \sideeffect (or @sideeffect) in the documentation, which
19310915Sandreas.sandberg@arm.com# will result in a user-defined paragraph with heading "Side Effects:".
19410915Sandreas.sandberg@arm.com# You can put \n's in the value part of an alias to insert newlines.
19510915Sandreas.sandberg@arm.com
19610915Sandreas.sandberg@arm.comALIASES                =
19710915Sandreas.sandberg@arm.com
19810915Sandreas.sandberg@arm.comALIASES += errors="\par Errors:"
19910915Sandreas.sandberg@arm.comALIASES += error=" - \ref"
20010915Sandreas.sandberg@arm.com
20110915Sandreas.sandberg@arm.com
20210915Sandreas.sandberg@arm.com# This tag can be used to specify a number of word-keyword mappings (TCL only).
20310915Sandreas.sandberg@arm.com# A mapping has the form "name=value". For example adding
20410915Sandreas.sandberg@arm.com# "class=itcl::class" will allow you to use the command class in the
20510915Sandreas.sandberg@arm.com# itcl::class meaning.
20610915Sandreas.sandberg@arm.com
20710915Sandreas.sandberg@arm.comTCL_SUBST              =
20810915Sandreas.sandberg@arm.com
20910915Sandreas.sandberg@arm.com# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
21010915Sandreas.sandberg@arm.com# sources only. Doxygen will then generate output that is more tailored for C.
21110915Sandreas.sandberg@arm.com# For instance, some of the names that are used will be different. The list
21210915Sandreas.sandberg@arm.com# of all members will be omitted, etc.
21310915Sandreas.sandberg@arm.com
21410915Sandreas.sandberg@arm.comOPTIMIZE_OUTPUT_FOR_C  = NO
21510915Sandreas.sandberg@arm.com
21610915Sandreas.sandberg@arm.com# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
21710915Sandreas.sandberg@arm.com# sources only. Doxygen will then generate output that is more tailored for
21810915Sandreas.sandberg@arm.com# Java. For instance, namespaces will be presented as packages, qualified
21910915Sandreas.sandberg@arm.com# scopes will look different, etc.
22010915Sandreas.sandberg@arm.com
22110915Sandreas.sandberg@arm.comOPTIMIZE_OUTPUT_JAVA   = NO
22210915Sandreas.sandberg@arm.com
22310915Sandreas.sandberg@arm.com# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
22410915Sandreas.sandberg@arm.com# sources only. Doxygen will then generate output that is more tailored for
22510915Sandreas.sandberg@arm.com# Fortran.
22610915Sandreas.sandberg@arm.com
22710915Sandreas.sandberg@arm.comOPTIMIZE_FOR_FORTRAN   = NO
22810915Sandreas.sandberg@arm.com
22910915Sandreas.sandberg@arm.com# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
23010915Sandreas.sandberg@arm.com# sources. Doxygen will then generate output that is tailored for
23110915Sandreas.sandberg@arm.com# VHDL.
23210915Sandreas.sandberg@arm.com
23310915Sandreas.sandberg@arm.comOPTIMIZE_OUTPUT_VHDL   = NO
23410915Sandreas.sandberg@arm.com
23510915Sandreas.sandberg@arm.com# Doxygen selects the parser to use depending on the extension of the files it
23610915Sandreas.sandberg@arm.com# parses. With this tag you can assign which parser to use for a given extension.
23710915Sandreas.sandberg@arm.com# Doxygen has a built-in mapping, but you can override or extend it using this
23810915Sandreas.sandberg@arm.com# tag. The format is ext=language, where ext is a file extension, and language
23910915Sandreas.sandberg@arm.com# is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C,
24010915Sandreas.sandberg@arm.com# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make
24110915Sandreas.sandberg@arm.com# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
24210915Sandreas.sandberg@arm.com# (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions
24310915Sandreas.sandberg@arm.com# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
24410915Sandreas.sandberg@arm.com
24510915Sandreas.sandberg@arm.comEXTENSION_MAPPING      =
24610915Sandreas.sandberg@arm.com
24710915Sandreas.sandberg@arm.com# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
24810915Sandreas.sandberg@arm.com# to include (a tag file for) the STL sources as input, then you should
24910915Sandreas.sandberg@arm.com# set this tag to YES in order to let doxygen match functions declarations and
25010915Sandreas.sandberg@arm.com# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
25110915Sandreas.sandberg@arm.com# func(std::string) {}). This also makes the inheritance and collaboration
25210915Sandreas.sandberg@arm.com# diagrams that involve STL classes more complete and accurate.
25310915Sandreas.sandberg@arm.com
25410915Sandreas.sandberg@arm.comBUILTIN_STL_SUPPORT    = NO
25510915Sandreas.sandberg@arm.com
25610915Sandreas.sandberg@arm.com# If you use Microsoft's C++/CLI language, you should set this option to YES to
25710915Sandreas.sandberg@arm.com# enable parsing support.
25810915Sandreas.sandberg@arm.com
25910915Sandreas.sandberg@arm.comCPP_CLI_SUPPORT        = NO
26010915Sandreas.sandberg@arm.com
26110915Sandreas.sandberg@arm.com# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
26210915Sandreas.sandberg@arm.com# Doxygen will parse them like normal C++ but will assume all classes use public
26310915Sandreas.sandberg@arm.com# instead of private inheritance when no explicit protection keyword is present.
26410915Sandreas.sandberg@arm.com
26510915Sandreas.sandberg@arm.comSIP_SUPPORT            = NO
26610915Sandreas.sandberg@arm.com
26710915Sandreas.sandberg@arm.com# For Microsoft's IDL there are propget and propput attributes to indicate getter
26810915Sandreas.sandberg@arm.com# and setter methods for a property. Setting this option to YES (the default)
26910915Sandreas.sandberg@arm.com# will make doxygen replace the get and set methods by a property in the
27010915Sandreas.sandberg@arm.com# documentation. This will only work if the methods are indeed getting or
27110915Sandreas.sandberg@arm.com# setting a simple type. If this is not the case, or you want to show the
27210915Sandreas.sandberg@arm.com# methods anyway, you should set this option to NO.
27310915Sandreas.sandberg@arm.com
27410915Sandreas.sandberg@arm.comIDL_PROPERTY_SUPPORT   = YES
27510915Sandreas.sandberg@arm.com
27610915Sandreas.sandberg@arm.com# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
27710915Sandreas.sandberg@arm.com# tag is set to YES, then doxygen will reuse the documentation of the first
27810915Sandreas.sandberg@arm.com# member in the group (if any) for the other members of the group. By default
27910915Sandreas.sandberg@arm.com# all members of a group must be documented explicitly.
28010915Sandreas.sandberg@arm.com
28110915Sandreas.sandberg@arm.comDISTRIBUTE_GROUP_DOC   = NO
28210915Sandreas.sandberg@arm.com
28310915Sandreas.sandberg@arm.com# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
28410915Sandreas.sandberg@arm.com# the same type (for instance a group of public functions) to be put as a
28510915Sandreas.sandberg@arm.com# subgroup of that type (e.g. under the Public Functions section). Set it to
28610915Sandreas.sandberg@arm.com# NO to prevent subgrouping. Alternatively, this can be done per class using
28710915Sandreas.sandberg@arm.com# the \nosubgrouping command.
28810915Sandreas.sandberg@arm.com
28910915Sandreas.sandberg@arm.comSUBGROUPING            = YES
29010915Sandreas.sandberg@arm.com
29110915Sandreas.sandberg@arm.com# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and
29210915Sandreas.sandberg@arm.com# unions are shown inside the group in which they are included (e.g. using
29310915Sandreas.sandberg@arm.com# @ingroup) instead of on a separate page (for HTML and Man pages) or
29410915Sandreas.sandberg@arm.com# section (for LaTeX and RTF).
29510915Sandreas.sandberg@arm.com
29610915Sandreas.sandberg@arm.comINLINE_GROUPED_CLASSES = NO
29710915Sandreas.sandberg@arm.com
29810915Sandreas.sandberg@arm.com# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and
29910915Sandreas.sandberg@arm.com# unions with only public data fields will be shown inline in the documentation
30010915Sandreas.sandberg@arm.com# of the scope in which they are defined (i.e. file, namespace, or group
30110915Sandreas.sandberg@arm.com# documentation), provided this scope is documented. If set to NO (the default),
30210915Sandreas.sandberg@arm.com# structs, classes, and unions are shown on a separate page (for HTML and Man
30310915Sandreas.sandberg@arm.com# pages) or section (for LaTeX and RTF).
30410915Sandreas.sandberg@arm.com
30510915Sandreas.sandberg@arm.comINLINE_SIMPLE_STRUCTS  = NO
30610915Sandreas.sandberg@arm.com
30710915Sandreas.sandberg@arm.com# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
30810915Sandreas.sandberg@arm.com# is documented as struct, union, or enum with the name of the typedef. So
30910915Sandreas.sandberg@arm.com# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
31010915Sandreas.sandberg@arm.com# with name TypeT. When disabled the typedef will appear as a member of a file,
31110915Sandreas.sandberg@arm.com# namespace, or class. And the struct will be named TypeS. This can typically
31210915Sandreas.sandberg@arm.com# be useful for C code in case the coding convention dictates that all compound
31310915Sandreas.sandberg@arm.com# types are typedef'ed and only the typedef is referenced, never the tag name.
31410915Sandreas.sandberg@arm.com
31510915Sandreas.sandberg@arm.comTYPEDEF_HIDES_STRUCT   = NO
31610915Sandreas.sandberg@arm.com
31710915Sandreas.sandberg@arm.com# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
31810915Sandreas.sandberg@arm.com# determine which symbols to keep in memory and which to flush to disk.
31910915Sandreas.sandberg@arm.com# When the cache is full, less often used symbols will be written to disk.
32010915Sandreas.sandberg@arm.com# For small to medium size projects (<1000 input files) the default value is
32110915Sandreas.sandberg@arm.com# probably good enough. For larger projects a too small cache size can cause
32210915Sandreas.sandberg@arm.com# doxygen to be busy swapping symbols to and from disk most of the time
32310915Sandreas.sandberg@arm.com# causing a significant performance penalty.
32410915Sandreas.sandberg@arm.com# If the system has enough physical memory increasing the cache will improve the
32510915Sandreas.sandberg@arm.com# performance by keeping more symbols in memory. Note that the value works on
32610915Sandreas.sandberg@arm.com# a logarithmic scale so increasing the size by one will roughly double the
32710915Sandreas.sandberg@arm.com# memory usage. The cache size is given by this formula:
32810915Sandreas.sandberg@arm.com# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
32910915Sandreas.sandberg@arm.com# corresponding to a cache size of 2^16 = 65536 symbols.
33010915Sandreas.sandberg@arm.com
33110915Sandreas.sandberg@arm.comSYMBOL_CACHE_SIZE      = 0
33210915Sandreas.sandberg@arm.com
33310915Sandreas.sandberg@arm.com# Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be
33410915Sandreas.sandberg@arm.com# set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given
33510915Sandreas.sandberg@arm.com# their name and scope. Since this can be an expensive process and often the
33610915Sandreas.sandberg@arm.com# same symbol appear multiple times in the code, doxygen keeps a cache of
33710915Sandreas.sandberg@arm.com# pre-resolved symbols. If the cache is too small doxygen will become slower.
33810915Sandreas.sandberg@arm.com# If the cache is too large, memory is wasted. The cache size is given by this
33910915Sandreas.sandberg@arm.com# formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0,
34010915Sandreas.sandberg@arm.com# corresponding to a cache size of 2^16 = 65536 symbols.
34110915Sandreas.sandberg@arm.com
34210915Sandreas.sandberg@arm.comLOOKUP_CACHE_SIZE      = 0
34310915Sandreas.sandberg@arm.com
34410915Sandreas.sandberg@arm.com#---------------------------------------------------------------------------
34510915Sandreas.sandberg@arm.com# Build related configuration options
34610915Sandreas.sandberg@arm.com#---------------------------------------------------------------------------
34710915Sandreas.sandberg@arm.com
34810915Sandreas.sandberg@arm.com# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
34910915Sandreas.sandberg@arm.com# documentation are documented, even if no documentation was available.
35010915Sandreas.sandberg@arm.com# Private class members and static file members will be hidden unless
35110915Sandreas.sandberg@arm.com# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
35210915Sandreas.sandberg@arm.com
35310915Sandreas.sandberg@arm.comEXTRACT_ALL            = NO
35410915Sandreas.sandberg@arm.com
35510915Sandreas.sandberg@arm.com# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
35610915Sandreas.sandberg@arm.com# will be included in the documentation.
35710915Sandreas.sandberg@arm.com
35810915Sandreas.sandberg@arm.comEXTRACT_PRIVATE        = NO
35910915Sandreas.sandberg@arm.com
36010915Sandreas.sandberg@arm.com# If the EXTRACT_STATIC tag is set to YES all static members of a file
36110915Sandreas.sandberg@arm.com# will be included in the documentation.
36210915Sandreas.sandberg@arm.com
36310915Sandreas.sandberg@arm.comEXTRACT_STATIC         = NO
36410915Sandreas.sandberg@arm.com
36510915Sandreas.sandberg@arm.com# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
36610915Sandreas.sandberg@arm.com# defined locally in source files will be included in the documentation.
36710915Sandreas.sandberg@arm.com# If set to NO only classes defined in header files are included.
36810915Sandreas.sandberg@arm.com
36910915Sandreas.sandberg@arm.comEXTRACT_LOCAL_CLASSES  = YES
37010915Sandreas.sandberg@arm.com
37110915Sandreas.sandberg@arm.com# This flag is only useful for Objective-C code. When set to YES local
37210915Sandreas.sandberg@arm.com# methods, which are defined in the implementation section but not in
37310915Sandreas.sandberg@arm.com# the interface are included in the documentation.
37410915Sandreas.sandberg@arm.com# If set to NO (the default) only methods in the interface are included.
37510915Sandreas.sandberg@arm.com
37610915Sandreas.sandberg@arm.comEXTRACT_LOCAL_METHODS  = NO
37710915Sandreas.sandberg@arm.com
37810915Sandreas.sandberg@arm.com# If this flag is set to YES, the members of anonymous namespaces will be
37910915Sandreas.sandberg@arm.com# extracted and appear in the documentation as a namespace called
38010915Sandreas.sandberg@arm.com# 'anonymous_namespace{file}', where file will be replaced with the base
38110915Sandreas.sandberg@arm.com# name of the file that contains the anonymous namespace. By default
38210915Sandreas.sandberg@arm.com# anonymous namespaces are hidden.
38310915Sandreas.sandberg@arm.com
38410915Sandreas.sandberg@arm.comEXTRACT_ANON_NSPACES   = NO
38510915Sandreas.sandberg@arm.com
38610915Sandreas.sandberg@arm.com# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
38710915Sandreas.sandberg@arm.com# undocumented members of documented classes, files or namespaces.
38810915Sandreas.sandberg@arm.com# If set to NO (the default) these members will be included in the
38910915Sandreas.sandberg@arm.com# various overviews, but no documentation section is generated.
39010915Sandreas.sandberg@arm.com# This option has no effect if EXTRACT_ALL is enabled.
39110915Sandreas.sandberg@arm.com
39210915Sandreas.sandberg@arm.comHIDE_UNDOC_MEMBERS     = NO
39310915Sandreas.sandberg@arm.com
39410915Sandreas.sandberg@arm.com# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
39510915Sandreas.sandberg@arm.com# undocumented classes that are normally visible in the class hierarchy.
39610915Sandreas.sandberg@arm.com# If set to NO (the default) these classes will be included in the various
39710915Sandreas.sandberg@arm.com# overviews. This option has no effect if EXTRACT_ALL is enabled.
39810915Sandreas.sandberg@arm.com
39910915Sandreas.sandberg@arm.comHIDE_UNDOC_CLASSES     = NO
40010915Sandreas.sandberg@arm.com
40110915Sandreas.sandberg@arm.com# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
40210915Sandreas.sandberg@arm.com# friend (class|struct|union) declarations.
40310915Sandreas.sandberg@arm.com# If set to NO (the default) these declarations will be included in the
40410915Sandreas.sandberg@arm.com# documentation.
40510915Sandreas.sandberg@arm.com
40610915Sandreas.sandberg@arm.comHIDE_FRIEND_COMPOUNDS  = NO
40710915Sandreas.sandberg@arm.com
40810915Sandreas.sandberg@arm.com# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
40910915Sandreas.sandberg@arm.com# documentation blocks found inside the body of a function.
41010915Sandreas.sandberg@arm.com# If set to NO (the default) these blocks will be appended to the
41110915Sandreas.sandberg@arm.com# function's detailed documentation block.
41210915Sandreas.sandberg@arm.com
41310915Sandreas.sandberg@arm.comHIDE_IN_BODY_DOCS      = NO
41410915Sandreas.sandberg@arm.com
41510915Sandreas.sandberg@arm.com# The INTERNAL_DOCS tag determines if documentation
41610915Sandreas.sandberg@arm.com# that is typed after a \internal command is included. If the tag is set
41710915Sandreas.sandberg@arm.com# to NO (the default) then the documentation will be excluded.
41810915Sandreas.sandberg@arm.com# Set it to YES to include the internal documentation.
41910915Sandreas.sandberg@arm.com
42010915Sandreas.sandberg@arm.comINTERNAL_DOCS          = NO
42110915Sandreas.sandberg@arm.com
42210915Sandreas.sandberg@arm.com# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
42310915Sandreas.sandberg@arm.com# file names in lower-case letters. If set to YES upper-case letters are also
42410915Sandreas.sandberg@arm.com# allowed. This is useful if you have classes or files whose names only differ
42510915Sandreas.sandberg@arm.com# in case and if your file system supports case sensitive file names. Windows
42610915Sandreas.sandberg@arm.com# and Mac users are advised to set this option to NO.
42710915Sandreas.sandberg@arm.com
42810915Sandreas.sandberg@arm.comCASE_SENSE_NAMES       = YES
42910915Sandreas.sandberg@arm.com
43010915Sandreas.sandberg@arm.com# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
43110915Sandreas.sandberg@arm.com# will show members with their full class and namespace scopes in the
43210915Sandreas.sandberg@arm.com# documentation. If set to YES the scope will be hidden.
43310915Sandreas.sandberg@arm.com
43410915Sandreas.sandberg@arm.comHIDE_SCOPE_NAMES       = NO
43510915Sandreas.sandberg@arm.com
43610915Sandreas.sandberg@arm.com# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
43710915Sandreas.sandberg@arm.com# will put a list of the files that are included by a file in the documentation
43810915Sandreas.sandberg@arm.com# of that file.
43910915Sandreas.sandberg@arm.com
44010915Sandreas.sandberg@arm.comSHOW_INCLUDE_FILES     = YES
44110915Sandreas.sandberg@arm.com
44210915Sandreas.sandberg@arm.com# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
44310915Sandreas.sandberg@arm.com# will list include files with double quotes in the documentation
44410915Sandreas.sandberg@arm.com# rather than with sharp brackets.
44510915Sandreas.sandberg@arm.com
44610915Sandreas.sandberg@arm.comFORCE_LOCAL_INCLUDES   = NO
44710915Sandreas.sandberg@arm.com
44810915Sandreas.sandberg@arm.com# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
44910915Sandreas.sandberg@arm.com# is inserted in the documentation for inline members.
45010915Sandreas.sandberg@arm.com
45110915Sandreas.sandberg@arm.comINLINE_INFO            = YES
45210915Sandreas.sandberg@arm.com
45310915Sandreas.sandberg@arm.com# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
45410915Sandreas.sandberg@arm.com# will sort the (detailed) documentation of file and class members
45510915Sandreas.sandberg@arm.com# alphabetically by member name. If set to NO the members will appear in
45610915Sandreas.sandberg@arm.com# declaration order.
45710915Sandreas.sandberg@arm.com
45810915Sandreas.sandberg@arm.comSORT_MEMBER_DOCS       = YES
45910915Sandreas.sandberg@arm.com
46010915Sandreas.sandberg@arm.com# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
46110915Sandreas.sandberg@arm.com# brief documentation of file, namespace and class members alphabetically
46210915Sandreas.sandberg@arm.com# by member name. If set to NO (the default) the members will appear in
46310915Sandreas.sandberg@arm.com# declaration order.
46410915Sandreas.sandberg@arm.com
46510915Sandreas.sandberg@arm.comSORT_BRIEF_DOCS        = NO
46610915Sandreas.sandberg@arm.com
46710915Sandreas.sandberg@arm.com# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
46810915Sandreas.sandberg@arm.com# will sort the (brief and detailed) documentation of class members so that
46910915Sandreas.sandberg@arm.com# constructors and destructors are listed first. If set to NO (the default)
47010915Sandreas.sandberg@arm.com# the constructors will appear in the respective orders defined by
47110915Sandreas.sandberg@arm.com# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
47210915Sandreas.sandberg@arm.com# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
47310915Sandreas.sandberg@arm.com# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
47410915Sandreas.sandberg@arm.com
47510915Sandreas.sandberg@arm.comSORT_MEMBERS_CTORS_1ST = NO
47610915Sandreas.sandberg@arm.com
47710915Sandreas.sandberg@arm.com# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
47810915Sandreas.sandberg@arm.com# hierarchy of group names into alphabetical order. If set to NO (the default)
47910915Sandreas.sandberg@arm.com# the group names will appear in their defined order.
48010915Sandreas.sandberg@arm.com
48110915Sandreas.sandberg@arm.comSORT_GROUP_NAMES       = NO
48210915Sandreas.sandberg@arm.com
48310915Sandreas.sandberg@arm.com# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
48410915Sandreas.sandberg@arm.com# sorted by fully-qualified names, including namespaces. If set to
48510915Sandreas.sandberg@arm.com# NO (the default), the class list will be sorted only by class name,
48610915Sandreas.sandberg@arm.com# not including the namespace part.
48710915Sandreas.sandberg@arm.com# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
48810915Sandreas.sandberg@arm.com# Note: This option applies only to the class list, not to the
48910915Sandreas.sandberg@arm.com# alphabetical list.
49010915Sandreas.sandberg@arm.com
49110915Sandreas.sandberg@arm.comSORT_BY_SCOPE_NAME     = NO
49210915Sandreas.sandberg@arm.com
49310915Sandreas.sandberg@arm.com# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to
49410915Sandreas.sandberg@arm.com# do proper type resolution of all parameters of a function it will reject a
49510915Sandreas.sandberg@arm.com# match between the prototype and the implementation of a member function even
49610915Sandreas.sandberg@arm.com# if there is only one candidate or it is obvious which candidate to choose
49710915Sandreas.sandberg@arm.com# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen
49810915Sandreas.sandberg@arm.com# will still accept a match between prototype and implementation in such cases.
49910915Sandreas.sandberg@arm.com
50010915Sandreas.sandberg@arm.comSTRICT_PROTO_MATCHING  = NO
50110915Sandreas.sandberg@arm.com
50210915Sandreas.sandberg@arm.com# The GENERATE_TODOLIST tag can be used to enable (YES) or
50310915Sandreas.sandberg@arm.com# disable (NO) the todo list. This list is created by putting \todo
50410915Sandreas.sandberg@arm.com# commands in the documentation.
50510915Sandreas.sandberg@arm.com
50610915Sandreas.sandberg@arm.comGENERATE_TODOLIST      = YES
50710915Sandreas.sandberg@arm.com
50810915Sandreas.sandberg@arm.com# The GENERATE_TESTLIST tag can be used to enable (YES) or
50910915Sandreas.sandberg@arm.com# disable (NO) the test list. This list is created by putting \test
51010915Sandreas.sandberg@arm.com# commands in the documentation.
51110915Sandreas.sandberg@arm.com
51210915Sandreas.sandberg@arm.comGENERATE_TESTLIST      = YES
51310915Sandreas.sandberg@arm.com
51410915Sandreas.sandberg@arm.com# The GENERATE_BUGLIST tag can be used to enable (YES) or
51510915Sandreas.sandberg@arm.com# disable (NO) the bug list. This list is created by putting \bug
51610915Sandreas.sandberg@arm.com# commands in the documentation.
51710915Sandreas.sandberg@arm.com
51810915Sandreas.sandberg@arm.comGENERATE_BUGLIST       = YES
51910915Sandreas.sandberg@arm.com
52010915Sandreas.sandberg@arm.com# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
52110915Sandreas.sandberg@arm.com# disable (NO) the deprecated list. This list is created by putting
52210915Sandreas.sandberg@arm.com# \deprecated commands in the documentation.
52310915Sandreas.sandberg@arm.com
52410915Sandreas.sandberg@arm.comGENERATE_DEPRECATEDLIST= YES
52510915Sandreas.sandberg@arm.com
52610915Sandreas.sandberg@arm.com# The ENABLED_SECTIONS tag can be used to enable conditional
52710915Sandreas.sandberg@arm.com# documentation sections, marked by \if sectionname ... \endif.
52810915Sandreas.sandberg@arm.com
52910915Sandreas.sandberg@arm.comENABLED_SECTIONS       =
53010915Sandreas.sandberg@arm.com
53110915Sandreas.sandberg@arm.com# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
53210915Sandreas.sandberg@arm.com# the initial value of a variable or macro consists of for it to appear in
53310915Sandreas.sandberg@arm.com# the documentation. If the initializer consists of more lines than specified
53410915Sandreas.sandberg@arm.com# here it will be hidden. Use a value of 0 to hide initializers completely.
53510915Sandreas.sandberg@arm.com# The appearance of the initializer of individual variables and macros in the
53610915Sandreas.sandberg@arm.com# documentation can be controlled using \showinitializer or \hideinitializer
53710915Sandreas.sandberg@arm.com# command in the documentation regardless of this setting.
53810915Sandreas.sandberg@arm.com
53910915Sandreas.sandberg@arm.comMAX_INITIALIZER_LINES  = 30
54010915Sandreas.sandberg@arm.com
54110915Sandreas.sandberg@arm.com# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
54210915Sandreas.sandberg@arm.com# at the bottom of the documentation of classes and structs. If set to YES the
54310915Sandreas.sandberg@arm.com# list will mention the files that were used to generate the documentation.
54410915Sandreas.sandberg@arm.com
54510915Sandreas.sandberg@arm.comSHOW_USED_FILES        = YES
54610915Sandreas.sandberg@arm.com
54710915Sandreas.sandberg@arm.com# If the sources in your project are distributed over multiple directories
54810915Sandreas.sandberg@arm.com# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
54910915Sandreas.sandberg@arm.com# in the documentation. The default is NO.
55010915Sandreas.sandberg@arm.com
55110915Sandreas.sandberg@arm.comSHOW_DIRECTORIES       = NO
55210915Sandreas.sandberg@arm.com
55310915Sandreas.sandberg@arm.com# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
55410915Sandreas.sandberg@arm.com# This will remove the Files entry from the Quick Index and from the
55510915Sandreas.sandberg@arm.com# Folder Tree View (if specified). The default is YES.
55610915Sandreas.sandberg@arm.com
55710915Sandreas.sandberg@arm.comSHOW_FILES             = YES
55810915Sandreas.sandberg@arm.com
55910915Sandreas.sandberg@arm.com# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
56010915Sandreas.sandberg@arm.com# Namespaces page.
56110915Sandreas.sandberg@arm.com# This will remove the Namespaces entry from the Quick Index
56210915Sandreas.sandberg@arm.com# and from the Folder Tree View (if specified). The default is YES.
56310915Sandreas.sandberg@arm.com
56410915Sandreas.sandberg@arm.comSHOW_NAMESPACES        = YES
56510915Sandreas.sandberg@arm.com
56610915Sandreas.sandberg@arm.com# The FILE_VERSION_FILTER tag can be used to specify a program or script that
56710915Sandreas.sandberg@arm.com# doxygen should invoke to get the current version for each file (typically from
56810915Sandreas.sandberg@arm.com# the version control system). Doxygen will invoke the program by executing (via
56910915Sandreas.sandberg@arm.com# popen()) the command <command> <input-file>, where <command> is the value of
57010915Sandreas.sandberg@arm.com# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
57110915Sandreas.sandberg@arm.com# provided by doxygen. Whatever the program writes to standard output
57210915Sandreas.sandberg@arm.com# is used as the file version. See the manual for examples.
57310915Sandreas.sandberg@arm.com
57410915Sandreas.sandberg@arm.comFILE_VERSION_FILTER    =
57510915Sandreas.sandberg@arm.com
57610915Sandreas.sandberg@arm.com# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
57710915Sandreas.sandberg@arm.com# by doxygen. The layout file controls the global structure of the generated
57810915Sandreas.sandberg@arm.com# output files in an output format independent way. The create the layout file
57910915Sandreas.sandberg@arm.com# that represents doxygen's defaults, run doxygen with the -l option.
58010915Sandreas.sandberg@arm.com# You can optionally specify a file name after the option, if omitted
58110915Sandreas.sandberg@arm.com# DoxygenLayout.xml will be used as the name of the layout file.
58210915Sandreas.sandberg@arm.com
58310915Sandreas.sandberg@arm.comLAYOUT_FILE            =
58410915Sandreas.sandberg@arm.com
58510915Sandreas.sandberg@arm.com# The CITE_BIB_FILES tag can be used to specify one or more bib files
58610915Sandreas.sandberg@arm.com# containing the references data. This must be a list of .bib files. The
58710915Sandreas.sandberg@arm.com# .bib extension is automatically appended if omitted. Using this command
58810915Sandreas.sandberg@arm.com# requires the bibtex tool to be installed. See also
58910915Sandreas.sandberg@arm.com# http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style
59010915Sandreas.sandberg@arm.com# of the bibliography can be controlled using LATEX_BIB_STYLE. To use this
59110915Sandreas.sandberg@arm.com# feature you need bibtex and perl available in the search path.
59210915Sandreas.sandberg@arm.com
59310915Sandreas.sandberg@arm.comCITE_BIB_FILES         =
59410915Sandreas.sandberg@arm.com
59510915Sandreas.sandberg@arm.com#---------------------------------------------------------------------------
59610915Sandreas.sandberg@arm.com# configuration options related to warning and progress messages
59710915Sandreas.sandberg@arm.com#---------------------------------------------------------------------------
59810915Sandreas.sandberg@arm.com
59910915Sandreas.sandberg@arm.com# The QUIET tag can be used to turn on/off the messages that are generated
60010915Sandreas.sandberg@arm.com# by doxygen. Possible values are YES and NO. If left blank NO is used.
60110915Sandreas.sandberg@arm.com
60210915Sandreas.sandberg@arm.comQUIET                  = NO
60310915Sandreas.sandberg@arm.com
60410915Sandreas.sandberg@arm.com# The WARNINGS tag can be used to turn on/off the warning messages that are
60510915Sandreas.sandberg@arm.com# generated by doxygen. Possible values are YES and NO. If left blank
60610915Sandreas.sandberg@arm.com# NO is used.
60710915Sandreas.sandberg@arm.com
60810915Sandreas.sandberg@arm.comWARNINGS               = YES
60910915Sandreas.sandberg@arm.com
61010915Sandreas.sandberg@arm.com# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
61110915Sandreas.sandberg@arm.com# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
61210915Sandreas.sandberg@arm.com# automatically be disabled.
61310915Sandreas.sandberg@arm.com
61410915Sandreas.sandberg@arm.comWARN_IF_UNDOCUMENTED   = NO
61510915Sandreas.sandberg@arm.com
61610915Sandreas.sandberg@arm.com# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
61710915Sandreas.sandberg@arm.com# potential errors in the documentation, such as not documenting some
61810915Sandreas.sandberg@arm.com# parameters in a documented function, or documenting parameters that
61910915Sandreas.sandberg@arm.com# don't exist or using markup commands wrongly.
62010915Sandreas.sandberg@arm.com
62110915Sandreas.sandberg@arm.comWARN_IF_DOC_ERROR      = YES
62210915Sandreas.sandberg@arm.com
62310915Sandreas.sandberg@arm.com# The WARN_NO_PARAMDOC option can be enabled to get warnings for
62410915Sandreas.sandberg@arm.com# functions that are documented, but have no documentation for their parameters
62510915Sandreas.sandberg@arm.com# or return value. If set to NO (the default) doxygen will only warn about
62610915Sandreas.sandberg@arm.com# wrong or incomplete parameter documentation, but not about the absence of
62710915Sandreas.sandberg@arm.com# documentation.
62810915Sandreas.sandberg@arm.com
62910915Sandreas.sandberg@arm.comWARN_NO_PARAMDOC       = NO
63010915Sandreas.sandberg@arm.com
63110915Sandreas.sandberg@arm.com# The WARN_FORMAT tag determines the format of the warning messages that
63210915Sandreas.sandberg@arm.com# doxygen can produce. The string should contain the $file, $line, and $text
63310915Sandreas.sandberg@arm.com# tags, which will be replaced by the file and line number from which the
63410915Sandreas.sandberg@arm.com# warning originated and the warning text. Optionally the format may contain
63510915Sandreas.sandberg@arm.com# $version, which will be replaced by the version of the file (if it could
63610915Sandreas.sandberg@arm.com# be obtained via FILE_VERSION_FILTER)
63710915Sandreas.sandberg@arm.com
63810915Sandreas.sandberg@arm.comWARN_FORMAT            = "$file:$line: $text"
63910915Sandreas.sandberg@arm.com
64010915Sandreas.sandberg@arm.com# The WARN_LOGFILE tag can be used to specify a file to which warning
64110915Sandreas.sandberg@arm.com# and error messages should be written. If left blank the output is written
64210915Sandreas.sandberg@arm.com# to stderr.
64310915Sandreas.sandberg@arm.com
64410915Sandreas.sandberg@arm.comWARN_LOGFILE           =
64510915Sandreas.sandberg@arm.com
64610915Sandreas.sandberg@arm.com#---------------------------------------------------------------------------
64710915Sandreas.sandberg@arm.com# configuration options related to the input files
64810915Sandreas.sandberg@arm.com#---------------------------------------------------------------------------
64910915Sandreas.sandberg@arm.com
65010915Sandreas.sandberg@arm.com# The INPUT tag can be used to specify the files and/or directories that contain
65110915Sandreas.sandberg@arm.com# documented source files. You may enter file names like "myfile.cpp" or
65210915Sandreas.sandberg@arm.com# directories like "/usr/src/myproject". Separate the files or directories
65310915Sandreas.sandberg@arm.com# with spaces.
65410915Sandreas.sandberg@arm.com
65510915Sandreas.sandberg@arm.comINPUT                  = include/ lib/
65610915Sandreas.sandberg@arm.com
65710915Sandreas.sandberg@arm.com# This tag can be used to specify the character encoding of the source files
65810915Sandreas.sandberg@arm.com# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
65910915Sandreas.sandberg@arm.com# also the default input encoding. Doxygen uses libiconv (or the iconv built
66010915Sandreas.sandberg@arm.com# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
66110915Sandreas.sandberg@arm.com# the list of possible encodings.
66210915Sandreas.sandberg@arm.com
66310915Sandreas.sandberg@arm.comINPUT_ENCODING         = UTF-8
66410915Sandreas.sandberg@arm.com
66510915Sandreas.sandberg@arm.com# If the value of the INPUT tag contains directories, you can use the
66610915Sandreas.sandberg@arm.com# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
66710915Sandreas.sandberg@arm.com# and *.h) to filter out the source-files in the directories. If left
66810915Sandreas.sandberg@arm.com# blank the following patterns are tested:
66910915Sandreas.sandberg@arm.com# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh
67010915Sandreas.sandberg@arm.com# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
67110915Sandreas.sandberg@arm.com# *.f90 *.f *.for *.vhd *.vhdl
67210915Sandreas.sandberg@arm.com
67310915Sandreas.sandberg@arm.comFILE_PATTERNS          =
67410915Sandreas.sandberg@arm.com
67510915Sandreas.sandberg@arm.com# The RECURSIVE tag can be used to turn specify whether or not subdirectories
67610915Sandreas.sandberg@arm.com# should be searched for input files as well. Possible values are YES and NO.
67710915Sandreas.sandberg@arm.com# If left blank NO is used.
67810915Sandreas.sandberg@arm.com
67910915Sandreas.sandberg@arm.comRECURSIVE              = YES
68010915Sandreas.sandberg@arm.com
68110915Sandreas.sandberg@arm.com# The EXCLUDE tag can be used to specify files and/or directories that should be
68210915Sandreas.sandberg@arm.com# excluded from the INPUT source files. This way you can easily exclude a
68310915Sandreas.sandberg@arm.com# subdirectory from a directory tree whose root is specified with the INPUT tag.
68410915Sandreas.sandberg@arm.com# Note that relative paths are relative to the directory from which doxygen is
68510915Sandreas.sandberg@arm.com# run.
68610915Sandreas.sandberg@arm.com
68710915Sandreas.sandberg@arm.comEXCLUDE                =
68810915Sandreas.sandberg@arm.com
68910915Sandreas.sandberg@arm.com# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
69010915Sandreas.sandberg@arm.com# directories that are symbolic links (a Unix file system feature) are excluded
69110915Sandreas.sandberg@arm.com# from the input.
69210915Sandreas.sandberg@arm.com
69310915Sandreas.sandberg@arm.comEXCLUDE_SYMLINKS       = NO
69410915Sandreas.sandberg@arm.com
69510915Sandreas.sandberg@arm.com# If the value of the INPUT tag contains directories, you can use the
69610915Sandreas.sandberg@arm.com# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
69710915Sandreas.sandberg@arm.com# certain files from those directories. Note that the wildcards are matched
69810915Sandreas.sandberg@arm.com# against the file with absolute path, so to exclude all test directories
69910915Sandreas.sandberg@arm.com# for example use the pattern */test/*
70010915Sandreas.sandberg@arm.com
70110915Sandreas.sandberg@arm.comEXCLUDE_PATTERNS       =
70210915Sandreas.sandberg@arm.com
70310915Sandreas.sandberg@arm.com# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
70410915Sandreas.sandberg@arm.com# (namespaces, classes, functions, etc.) that should be excluded from the
70510915Sandreas.sandberg@arm.com# output. The symbol name can be a fully qualified name, a word, or if the
70610915Sandreas.sandberg@arm.com# wildcard * is used, a substring. Examples: ANamespace, AClass,
70710915Sandreas.sandberg@arm.com# AClass::ANamespace, ANamespace::*Test
70810915Sandreas.sandberg@arm.com
70910915Sandreas.sandberg@arm.comEXCLUDE_SYMBOLS        =
71010915Sandreas.sandberg@arm.com
71110915Sandreas.sandberg@arm.com# The EXAMPLE_PATH tag can be used to specify one or more files or
71210915Sandreas.sandberg@arm.com# directories that contain example code fragments that are included (see
71310915Sandreas.sandberg@arm.com# the \include command).
71410915Sandreas.sandberg@arm.com
71510915Sandreas.sandberg@arm.comEXAMPLE_PATH           =
71610915Sandreas.sandberg@arm.com
71710915Sandreas.sandberg@arm.com# If the value of the EXAMPLE_PATH tag contains directories, you can use the
71810915Sandreas.sandberg@arm.com# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
71910915Sandreas.sandberg@arm.com# and *.h) to filter out the source-files in the directories. If left
72010915Sandreas.sandberg@arm.com# blank all files are included.
72110915Sandreas.sandberg@arm.com
72210915Sandreas.sandberg@arm.comEXAMPLE_PATTERNS       =
72310915Sandreas.sandberg@arm.com
72410915Sandreas.sandberg@arm.com# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
72510915Sandreas.sandberg@arm.com# searched for input files to be used with the \include or \dontinclude
72610915Sandreas.sandberg@arm.com# commands irrespective of the value of the RECURSIVE tag.
72710915Sandreas.sandberg@arm.com# Possible values are YES and NO. If left blank NO is used.
72810915Sandreas.sandberg@arm.com
72910915Sandreas.sandberg@arm.comEXAMPLE_RECURSIVE      = NO
73010915Sandreas.sandberg@arm.com
73110915Sandreas.sandberg@arm.com# The IMAGE_PATH tag can be used to specify one or more files or
73210915Sandreas.sandberg@arm.com# directories that contain image that are included in the documentation (see
73310915Sandreas.sandberg@arm.com# the \image command).
73410915Sandreas.sandberg@arm.com
73510915Sandreas.sandberg@arm.comIMAGE_PATH             =
73610915Sandreas.sandberg@arm.com
73710915Sandreas.sandberg@arm.com# The INPUT_FILTER tag can be used to specify a program that doxygen should
73810915Sandreas.sandberg@arm.com# invoke to filter for each input file. Doxygen will invoke the filter program
73910915Sandreas.sandberg@arm.com# by executing (via popen()) the command <filter> <input-file>, where <filter>
74010915Sandreas.sandberg@arm.com# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
74110915Sandreas.sandberg@arm.com# input file. Doxygen will then use the output that the filter program writes
74210915Sandreas.sandberg@arm.com# to standard output.
74310915Sandreas.sandberg@arm.com# If FILTER_PATTERNS is specified, this tag will be
74410915Sandreas.sandberg@arm.com# ignored.
74510915Sandreas.sandberg@arm.com
74610915Sandreas.sandberg@arm.comINPUT_FILTER           = ./doxygen.sed
74710915Sandreas.sandberg@arm.com
74810915Sandreas.sandberg@arm.com# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
74910915Sandreas.sandberg@arm.com# basis.
75010915Sandreas.sandberg@arm.com# Doxygen will compare the file name with each pattern and apply the
75110915Sandreas.sandberg@arm.com# filter if there is a match.
75210915Sandreas.sandberg@arm.com# The filters are a list of the form:
75310915Sandreas.sandberg@arm.com# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
75410915Sandreas.sandberg@arm.com# info on how filters are used. If FILTER_PATTERNS is empty or if
75510915Sandreas.sandberg@arm.com# non of the patterns match the file name, INPUT_FILTER is applied.
75610915Sandreas.sandberg@arm.com
75710915Sandreas.sandberg@arm.comFILTER_PATTERNS        =
75810915Sandreas.sandberg@arm.com
75910915Sandreas.sandberg@arm.com# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
76010915Sandreas.sandberg@arm.com# INPUT_FILTER) will be used to filter the input files when producing source
76110915Sandreas.sandberg@arm.com# files to browse (i.e. when SOURCE_BROWSER is set to YES).
76210915Sandreas.sandberg@arm.com
76310915Sandreas.sandberg@arm.comFILTER_SOURCE_FILES    = NO
76410915Sandreas.sandberg@arm.com
76510915Sandreas.sandberg@arm.com# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
76610915Sandreas.sandberg@arm.com# pattern. A pattern will override the setting for FILTER_PATTERN (if any)
76710915Sandreas.sandberg@arm.com# and it is also possible to disable source filtering for a specific pattern
76810915Sandreas.sandberg@arm.com# using *.ext= (so without naming a filter). This option only has effect when
76910915Sandreas.sandberg@arm.com# FILTER_SOURCE_FILES is enabled.
77010915Sandreas.sandberg@arm.com
77110915Sandreas.sandberg@arm.comFILTER_SOURCE_PATTERNS =
77210915Sandreas.sandberg@arm.com
77310915Sandreas.sandberg@arm.com#---------------------------------------------------------------------------
77410915Sandreas.sandberg@arm.com# configuration options related to source browsing
77510915Sandreas.sandberg@arm.com#---------------------------------------------------------------------------
77610915Sandreas.sandberg@arm.com
77710915Sandreas.sandberg@arm.com# If the SOURCE_BROWSER tag is set to YES then a list of source files will
77810915Sandreas.sandberg@arm.com# be generated. Documented entities will be cross-referenced with these sources.
77910915Sandreas.sandberg@arm.com# Note: To get rid of all source code in the generated output, make sure also
78010915Sandreas.sandberg@arm.com# VERBATIM_HEADERS is set to NO.
78110915Sandreas.sandberg@arm.com
78210915Sandreas.sandberg@arm.comSOURCE_BROWSER         = NO
78310915Sandreas.sandberg@arm.com
78410915Sandreas.sandberg@arm.com# Setting the INLINE_SOURCES tag to YES will include the body
78510915Sandreas.sandberg@arm.com# of functions and classes directly in the documentation.
78610915Sandreas.sandberg@arm.com
78710915Sandreas.sandberg@arm.comINLINE_SOURCES         = NO
78810915Sandreas.sandberg@arm.com
78910915Sandreas.sandberg@arm.com# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
79010915Sandreas.sandberg@arm.com# doxygen to hide any special comment blocks from generated source code
79110915Sandreas.sandberg@arm.com# fragments. Normal C and C++ comments will always remain visible.
79210915Sandreas.sandberg@arm.com
79310915Sandreas.sandberg@arm.comSTRIP_CODE_COMMENTS    = YES
79410915Sandreas.sandberg@arm.com
79510915Sandreas.sandberg@arm.com# If the REFERENCED_BY_RELATION tag is set to YES
79610915Sandreas.sandberg@arm.com# then for each documented function all documented
79710915Sandreas.sandberg@arm.com# functions referencing it will be listed.
79810915Sandreas.sandberg@arm.com
79910915Sandreas.sandberg@arm.comREFERENCED_BY_RELATION = NO
80010915Sandreas.sandberg@arm.com
80110915Sandreas.sandberg@arm.com# If the REFERENCES_RELATION tag is set to YES
80210915Sandreas.sandberg@arm.com# then for each documented function all documented entities
80310915Sandreas.sandberg@arm.com# called/used by that function will be listed.
80410915Sandreas.sandberg@arm.com
80510915Sandreas.sandberg@arm.comREFERENCES_RELATION    = NO
80610915Sandreas.sandberg@arm.com
80710915Sandreas.sandberg@arm.com# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
80810915Sandreas.sandberg@arm.com# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
80910915Sandreas.sandberg@arm.com# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
81010915Sandreas.sandberg@arm.com# link to the source code.
81110915Sandreas.sandberg@arm.com# Otherwise they will link to the documentation.
81210915Sandreas.sandberg@arm.com
81310915Sandreas.sandberg@arm.comREFERENCES_LINK_SOURCE = YES
81410915Sandreas.sandberg@arm.com
81510915Sandreas.sandberg@arm.com# If the USE_HTAGS tag is set to YES then the references to source code
81610915Sandreas.sandberg@arm.com# will point to the HTML generated by the htags(1) tool instead of doxygen
81710915Sandreas.sandberg@arm.com# built-in source browser. The htags tool is part of GNU's global source
81810915Sandreas.sandberg@arm.com# tagging system (see http://www.gnu.org/software/global/global.html). You
81910915Sandreas.sandberg@arm.com# will need version 4.8.6 or higher.
82010915Sandreas.sandberg@arm.com
82110915Sandreas.sandberg@arm.comUSE_HTAGS              = NO
82210915Sandreas.sandberg@arm.com
82310915Sandreas.sandberg@arm.com# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
82410915Sandreas.sandberg@arm.com# will generate a verbatim copy of the header file for each class for
82510915Sandreas.sandberg@arm.com# which an include is specified. Set to NO to disable this.
82610915Sandreas.sandberg@arm.com
82710915Sandreas.sandberg@arm.comVERBATIM_HEADERS       = YES
82810915Sandreas.sandberg@arm.com
82910915Sandreas.sandberg@arm.com#---------------------------------------------------------------------------
83010915Sandreas.sandberg@arm.com# configuration options related to the alphabetical class index
83110915Sandreas.sandberg@arm.com#---------------------------------------------------------------------------
83210915Sandreas.sandberg@arm.com
83310915Sandreas.sandberg@arm.com# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
83410915Sandreas.sandberg@arm.com# of all compounds will be generated. Enable this if the project
83510915Sandreas.sandberg@arm.com# contains a lot of classes, structs, unions or interfaces.
83610915Sandreas.sandberg@arm.com
83710915Sandreas.sandberg@arm.comALPHABETICAL_INDEX     = YES
83810915Sandreas.sandberg@arm.com
83910915Sandreas.sandberg@arm.com# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
84010915Sandreas.sandberg@arm.com# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
84110915Sandreas.sandberg@arm.com# in which this list will be split (can be a number in the range [1..20])
84210915Sandreas.sandberg@arm.com
84310915Sandreas.sandberg@arm.comCOLS_IN_ALPHA_INDEX    = 5
84410915Sandreas.sandberg@arm.com
84510915Sandreas.sandberg@arm.com# In case all classes in a project start with a common prefix, all
84610915Sandreas.sandberg@arm.com# classes will be put under the same header in the alphabetical index.
84710915Sandreas.sandberg@arm.com# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
84810915Sandreas.sandberg@arm.com# should be ignored while generating the index headers.
84910915Sandreas.sandberg@arm.com
85010915Sandreas.sandberg@arm.comIGNORE_PREFIX          =
85110915Sandreas.sandberg@arm.com
85210915Sandreas.sandberg@arm.com#---------------------------------------------------------------------------
85310915Sandreas.sandberg@arm.com# configuration options related to the HTML output
85410915Sandreas.sandberg@arm.com#---------------------------------------------------------------------------
85510915Sandreas.sandberg@arm.com
85610915Sandreas.sandberg@arm.com# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
85710915Sandreas.sandberg@arm.com# generate HTML output.
85810915Sandreas.sandberg@arm.com
85910915Sandreas.sandberg@arm.comGENERATE_HTML          = YES
86010915Sandreas.sandberg@arm.com
86110915Sandreas.sandberg@arm.com# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
86210915Sandreas.sandberg@arm.com# If a relative path is entered the value of OUTPUT_DIRECTORY will be
86310915Sandreas.sandberg@arm.com# put in front of it. If left blank `html' will be used as the default path.
86410915Sandreas.sandberg@arm.com
86510915Sandreas.sandberg@arm.comHTML_OUTPUT            = html
86610915Sandreas.sandberg@arm.com
86710915Sandreas.sandberg@arm.com# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
86810915Sandreas.sandberg@arm.com# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
86910915Sandreas.sandberg@arm.com# doxygen will generate files with .html extension.
87010915Sandreas.sandberg@arm.com
87110915Sandreas.sandberg@arm.comHTML_FILE_EXTENSION    = .html
87210915Sandreas.sandberg@arm.com
87310915Sandreas.sandberg@arm.com# The HTML_HEADER tag can be used to specify a personal HTML header for
87410915Sandreas.sandberg@arm.com# each generated HTML page. If it is left blank doxygen will generate a
87510915Sandreas.sandberg@arm.com# standard header. Note that when using a custom header you are responsible
87610915Sandreas.sandberg@arm.com#  for the proper inclusion of any scripts and style sheets that doxygen
87710915Sandreas.sandberg@arm.com# needs, which is dependent on the configuration options used.
87810915Sandreas.sandberg@arm.com# It is advised to generate a default header using "doxygen -w html
87910915Sandreas.sandberg@arm.com# header.html footer.html stylesheet.css YourConfigFile" and then modify
88010915Sandreas.sandberg@arm.com# that header. Note that the header is subject to change so you typically
88110915Sandreas.sandberg@arm.com# have to redo this when upgrading to a newer version of doxygen or when
88210915Sandreas.sandberg@arm.com# changing the value of configuration settings such as GENERATE_TREEVIEW!
88310915Sandreas.sandberg@arm.com
88410915Sandreas.sandberg@arm.comHTML_HEADER            =
88510915Sandreas.sandberg@arm.com
88610915Sandreas.sandberg@arm.com# The HTML_FOOTER tag can be used to specify a personal HTML footer for
88710915Sandreas.sandberg@arm.com# each generated HTML page. If it is left blank doxygen will generate a
88810915Sandreas.sandberg@arm.com# standard footer.
88910915Sandreas.sandberg@arm.com
89010915Sandreas.sandberg@arm.comHTML_FOOTER            =
89110915Sandreas.sandberg@arm.com
89210915Sandreas.sandberg@arm.com# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
89310915Sandreas.sandberg@arm.com# style sheet that is used by each HTML page. It can be used to
89410915Sandreas.sandberg@arm.com# fine-tune the look of the HTML output. If the tag is left blank doxygen
89510915Sandreas.sandberg@arm.com# will generate a default style sheet. Note that doxygen will try to copy
89610915Sandreas.sandberg@arm.com# the style sheet file to the HTML output directory, so don't put your own
89710915Sandreas.sandberg@arm.com# style sheet in the HTML output directory as well, or it will be erased!
89810915Sandreas.sandberg@arm.com
89910915Sandreas.sandberg@arm.comHTML_STYLESHEET        =
90010915Sandreas.sandberg@arm.com
90110915Sandreas.sandberg@arm.com# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
90210915Sandreas.sandberg@arm.com# other source files which should be copied to the HTML output directory. Note
90310915Sandreas.sandberg@arm.com# that these files will be copied to the base HTML output directory. Use the
90410915Sandreas.sandberg@arm.com# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
90510915Sandreas.sandberg@arm.com# files. In the HTML_STYLESHEET file, use the file name only. Also note that
90610915Sandreas.sandberg@arm.com# the files will be copied as-is; there are no commands or markers available.
90710915Sandreas.sandberg@arm.com
90810915Sandreas.sandberg@arm.comHTML_EXTRA_FILES       =
90910915Sandreas.sandberg@arm.com
91010915Sandreas.sandberg@arm.com# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
91110915Sandreas.sandberg@arm.com# Doxygen will adjust the colors in the style sheet and background images
91210915Sandreas.sandberg@arm.com# according to this color. Hue is specified as an angle on a colorwheel,
91310915Sandreas.sandberg@arm.com# see http://en.wikipedia.org/wiki/Hue for more information.
91410915Sandreas.sandberg@arm.com# For instance the value 0 represents red, 60 is yellow, 120 is green,
91510915Sandreas.sandberg@arm.com# 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
91610915Sandreas.sandberg@arm.com# The allowed range is 0 to 359.
91710915Sandreas.sandberg@arm.com
91810915Sandreas.sandberg@arm.comHTML_COLORSTYLE_HUE    = 220
91910915Sandreas.sandberg@arm.com
92010915Sandreas.sandberg@arm.com# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
92110915Sandreas.sandberg@arm.com# the colors in the HTML output. For a value of 0 the output will use
92210915Sandreas.sandberg@arm.com# grayscales only. A value of 255 will produce the most vivid colors.
92310915Sandreas.sandberg@arm.com
92410915Sandreas.sandberg@arm.comHTML_COLORSTYLE_SAT    = 100
92510915Sandreas.sandberg@arm.com
92610915Sandreas.sandberg@arm.com# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
92710915Sandreas.sandberg@arm.com# the luminance component of the colors in the HTML output. Values below
92810915Sandreas.sandberg@arm.com# 100 gradually make the output lighter, whereas values above 100 make
92910915Sandreas.sandberg@arm.com# the output darker. The value divided by 100 is the actual gamma applied,
93010915Sandreas.sandberg@arm.com# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
93110915Sandreas.sandberg@arm.com# and 100 does not change the gamma.
93210915Sandreas.sandberg@arm.com
93310915Sandreas.sandberg@arm.comHTML_COLORSTYLE_GAMMA  = 80
93410915Sandreas.sandberg@arm.com
93510915Sandreas.sandberg@arm.com# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
93610915Sandreas.sandberg@arm.com# page will contain the date and time when the page was generated. Setting
93710915Sandreas.sandberg@arm.com# this to NO can help when comparing the output of multiple runs.
93810915Sandreas.sandberg@arm.com
93910915Sandreas.sandberg@arm.comHTML_TIMESTAMP         = YES
94010915Sandreas.sandberg@arm.com
94110915Sandreas.sandberg@arm.com# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
94210915Sandreas.sandberg@arm.com# files or namespaces will be aligned in HTML using tables. If set to
94310915Sandreas.sandberg@arm.com# NO a bullet list will be used.
94410915Sandreas.sandberg@arm.com
94510915Sandreas.sandberg@arm.comHTML_ALIGN_MEMBERS     = YES
94610915Sandreas.sandberg@arm.com
94710915Sandreas.sandberg@arm.com# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
94810915Sandreas.sandberg@arm.com# documentation will contain sections that can be hidden and shown after the
94910915Sandreas.sandberg@arm.com# page has loaded. For this to work a browser that supports
95010915Sandreas.sandberg@arm.com# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
95110915Sandreas.sandberg@arm.com# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
95210915Sandreas.sandberg@arm.com
95310915Sandreas.sandberg@arm.comHTML_DYNAMIC_SECTIONS  = NO
95410915Sandreas.sandberg@arm.com
95510915Sandreas.sandberg@arm.com# If the GENERATE_DOCSET tag is set to YES, additional index files
95610915Sandreas.sandberg@arm.com# will be generated that can be used as input for Apple's Xcode 3
95710915Sandreas.sandberg@arm.com# integrated development environment, introduced with OSX 10.5 (Leopard).
95810915Sandreas.sandberg@arm.com# To create a documentation set, doxygen will generate a Makefile in the
95910915Sandreas.sandberg@arm.com# HTML output directory. Running make will produce the docset in that
96010915Sandreas.sandberg@arm.com# directory and running "make install" will install the docset in
96110915Sandreas.sandberg@arm.com# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
96210915Sandreas.sandberg@arm.com# it at startup.
96310915Sandreas.sandberg@arm.com# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
96410915Sandreas.sandberg@arm.com# for more information.
96510915Sandreas.sandberg@arm.com
96610915Sandreas.sandberg@arm.comGENERATE_DOCSET        = NO
96710915Sandreas.sandberg@arm.com
96810915Sandreas.sandberg@arm.com# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
96910915Sandreas.sandberg@arm.com# feed. A documentation feed provides an umbrella under which multiple
97010915Sandreas.sandberg@arm.com# documentation sets from a single provider (such as a company or product suite)
97110915Sandreas.sandberg@arm.com# can be grouped.
97210915Sandreas.sandberg@arm.com
97310915Sandreas.sandberg@arm.comDOCSET_FEEDNAME        = "Doxygen generated docs"
97410915Sandreas.sandberg@arm.com
97510915Sandreas.sandberg@arm.com# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
97610915Sandreas.sandberg@arm.com# should uniquely identify the documentation set bundle. This should be a
97710915Sandreas.sandberg@arm.com# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
97810915Sandreas.sandberg@arm.com# will append .docset to the name.
97910915Sandreas.sandberg@arm.com
98010915Sandreas.sandberg@arm.comDOCSET_BUNDLE_ID       = org.doxygen.Project
98110915Sandreas.sandberg@arm.com
98210915Sandreas.sandberg@arm.com# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify
98310915Sandreas.sandberg@arm.com# the documentation publisher. This should be a reverse domain-name style
98410915Sandreas.sandberg@arm.com# string, e.g. com.mycompany.MyDocSet.documentation.
98510915Sandreas.sandberg@arm.com
98610915Sandreas.sandberg@arm.comDOCSET_PUBLISHER_ID    = org.doxygen.Publisher
98710915Sandreas.sandberg@arm.com
98810915Sandreas.sandberg@arm.com# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
98910915Sandreas.sandberg@arm.com
99010915Sandreas.sandberg@arm.comDOCSET_PUBLISHER_NAME  = Publisher
99110915Sandreas.sandberg@arm.com
99210915Sandreas.sandberg@arm.com# If the GENERATE_HTMLHELP tag is set to YES, additional index files
99310915Sandreas.sandberg@arm.com# will be generated that can be used as input for tools like the
99410915Sandreas.sandberg@arm.com# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
99510915Sandreas.sandberg@arm.com# of the generated HTML documentation.
99610915Sandreas.sandberg@arm.com
99710915Sandreas.sandberg@arm.comGENERATE_HTMLHELP      = NO
99810915Sandreas.sandberg@arm.com
99910915Sandreas.sandberg@arm.com# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
100010915Sandreas.sandberg@arm.com# be used to specify the file name of the resulting .chm file. You
100110915Sandreas.sandberg@arm.com# can add a path in front of the file if the result should not be
100210915Sandreas.sandberg@arm.com# written to the html output directory.
100310915Sandreas.sandberg@arm.com
100410915Sandreas.sandberg@arm.comCHM_FILE               =
100510915Sandreas.sandberg@arm.com
100610915Sandreas.sandberg@arm.com# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
100710915Sandreas.sandberg@arm.com# be used to specify the location (absolute path including file name) of
100810915Sandreas.sandberg@arm.com# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
100910915Sandreas.sandberg@arm.com# the HTML help compiler on the generated index.hhp.
101010915Sandreas.sandberg@arm.com
101110915Sandreas.sandberg@arm.comHHC_LOCATION           =
101210915Sandreas.sandberg@arm.com
101310915Sandreas.sandberg@arm.com# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
101410915Sandreas.sandberg@arm.com# controls if a separate .chi index file is generated (YES) or that
101510915Sandreas.sandberg@arm.com# it should be included in the master .chm file (NO).
101610915Sandreas.sandberg@arm.com
101710915Sandreas.sandberg@arm.comGENERATE_CHI           = NO
101810915Sandreas.sandberg@arm.com
101910915Sandreas.sandberg@arm.com# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
102010915Sandreas.sandberg@arm.com# is used to encode HtmlHelp index (hhk), content (hhc) and project file
102110915Sandreas.sandberg@arm.com# content.
102210915Sandreas.sandberg@arm.com
102310915Sandreas.sandberg@arm.comCHM_INDEX_ENCODING     =
102410915Sandreas.sandberg@arm.com
102510915Sandreas.sandberg@arm.com# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
102610915Sandreas.sandberg@arm.com# controls whether a binary table of contents is generated (YES) or a
102710915Sandreas.sandberg@arm.com# normal table of contents (NO) in the .chm file.
102810915Sandreas.sandberg@arm.com
102910915Sandreas.sandberg@arm.comBINARY_TOC             = NO
103010915Sandreas.sandberg@arm.com
103110915Sandreas.sandberg@arm.com# The TOC_EXPAND flag can be set to YES to add extra items for group members
103210915Sandreas.sandberg@arm.com# to the contents of the HTML help documentation and to the tree view.
103310915Sandreas.sandberg@arm.com
103410915Sandreas.sandberg@arm.comTOC_EXPAND             = NO
103510915Sandreas.sandberg@arm.com
103610915Sandreas.sandberg@arm.com# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
103710915Sandreas.sandberg@arm.com# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
103810915Sandreas.sandberg@arm.com# that can be used as input for Qt's qhelpgenerator to generate a
103910915Sandreas.sandberg@arm.com# Qt Compressed Help (.qch) of the generated HTML documentation.
104010915Sandreas.sandberg@arm.com
104110915Sandreas.sandberg@arm.comGENERATE_QHP           = NO
104210915Sandreas.sandberg@arm.com
104310915Sandreas.sandberg@arm.com# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
104410915Sandreas.sandberg@arm.com# be used to specify the file name of the resulting .qch file.
104510915Sandreas.sandberg@arm.com# The path specified is relative to the HTML output folder.
104610915Sandreas.sandberg@arm.com
104710915Sandreas.sandberg@arm.comQCH_FILE               =
104810915Sandreas.sandberg@arm.com
104910915Sandreas.sandberg@arm.com# The QHP_NAMESPACE tag specifies the namespace to use when generating
105010915Sandreas.sandberg@arm.com# Qt Help Project output. For more information please see
105110915Sandreas.sandberg@arm.com# http://doc.trolltech.com/qthelpproject.html#namespace
105210915Sandreas.sandberg@arm.com
105310915Sandreas.sandberg@arm.comQHP_NAMESPACE          = org.doxygen.Project
105410915Sandreas.sandberg@arm.com
105510915Sandreas.sandberg@arm.com# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
105610915Sandreas.sandberg@arm.com# Qt Help Project output. For more information please see
105710915Sandreas.sandberg@arm.com# http://doc.trolltech.com/qthelpproject.html#virtual-folders
105810915Sandreas.sandberg@arm.com
105910915Sandreas.sandberg@arm.comQHP_VIRTUAL_FOLDER     = doc
106010915Sandreas.sandberg@arm.com
106110915Sandreas.sandberg@arm.com# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
106210915Sandreas.sandberg@arm.com# add. For more information please see
106310915Sandreas.sandberg@arm.com# http://doc.trolltech.com/qthelpproject.html#custom-filters
106410915Sandreas.sandberg@arm.com
106510915Sandreas.sandberg@arm.comQHP_CUST_FILTER_NAME   =
106610915Sandreas.sandberg@arm.com
106710915Sandreas.sandberg@arm.com# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
106810915Sandreas.sandberg@arm.com# custom filter to add. For more information please see
106910915Sandreas.sandberg@arm.com# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
107010915Sandreas.sandberg@arm.com# Qt Help Project / Custom Filters</a>.
107110915Sandreas.sandberg@arm.com
107210915Sandreas.sandberg@arm.comQHP_CUST_FILTER_ATTRS  =
107310915Sandreas.sandberg@arm.com
107410915Sandreas.sandberg@arm.com# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
107510915Sandreas.sandberg@arm.com# project's
107610915Sandreas.sandberg@arm.com# filter section matches.
107710915Sandreas.sandberg@arm.com# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
107810915Sandreas.sandberg@arm.com# Qt Help Project / Filter Attributes</a>.
107910915Sandreas.sandberg@arm.com
108010915Sandreas.sandberg@arm.comQHP_SECT_FILTER_ATTRS  =
108110915Sandreas.sandberg@arm.com
108210915Sandreas.sandberg@arm.com# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
108310915Sandreas.sandberg@arm.com# be used to specify the location of Qt's qhelpgenerator.
108410915Sandreas.sandberg@arm.com# If non-empty doxygen will try to run qhelpgenerator on the generated
108510915Sandreas.sandberg@arm.com# .qhp file.
108610915Sandreas.sandberg@arm.com
108710915Sandreas.sandberg@arm.comQHG_LOCATION           =
108810915Sandreas.sandberg@arm.com
108910915Sandreas.sandberg@arm.com# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
109010915Sandreas.sandberg@arm.com#  will be generated, which together with the HTML files, form an Eclipse help
109110915Sandreas.sandberg@arm.com# plugin. To install this plugin and make it available under the help contents
109210915Sandreas.sandberg@arm.com# menu in Eclipse, the contents of the directory containing the HTML and XML
109310915Sandreas.sandberg@arm.com# files needs to be copied into the plugins directory of eclipse. The name of
109410915Sandreas.sandberg@arm.com# the directory within the plugins directory should be the same as
109510915Sandreas.sandberg@arm.com# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
109610915Sandreas.sandberg@arm.com# the help appears.
109710915Sandreas.sandberg@arm.com
109810915Sandreas.sandberg@arm.comGENERATE_ECLIPSEHELP   = NO
109910915Sandreas.sandberg@arm.com
110010915Sandreas.sandberg@arm.com# A unique identifier for the eclipse help plugin. When installing the plugin
110110915Sandreas.sandberg@arm.com# the directory name containing the HTML and XML files should also have
110210915Sandreas.sandberg@arm.com# this name.
110310915Sandreas.sandberg@arm.com
110410915Sandreas.sandberg@arm.comECLIPSE_DOC_ID         = org.doxygen.Project
110510915Sandreas.sandberg@arm.com
110610915Sandreas.sandberg@arm.com# The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs)
110710915Sandreas.sandberg@arm.com# at top of each HTML page. The value NO (the default) enables the index and
110810915Sandreas.sandberg@arm.com# the value YES disables it. Since the tabs have the same information as the
110910915Sandreas.sandberg@arm.com# navigation tree you can set this option to NO if you already set
111010915Sandreas.sandberg@arm.com# GENERATE_TREEVIEW to YES.
111110915Sandreas.sandberg@arm.com
111210915Sandreas.sandberg@arm.comDISABLE_INDEX          = NO
111310915Sandreas.sandberg@arm.com
111410915Sandreas.sandberg@arm.com# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
111510915Sandreas.sandberg@arm.com# structure should be generated to display hierarchical information.
111610915Sandreas.sandberg@arm.com# If the tag value is set to YES, a side panel will be generated
111710915Sandreas.sandberg@arm.com# containing a tree-like index structure (just like the one that
111810915Sandreas.sandberg@arm.com# is generated for HTML Help). For this to work a browser that supports
111910915Sandreas.sandberg@arm.com# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
112010915Sandreas.sandberg@arm.com# Windows users are probably better off using the HTML help feature.
112110915Sandreas.sandberg@arm.com# Since the tree basically has the same information as the tab index you
112210915Sandreas.sandberg@arm.com# could consider to set DISABLE_INDEX to NO when enabling this option.
112310915Sandreas.sandberg@arm.com
112410915Sandreas.sandberg@arm.comGENERATE_TREEVIEW      = NO
112510915Sandreas.sandberg@arm.com
112610915Sandreas.sandberg@arm.com# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
112710915Sandreas.sandberg@arm.com# (range [0,1..20]) that doxygen will group on one line in the generated HTML
112810915Sandreas.sandberg@arm.com# documentation. Note that a value of 0 will completely suppress the enum
112910915Sandreas.sandberg@arm.com# values from appearing in the overview section.
113010915Sandreas.sandberg@arm.com
113110915Sandreas.sandberg@arm.comENUM_VALUES_PER_LINE   = 4
113210915Sandreas.sandberg@arm.com
113310915Sandreas.sandberg@arm.com# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
113410915Sandreas.sandberg@arm.com# and Class Hierarchy pages using a tree view instead of an ordered list.
113510915Sandreas.sandberg@arm.com
113610915Sandreas.sandberg@arm.comUSE_INLINE_TREES       = NO
113710915Sandreas.sandberg@arm.com
113810915Sandreas.sandberg@arm.com# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
113910915Sandreas.sandberg@arm.com# used to set the initial width (in pixels) of the frame in which the tree
114010915Sandreas.sandberg@arm.com# is shown.
114110915Sandreas.sandberg@arm.com
114210915Sandreas.sandberg@arm.comTREEVIEW_WIDTH         = 250
114310915Sandreas.sandberg@arm.com
114410915Sandreas.sandberg@arm.com# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
114510915Sandreas.sandberg@arm.com# links to external symbols imported via tag files in a separate window.
114610915Sandreas.sandberg@arm.com
114710915Sandreas.sandberg@arm.comEXT_LINKS_IN_WINDOW    = NO
114810915Sandreas.sandberg@arm.com
114910915Sandreas.sandberg@arm.com# Use this tag to change the font size of Latex formulas included
115010915Sandreas.sandberg@arm.com# as images in the HTML documentation. The default is 10. Note that
115110915Sandreas.sandberg@arm.com# when you change the font size after a successful doxygen run you need
115210915Sandreas.sandberg@arm.com# to manually remove any form_*.png images from the HTML output directory
115310915Sandreas.sandberg@arm.com# to force them to be regenerated.
115410915Sandreas.sandberg@arm.com
115510915Sandreas.sandberg@arm.comFORMULA_FONTSIZE       = 10
115610915Sandreas.sandberg@arm.com
115710915Sandreas.sandberg@arm.com# Use the FORMULA_TRANPARENT tag to determine whether or not the images
115810915Sandreas.sandberg@arm.com# generated for formulas are transparent PNGs. Transparent PNGs are
115910915Sandreas.sandberg@arm.com# not supported properly for IE 6.0, but are supported on all modern browsers.
116010915Sandreas.sandberg@arm.com# Note that when changing this option you need to delete any form_*.png files
116110915Sandreas.sandberg@arm.com# in the HTML output before the changes have effect.
116210915Sandreas.sandberg@arm.com
116310915Sandreas.sandberg@arm.comFORMULA_TRANSPARENT    = YES
116410915Sandreas.sandberg@arm.com
116510915Sandreas.sandberg@arm.com# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax
116610915Sandreas.sandberg@arm.com# (see http://www.mathjax.org) which uses client side Javascript for the
116710915Sandreas.sandberg@arm.com# rendering instead of using prerendered bitmaps. Use this if you do not
116810915Sandreas.sandberg@arm.com# have LaTeX installed or if you want to formulas look prettier in the HTML
116910915Sandreas.sandberg@arm.com# output. When enabled you also need to install MathJax separately and
117010915Sandreas.sandberg@arm.com# configure the path to it using the MATHJAX_RELPATH option.
117110915Sandreas.sandberg@arm.com
117210915Sandreas.sandberg@arm.comUSE_MATHJAX            = NO
117310915Sandreas.sandberg@arm.com
117410915Sandreas.sandberg@arm.com# When MathJax is enabled you need to specify the location relative to the
117510915Sandreas.sandberg@arm.com# HTML output directory using the MATHJAX_RELPATH option. The destination
117610915Sandreas.sandberg@arm.com# directory should contain the MathJax.js script. For instance, if the mathjax
117710915Sandreas.sandberg@arm.com# directory is located at the same level as the HTML output directory, then
117810915Sandreas.sandberg@arm.com# MATHJAX_RELPATH should be ../mathjax. The default value points to the
117910915Sandreas.sandberg@arm.com# mathjax.org site, so you can quickly see the result without installing
118010915Sandreas.sandberg@arm.com# MathJax, but it is strongly recommended to install a local copy of MathJax
118110915Sandreas.sandberg@arm.com# before deployment.
118210915Sandreas.sandberg@arm.com
118310915Sandreas.sandberg@arm.comMATHJAX_RELPATH        = http://www.mathjax.org/mathjax
118410915Sandreas.sandberg@arm.com
118510915Sandreas.sandberg@arm.com# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension
118610915Sandreas.sandberg@arm.com# names that should be enabled during MathJax rendering.
118710915Sandreas.sandberg@arm.com
118810915Sandreas.sandberg@arm.comMATHJAX_EXTENSIONS     =
118910915Sandreas.sandberg@arm.com
119010915Sandreas.sandberg@arm.com# When the SEARCHENGINE tag is enabled doxygen will generate a search box
119110915Sandreas.sandberg@arm.com# for the HTML output. The underlying search engine uses javascript
119210915Sandreas.sandberg@arm.com# and DHTML and should work on any modern browser. Note that when using
119310915Sandreas.sandberg@arm.com# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
119410915Sandreas.sandberg@arm.com# (GENERATE_DOCSET) there is already a search function so this one should
119510915Sandreas.sandberg@arm.com# typically be disabled. For large projects the javascript based search engine
119610915Sandreas.sandberg@arm.com# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
119710915Sandreas.sandberg@arm.com
119810915Sandreas.sandberg@arm.comSEARCHENGINE           = YES
119910915Sandreas.sandberg@arm.com
120010915Sandreas.sandberg@arm.com# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
120110915Sandreas.sandberg@arm.com# implemented using a PHP enabled web server instead of at the web client
120210915Sandreas.sandberg@arm.com# using Javascript. Doxygen will generate the search PHP script and index
120310915Sandreas.sandberg@arm.com# file to put on the web server. The advantage of the server
120410915Sandreas.sandberg@arm.com# based approach is that it scales better to large projects and allows
120510915Sandreas.sandberg@arm.com# full text search. The disadvantages are that it is more difficult to setup
120610915Sandreas.sandberg@arm.com# and does not have live searching capabilities.
120710915Sandreas.sandberg@arm.com
120810915Sandreas.sandberg@arm.comSERVER_BASED_SEARCH    = NO
120910915Sandreas.sandberg@arm.com
121010915Sandreas.sandberg@arm.com#---------------------------------------------------------------------------
121110915Sandreas.sandberg@arm.com# configuration options related to the LaTeX output
121210915Sandreas.sandberg@arm.com#---------------------------------------------------------------------------
121310915Sandreas.sandberg@arm.com
121410915Sandreas.sandberg@arm.com# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
121510915Sandreas.sandberg@arm.com# generate Latex output.
121610915Sandreas.sandberg@arm.com
121710915Sandreas.sandberg@arm.comGENERATE_LATEX         = NO
121810915Sandreas.sandberg@arm.com
121910915Sandreas.sandberg@arm.com# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
122010915Sandreas.sandberg@arm.com# If a relative path is entered the value of OUTPUT_DIRECTORY will be
122110915Sandreas.sandberg@arm.com# put in front of it. If left blank `latex' will be used as the default path.
122210915Sandreas.sandberg@arm.com
122310915Sandreas.sandberg@arm.comLATEX_OUTPUT           = latex
122410915Sandreas.sandberg@arm.com
122510915Sandreas.sandberg@arm.com# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
122610915Sandreas.sandberg@arm.com# invoked. If left blank `latex' will be used as the default command name.
122710915Sandreas.sandberg@arm.com# Note that when enabling USE_PDFLATEX this option is only used for
122810915Sandreas.sandberg@arm.com# generating bitmaps for formulas in the HTML output, but not in the
122910915Sandreas.sandberg@arm.com# Makefile that is written to the output directory.
123010915Sandreas.sandberg@arm.com
123110915Sandreas.sandberg@arm.comLATEX_CMD_NAME         = latex
123210915Sandreas.sandberg@arm.com
123310915Sandreas.sandberg@arm.com# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
123410915Sandreas.sandberg@arm.com# generate index for LaTeX. If left blank `makeindex' will be used as the
123510915Sandreas.sandberg@arm.com# default command name.
123610915Sandreas.sandberg@arm.com
123710915Sandreas.sandberg@arm.comMAKEINDEX_CMD_NAME     = makeindex
123810915Sandreas.sandberg@arm.com
123910915Sandreas.sandberg@arm.com# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
124010915Sandreas.sandberg@arm.com# LaTeX documents. This may be useful for small projects and may help to
124110915Sandreas.sandberg@arm.com# save some trees in general.
124210915Sandreas.sandberg@arm.com
124310915Sandreas.sandberg@arm.comCOMPACT_LATEX          = NO
124410915Sandreas.sandberg@arm.com
124510915Sandreas.sandberg@arm.com# The PAPER_TYPE tag can be used to set the paper type that is used
124610915Sandreas.sandberg@arm.com# by the printer. Possible values are: a4, letter, legal and
124710915Sandreas.sandberg@arm.com# executive. If left blank a4wide will be used.
124810915Sandreas.sandberg@arm.com
124910915Sandreas.sandberg@arm.comPAPER_TYPE             = a4
125010915Sandreas.sandberg@arm.com
125110915Sandreas.sandberg@arm.com# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
125210915Sandreas.sandberg@arm.com# packages that should be included in the LaTeX output.
125310915Sandreas.sandberg@arm.com
125410915Sandreas.sandberg@arm.comEXTRA_PACKAGES         =
125510915Sandreas.sandberg@arm.com
125610915Sandreas.sandberg@arm.com# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
125710915Sandreas.sandberg@arm.com# the generated latex document. The header should contain everything until
125810915Sandreas.sandberg@arm.com# the first chapter. If it is left blank doxygen will generate a
125910915Sandreas.sandberg@arm.com# standard header. Notice: only use this tag if you know what you are doing!
126010915Sandreas.sandberg@arm.com
126110915Sandreas.sandberg@arm.comLATEX_HEADER           =
126210915Sandreas.sandberg@arm.com
126310915Sandreas.sandberg@arm.com# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for
126410915Sandreas.sandberg@arm.com# the generated latex document. The footer should contain everything after
126510915Sandreas.sandberg@arm.com# the last chapter. If it is left blank doxygen will generate a
126610915Sandreas.sandberg@arm.com# standard footer. Notice: only use this tag if you know what you are doing!
126710915Sandreas.sandberg@arm.com
126810915Sandreas.sandberg@arm.comLATEX_FOOTER           =
126910915Sandreas.sandberg@arm.com
127010915Sandreas.sandberg@arm.com# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
127110915Sandreas.sandberg@arm.com# is prepared for conversion to pdf (using ps2pdf). The pdf file will
127210915Sandreas.sandberg@arm.com# contain links (just like the HTML output) instead of page references
127310915Sandreas.sandberg@arm.com# This makes the output suitable for online browsing using a pdf viewer.
127410915Sandreas.sandberg@arm.com
127510915Sandreas.sandberg@arm.comPDF_HYPERLINKS         = YES
127610915Sandreas.sandberg@arm.com
127710915Sandreas.sandberg@arm.com# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
127810915Sandreas.sandberg@arm.com# plain latex in the generated Makefile. Set this option to YES to get a
127910915Sandreas.sandberg@arm.com# higher quality PDF documentation.
128010915Sandreas.sandberg@arm.com
128110915Sandreas.sandberg@arm.comUSE_PDFLATEX           = YES
128210915Sandreas.sandberg@arm.com
128310915Sandreas.sandberg@arm.com# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
128410915Sandreas.sandberg@arm.com# command to the generated LaTeX files. This will instruct LaTeX to keep
128510915Sandreas.sandberg@arm.com# running if errors occur, instead of asking the user for help.
128610915Sandreas.sandberg@arm.com# This option is also used when generating formulas in HTML.
128710915Sandreas.sandberg@arm.com
128810915Sandreas.sandberg@arm.comLATEX_BATCHMODE        = NO
128910915Sandreas.sandberg@arm.com
129010915Sandreas.sandberg@arm.com# If LATEX_HIDE_INDICES is set to YES then doxygen will not
129110915Sandreas.sandberg@arm.com# include the index chapters (such as File Index, Compound Index, etc.)
129210915Sandreas.sandberg@arm.com# in the output.
129310915Sandreas.sandberg@arm.com
129410915Sandreas.sandberg@arm.comLATEX_HIDE_INDICES     = NO
129510915Sandreas.sandberg@arm.com
129610915Sandreas.sandberg@arm.com# If LATEX_SOURCE_CODE is set to YES then doxygen will include
129710915Sandreas.sandberg@arm.com# source code with syntax highlighting in the LaTeX output.
129810915Sandreas.sandberg@arm.com# Note that which sources are shown also depends on other settings
129910915Sandreas.sandberg@arm.com# such as SOURCE_BROWSER.
130010915Sandreas.sandberg@arm.com
130110915Sandreas.sandberg@arm.comLATEX_SOURCE_CODE      = NO
130210915Sandreas.sandberg@arm.com
130310915Sandreas.sandberg@arm.com# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
130410915Sandreas.sandberg@arm.com# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See
130510915Sandreas.sandberg@arm.com# http://en.wikipedia.org/wiki/BibTeX for more info.
130610915Sandreas.sandberg@arm.com
130710915Sandreas.sandberg@arm.comLATEX_BIB_STYLE        = plain
130810915Sandreas.sandberg@arm.com
130910915Sandreas.sandberg@arm.com#---------------------------------------------------------------------------
131010915Sandreas.sandberg@arm.com# configuration options related to the RTF output
131110915Sandreas.sandberg@arm.com#---------------------------------------------------------------------------
131210915Sandreas.sandberg@arm.com
131310915Sandreas.sandberg@arm.com# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
131410915Sandreas.sandberg@arm.com# The RTF output is optimized for Word 97 and may not look very pretty with
131510915Sandreas.sandberg@arm.com# other RTF readers or editors.
131610915Sandreas.sandberg@arm.com
131710915Sandreas.sandberg@arm.comGENERATE_RTF           = NO
131810915Sandreas.sandberg@arm.com
131910915Sandreas.sandberg@arm.com# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
132010915Sandreas.sandberg@arm.com# If a relative path is entered the value of OUTPUT_DIRECTORY will be
132110915Sandreas.sandberg@arm.com# put in front of it. If left blank `rtf' will be used as the default path.
132210915Sandreas.sandberg@arm.com
132310915Sandreas.sandberg@arm.comRTF_OUTPUT             = rtf
132410915Sandreas.sandberg@arm.com
132510915Sandreas.sandberg@arm.com# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
132610915Sandreas.sandberg@arm.com# RTF documents. This may be useful for small projects and may help to
132710915Sandreas.sandberg@arm.com# save some trees in general.
132810915Sandreas.sandberg@arm.com
132910915Sandreas.sandberg@arm.comCOMPACT_RTF            = NO
133010915Sandreas.sandberg@arm.com
133110915Sandreas.sandberg@arm.com# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
133210915Sandreas.sandberg@arm.com# will contain hyperlink fields. The RTF file will
133310915Sandreas.sandberg@arm.com# contain links (just like the HTML output) instead of page references.
133410915Sandreas.sandberg@arm.com# This makes the output suitable for online browsing using WORD or other
133510915Sandreas.sandberg@arm.com# programs which support those fields.
133610915Sandreas.sandberg@arm.com# Note: wordpad (write) and others do not support links.
133710915Sandreas.sandberg@arm.com
133810915Sandreas.sandberg@arm.comRTF_HYPERLINKS         = NO
133910915Sandreas.sandberg@arm.com
134010915Sandreas.sandberg@arm.com# Load style sheet definitions from file. Syntax is similar to doxygen's
134110915Sandreas.sandberg@arm.com# config file, i.e. a series of assignments. You only have to provide
134210915Sandreas.sandberg@arm.com# replacements, missing definitions are set to their default value.
134310915Sandreas.sandberg@arm.com
134410915Sandreas.sandberg@arm.comRTF_STYLESHEET_FILE    =
134510915Sandreas.sandberg@arm.com
134610915Sandreas.sandberg@arm.com# Set optional variables used in the generation of an rtf document.
134710915Sandreas.sandberg@arm.com# Syntax is similar to doxygen's config file.
134810915Sandreas.sandberg@arm.com
134910915Sandreas.sandberg@arm.comRTF_EXTENSIONS_FILE    =
135010915Sandreas.sandberg@arm.com
135110915Sandreas.sandberg@arm.com#---------------------------------------------------------------------------
135210915Sandreas.sandberg@arm.com# configuration options related to the man page output
135310915Sandreas.sandberg@arm.com#---------------------------------------------------------------------------
135410915Sandreas.sandberg@arm.com
135510915Sandreas.sandberg@arm.com# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
135610915Sandreas.sandberg@arm.com# generate man pages
135710915Sandreas.sandberg@arm.com
135810915Sandreas.sandberg@arm.comGENERATE_MAN           = NO
135910915Sandreas.sandberg@arm.com
136010915Sandreas.sandberg@arm.com# The MAN_OUTPUT tag is used to specify where the man pages will be put.
136110915Sandreas.sandberg@arm.com# If a relative path is entered the value of OUTPUT_DIRECTORY will be
136210915Sandreas.sandberg@arm.com# put in front of it. If left blank `man' will be used as the default path.
136310915Sandreas.sandberg@arm.com
136410915Sandreas.sandberg@arm.comMAN_OUTPUT             = man
136510915Sandreas.sandberg@arm.com
136610915Sandreas.sandberg@arm.com# The MAN_EXTENSION tag determines the extension that is added to
136710915Sandreas.sandberg@arm.com# the generated man pages (default is the subroutine's section .3)
136810915Sandreas.sandberg@arm.com
136910915Sandreas.sandberg@arm.comMAN_EXTENSION          = .3
137010915Sandreas.sandberg@arm.com
137110915Sandreas.sandberg@arm.com# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
137210915Sandreas.sandberg@arm.com# then it will generate one additional man file for each entity
137310915Sandreas.sandberg@arm.com# documented in the real man page(s). These additional files
137410915Sandreas.sandberg@arm.com# only source the real man page, but without them the man command
137510915Sandreas.sandberg@arm.com# would be unable to find the correct page. The default is NO.
137610915Sandreas.sandberg@arm.com
137710915Sandreas.sandberg@arm.comMAN_LINKS              = NO
137810915Sandreas.sandberg@arm.com
137910915Sandreas.sandberg@arm.com#---------------------------------------------------------------------------
138010915Sandreas.sandberg@arm.com# configuration options related to the XML output
138110915Sandreas.sandberg@arm.com#---------------------------------------------------------------------------
138210915Sandreas.sandberg@arm.com
138310915Sandreas.sandberg@arm.com# If the GENERATE_XML tag is set to YES Doxygen will
138410915Sandreas.sandberg@arm.com# generate an XML file that captures the structure of
138510915Sandreas.sandberg@arm.com# the code including all documentation.
138610915Sandreas.sandberg@arm.com
138710915Sandreas.sandberg@arm.comGENERATE_XML           = NO
138810915Sandreas.sandberg@arm.com
138910915Sandreas.sandberg@arm.com# The XML_OUTPUT tag is used to specify where the XML pages will be put.
139010915Sandreas.sandberg@arm.com# If a relative path is entered the value of OUTPUT_DIRECTORY will be
139110915Sandreas.sandberg@arm.com# put in front of it. If left blank `xml' will be used as the default path.
139210915Sandreas.sandberg@arm.com
139310915Sandreas.sandberg@arm.comXML_OUTPUT             = xml
139410915Sandreas.sandberg@arm.com
139510915Sandreas.sandberg@arm.com# The XML_SCHEMA tag can be used to specify an XML schema,
139610915Sandreas.sandberg@arm.com# which can be used by a validating XML parser to check the
139710915Sandreas.sandberg@arm.com# syntax of the XML files.
139810915Sandreas.sandberg@arm.com
139910915Sandreas.sandberg@arm.comXML_SCHEMA             =
140010915Sandreas.sandberg@arm.com
140110915Sandreas.sandberg@arm.com# The XML_DTD tag can be used to specify an XML DTD,
140210915Sandreas.sandberg@arm.com# which can be used by a validating XML parser to check the
140310915Sandreas.sandberg@arm.com# syntax of the XML files.
140410915Sandreas.sandberg@arm.com
140510915Sandreas.sandberg@arm.comXML_DTD                =
140610915Sandreas.sandberg@arm.com
140710915Sandreas.sandberg@arm.com# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
140810915Sandreas.sandberg@arm.com# dump the program listings (including syntax highlighting
140910915Sandreas.sandberg@arm.com# and cross-referencing information) to the XML output. Note that
141010915Sandreas.sandberg@arm.com# enabling this will significantly increase the size of the XML output.
141110915Sandreas.sandberg@arm.com
141210915Sandreas.sandberg@arm.comXML_PROGRAMLISTING     = YES
141310915Sandreas.sandberg@arm.com
141410915Sandreas.sandberg@arm.com#---------------------------------------------------------------------------
141510915Sandreas.sandberg@arm.com# configuration options for the AutoGen Definitions output
141610915Sandreas.sandberg@arm.com#---------------------------------------------------------------------------
141710915Sandreas.sandberg@arm.com
141810915Sandreas.sandberg@arm.com# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
141910915Sandreas.sandberg@arm.com# generate an AutoGen Definitions (see autogen.sf.net) file
142010915Sandreas.sandberg@arm.com# that captures the structure of the code including all
142110915Sandreas.sandberg@arm.com# documentation. Note that this feature is still experimental
142210915Sandreas.sandberg@arm.com# and incomplete at the moment.
142310915Sandreas.sandberg@arm.com
142410915Sandreas.sandberg@arm.comGENERATE_AUTOGEN_DEF   = NO
142510915Sandreas.sandberg@arm.com
142610915Sandreas.sandberg@arm.com#---------------------------------------------------------------------------
142710915Sandreas.sandberg@arm.com# configuration options related to the Perl module output
142810915Sandreas.sandberg@arm.com#---------------------------------------------------------------------------
142910915Sandreas.sandberg@arm.com
143010915Sandreas.sandberg@arm.com# If the GENERATE_PERLMOD tag is set to YES Doxygen will
143110915Sandreas.sandberg@arm.com# generate a Perl module file that captures the structure of
143210915Sandreas.sandberg@arm.com# the code including all documentation. Note that this
143310915Sandreas.sandberg@arm.com# feature is still experimental and incomplete at the
143410915Sandreas.sandberg@arm.com# moment.
143510915Sandreas.sandberg@arm.com
143610915Sandreas.sandberg@arm.comGENERATE_PERLMOD       = NO
143710915Sandreas.sandberg@arm.com
143810915Sandreas.sandberg@arm.com# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
143910915Sandreas.sandberg@arm.com# the necessary Makefile rules, Perl scripts and LaTeX code to be able
144010915Sandreas.sandberg@arm.com# to generate PDF and DVI output from the Perl module output.
144110915Sandreas.sandberg@arm.com
144210915Sandreas.sandberg@arm.comPERLMOD_LATEX          = NO
144310915Sandreas.sandberg@arm.com
144410915Sandreas.sandberg@arm.com# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
144510915Sandreas.sandberg@arm.com# nicely formatted so it can be parsed by a human reader.
144610915Sandreas.sandberg@arm.com# This is useful
144710915Sandreas.sandberg@arm.com# if you want to understand what is going on.
144810915Sandreas.sandberg@arm.com# On the other hand, if this
144910915Sandreas.sandberg@arm.com# tag is set to NO the size of the Perl module output will be much smaller
145010915Sandreas.sandberg@arm.com# and Perl will parse it just the same.
145110915Sandreas.sandberg@arm.com
145210915Sandreas.sandberg@arm.comPERLMOD_PRETTY         = YES
145310915Sandreas.sandberg@arm.com
145410915Sandreas.sandberg@arm.com# The names of the make variables in the generated doxyrules.make file
145510915Sandreas.sandberg@arm.com# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
145610915Sandreas.sandberg@arm.com# This is useful so different doxyrules.make files included by the same
145710915Sandreas.sandberg@arm.com# Makefile don't overwrite each other's variables.
145810915Sandreas.sandberg@arm.com
145910915Sandreas.sandberg@arm.comPERLMOD_MAKEVAR_PREFIX =
146010915Sandreas.sandberg@arm.com
146110915Sandreas.sandberg@arm.com#---------------------------------------------------------------------------
146210915Sandreas.sandberg@arm.com# Configuration options related to the preprocessor
146310915Sandreas.sandberg@arm.com#---------------------------------------------------------------------------
146410915Sandreas.sandberg@arm.com
146510915Sandreas.sandberg@arm.com# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
146610915Sandreas.sandberg@arm.com# evaluate all C-preprocessor directives found in the sources and include
146710915Sandreas.sandberg@arm.com# files.
146810915Sandreas.sandberg@arm.com
146910915Sandreas.sandberg@arm.comENABLE_PREPROCESSING   = YES
147010915Sandreas.sandberg@arm.com
147110915Sandreas.sandberg@arm.com# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
147210915Sandreas.sandberg@arm.com# names in the source code. If set to NO (the default) only conditional
147310915Sandreas.sandberg@arm.com# compilation will be performed. Macro expansion can be done in a controlled
147410915Sandreas.sandberg@arm.com# way by setting EXPAND_ONLY_PREDEF to YES.
147510915Sandreas.sandberg@arm.com
147610915Sandreas.sandberg@arm.comMACRO_EXPANSION        = NO
147710915Sandreas.sandberg@arm.com
147810915Sandreas.sandberg@arm.com# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
147910915Sandreas.sandberg@arm.com# then the macro expansion is limited to the macros specified with the
148010915Sandreas.sandberg@arm.com# PREDEFINED and EXPAND_AS_DEFINED tags.
148110915Sandreas.sandberg@arm.com
148210915Sandreas.sandberg@arm.comEXPAND_ONLY_PREDEF     = NO
148310915Sandreas.sandberg@arm.com
148410915Sandreas.sandberg@arm.com# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
148510915Sandreas.sandberg@arm.com# pointed to by INCLUDE_PATH will be searched when a #include is found.
148610915Sandreas.sandberg@arm.com
148710915Sandreas.sandberg@arm.comSEARCH_INCLUDES        = YES
148810915Sandreas.sandberg@arm.com
148910915Sandreas.sandberg@arm.com# The INCLUDE_PATH tag can be used to specify one or more directories that
149010915Sandreas.sandberg@arm.com# contain include files that are not input files but should be processed by
149110915Sandreas.sandberg@arm.com# the preprocessor.
149210915Sandreas.sandberg@arm.com
149310915Sandreas.sandberg@arm.comINCLUDE_PATH           =
149410915Sandreas.sandberg@arm.com
149510915Sandreas.sandberg@arm.com# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
149610915Sandreas.sandberg@arm.com# patterns (like *.h and *.hpp) to filter out the header-files in the
149710915Sandreas.sandberg@arm.com# directories. If left blank, the patterns specified with FILE_PATTERNS will
149810915Sandreas.sandberg@arm.com# be used.
149910915Sandreas.sandberg@arm.com
150010915Sandreas.sandberg@arm.comINCLUDE_FILE_PATTERNS  =
150110915Sandreas.sandberg@arm.com
150210915Sandreas.sandberg@arm.com# The PREDEFINED tag can be used to specify one or more macro names that
150310915Sandreas.sandberg@arm.com# are defined before the preprocessor is started (similar to the -D option of
150410915Sandreas.sandberg@arm.com# gcc). The argument of the tag is a list of macros of the form: name
150510915Sandreas.sandberg@arm.com# or name=definition (no spaces). If the definition and the = are
150610915Sandreas.sandberg@arm.com# omitted =1 is assumed. To prevent a macro definition from being
150710915Sandreas.sandberg@arm.com# undefined via #undef or recursively expanded use the := operator
150810915Sandreas.sandberg@arm.com# instead of the = operator.
150910915Sandreas.sandberg@arm.com
151010915Sandreas.sandberg@arm.comPREDEFINED             =
151110915Sandreas.sandberg@arm.com
151210915Sandreas.sandberg@arm.com# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
151310915Sandreas.sandberg@arm.com# this tag can be used to specify a list of macro names that should be expanded.
151410915Sandreas.sandberg@arm.com# The macro definition that is found in the sources will be used.
151510915Sandreas.sandberg@arm.com# Use the PREDEFINED tag if you want to use a different macro definition that
151610915Sandreas.sandberg@arm.com# overrules the definition found in the source code.
151710915Sandreas.sandberg@arm.com
151810915Sandreas.sandberg@arm.comEXPAND_AS_DEFINED      =
151910915Sandreas.sandberg@arm.com
152010915Sandreas.sandberg@arm.com# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
152110915Sandreas.sandberg@arm.com# doxygen's preprocessor will remove all references to function-like macros
152210915Sandreas.sandberg@arm.com# that are alone on a line, have an all uppercase name, and do not end with a
152310915Sandreas.sandberg@arm.com# semicolon, because these will confuse the parser if not removed.
152410915Sandreas.sandberg@arm.com
152510915Sandreas.sandberg@arm.comSKIP_FUNCTION_MACROS   = YES
152610915Sandreas.sandberg@arm.com
152710915Sandreas.sandberg@arm.com#---------------------------------------------------------------------------
152810915Sandreas.sandberg@arm.com# Configuration::additions related to external references
152910915Sandreas.sandberg@arm.com#---------------------------------------------------------------------------
153010915Sandreas.sandberg@arm.com
153110915Sandreas.sandberg@arm.com# The TAGFILES option can be used to specify one or more tagfiles.
153210915Sandreas.sandberg@arm.com# Optionally an initial location of the external documentation
153310915Sandreas.sandberg@arm.com# can be added for each tagfile. The format of a tag file without
153410915Sandreas.sandberg@arm.com# this location is as follows:
153510915Sandreas.sandberg@arm.com#
153610915Sandreas.sandberg@arm.com# TAGFILES = file1 file2 ...
153710915Sandreas.sandberg@arm.com# Adding location for the tag files is done as follows:
153810915Sandreas.sandberg@arm.com#
153910915Sandreas.sandberg@arm.com# TAGFILES = file1=loc1 "file2 = loc2" ...
154010915Sandreas.sandberg@arm.com# where "loc1" and "loc2" can be relative or absolute paths or
154110915Sandreas.sandberg@arm.com# URLs. If a location is present for each tag, the installdox tool
154210915Sandreas.sandberg@arm.com# does not have to be run to correct the links.
154310915Sandreas.sandberg@arm.com# Note that each tag file must have a unique name
154410915Sandreas.sandberg@arm.com# (where the name does NOT include the path)
154510915Sandreas.sandberg@arm.com# If a tag file is not located in the directory in which doxygen
154610915Sandreas.sandberg@arm.com# is run, you must also specify the path to the tagfile here.
154710915Sandreas.sandberg@arm.com
154810915Sandreas.sandberg@arm.comTAGFILES               =
154910915Sandreas.sandberg@arm.com
155010915Sandreas.sandberg@arm.com# When a file name is specified after GENERATE_TAGFILE, doxygen will create
155110915Sandreas.sandberg@arm.com# a tag file that is based on the input files it reads.
155210915Sandreas.sandberg@arm.com
155310915Sandreas.sandberg@arm.comGENERATE_TAGFILE       =
155410915Sandreas.sandberg@arm.com
155510915Sandreas.sandberg@arm.com# If the ALLEXTERNALS tag is set to YES all external classes will be listed
155610915Sandreas.sandberg@arm.com# in the class index. If set to NO only the inherited external classes
155710915Sandreas.sandberg@arm.com# will be listed.
155810915Sandreas.sandberg@arm.com
155910915Sandreas.sandberg@arm.comALLEXTERNALS           = NO
156010915Sandreas.sandberg@arm.com
156110915Sandreas.sandberg@arm.com# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
156210915Sandreas.sandberg@arm.com# in the modules index. If set to NO, only the current project's groups will
156310915Sandreas.sandberg@arm.com# be listed.
156410915Sandreas.sandberg@arm.com
156510915Sandreas.sandberg@arm.comEXTERNAL_GROUPS        = YES
156610915Sandreas.sandberg@arm.com
156710915Sandreas.sandberg@arm.com# The PERL_PATH should be the absolute path and name of the perl script
156810915Sandreas.sandberg@arm.com# interpreter (i.e. the result of `which perl').
156910915Sandreas.sandberg@arm.com
157010915Sandreas.sandberg@arm.comPERL_PATH              = /usr/bin/perl
157110915Sandreas.sandberg@arm.com
157210915Sandreas.sandberg@arm.com#---------------------------------------------------------------------------
157310915Sandreas.sandberg@arm.com# Configuration options related to the dot tool
157410915Sandreas.sandberg@arm.com#---------------------------------------------------------------------------
157510915Sandreas.sandberg@arm.com
157610915Sandreas.sandberg@arm.com# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
157710915Sandreas.sandberg@arm.com# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
157810915Sandreas.sandberg@arm.com# or super classes. Setting the tag to NO turns the diagrams off. Note that
157910915Sandreas.sandberg@arm.com# this option also works with HAVE_DOT disabled, but it is recommended to
158010915Sandreas.sandberg@arm.com# install and use dot, since it yields more powerful graphs.
158110915Sandreas.sandberg@arm.com
158210915Sandreas.sandberg@arm.comCLASS_DIAGRAMS         = YES
158310915Sandreas.sandberg@arm.com
158410915Sandreas.sandberg@arm.com# You can define message sequence charts within doxygen comments using the \msc
158510915Sandreas.sandberg@arm.com# command. Doxygen will then run the mscgen tool (see
158610915Sandreas.sandberg@arm.com# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
158710915Sandreas.sandberg@arm.com# documentation. The MSCGEN_PATH tag allows you to specify the directory where
158810915Sandreas.sandberg@arm.com# the mscgen tool resides. If left empty the tool is assumed to be found in the
158910915Sandreas.sandberg@arm.com# default search path.
159010915Sandreas.sandberg@arm.com
159110915Sandreas.sandberg@arm.comMSCGEN_PATH            =
159210915Sandreas.sandberg@arm.com
159310915Sandreas.sandberg@arm.com# If set to YES, the inheritance and collaboration graphs will hide
159410915Sandreas.sandberg@arm.com# inheritance and usage relations if the target is undocumented
159510915Sandreas.sandberg@arm.com# or is not a class.
159610915Sandreas.sandberg@arm.com
159710915Sandreas.sandberg@arm.comHIDE_UNDOC_RELATIONS   = YES
159810915Sandreas.sandberg@arm.com
159910915Sandreas.sandberg@arm.com# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
160010915Sandreas.sandberg@arm.com# available from the path. This tool is part of Graphviz, a graph visualization
160110915Sandreas.sandberg@arm.com# toolkit from AT&T and Lucent Bell Labs. The other options in this section
160210915Sandreas.sandberg@arm.com# have no effect if this option is set to NO (the default)
160310915Sandreas.sandberg@arm.com
160410915Sandreas.sandberg@arm.comHAVE_DOT               = NO
160510915Sandreas.sandberg@arm.com
160610915Sandreas.sandberg@arm.com# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
160710915Sandreas.sandberg@arm.com# allowed to run in parallel. When set to 0 (the default) doxygen will
160810915Sandreas.sandberg@arm.com# base this on the number of processors available in the system. You can set it
160910915Sandreas.sandberg@arm.com# explicitly to a value larger than 0 to get control over the balance
161010915Sandreas.sandberg@arm.com# between CPU load and processing speed.
161110915Sandreas.sandberg@arm.com
161210915Sandreas.sandberg@arm.comDOT_NUM_THREADS        = 0
161310915Sandreas.sandberg@arm.com
161410915Sandreas.sandberg@arm.com# By default doxygen will use the Helvetica font for all dot files that
161510915Sandreas.sandberg@arm.com# doxygen generates. When you want a differently looking font you can specify
161610915Sandreas.sandberg@arm.com# the font name using DOT_FONTNAME. You need to make sure dot is able to find
161710915Sandreas.sandberg@arm.com# the font, which can be done by putting it in a standard location or by setting
161810915Sandreas.sandberg@arm.com# the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the
161910915Sandreas.sandberg@arm.com# directory containing the font.
162010915Sandreas.sandberg@arm.com
162110915Sandreas.sandberg@arm.comDOT_FONTNAME           = Helvetica
162210915Sandreas.sandberg@arm.com
162310915Sandreas.sandberg@arm.com# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
162410915Sandreas.sandberg@arm.com# The default size is 10pt.
162510915Sandreas.sandberg@arm.com
162610915Sandreas.sandberg@arm.comDOT_FONTSIZE           = 10
162710915Sandreas.sandberg@arm.com
162810915Sandreas.sandberg@arm.com# By default doxygen will tell dot to use the Helvetica font.
162910915Sandreas.sandberg@arm.com# If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to
163010915Sandreas.sandberg@arm.com# set the path where dot can find it.
163110915Sandreas.sandberg@arm.com
163210915Sandreas.sandberg@arm.comDOT_FONTPATH           =
163310915Sandreas.sandberg@arm.com
163410915Sandreas.sandberg@arm.com# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
163510915Sandreas.sandberg@arm.com# will generate a graph for each documented class showing the direct and
163610915Sandreas.sandberg@arm.com# indirect inheritance relations. Setting this tag to YES will force the
163710915Sandreas.sandberg@arm.com# CLASS_DIAGRAMS tag to NO.
163810915Sandreas.sandberg@arm.com
163910915Sandreas.sandberg@arm.comCLASS_GRAPH            = YES
164010915Sandreas.sandberg@arm.com
164110915Sandreas.sandberg@arm.com# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
164210915Sandreas.sandberg@arm.com# will generate a graph for each documented class showing the direct and
164310915Sandreas.sandberg@arm.com# indirect implementation dependencies (inheritance, containment, and
164410915Sandreas.sandberg@arm.com# class references variables) of the class with other documented classes.
164510915Sandreas.sandberg@arm.com
164610915Sandreas.sandberg@arm.comCOLLABORATION_GRAPH    = YES
164710915Sandreas.sandberg@arm.com
164810915Sandreas.sandberg@arm.com# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
164910915Sandreas.sandberg@arm.com# will generate a graph for groups, showing the direct groups dependencies
165010915Sandreas.sandberg@arm.com
165110915Sandreas.sandberg@arm.comGROUP_GRAPHS           = YES
165210915Sandreas.sandberg@arm.com
165310915Sandreas.sandberg@arm.com# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
165410915Sandreas.sandberg@arm.com# collaboration diagrams in a style similar to the OMG's Unified Modeling
165510915Sandreas.sandberg@arm.com# Language.
165610915Sandreas.sandberg@arm.com
165710915Sandreas.sandberg@arm.comUML_LOOK               = NO
165810915Sandreas.sandberg@arm.com
165910915Sandreas.sandberg@arm.com# If set to YES, the inheritance and collaboration graphs will show the
166010915Sandreas.sandberg@arm.com# relations between templates and their instances.
166110915Sandreas.sandberg@arm.com
166210915Sandreas.sandberg@arm.comTEMPLATE_RELATIONS     = NO
166310915Sandreas.sandberg@arm.com
166410915Sandreas.sandberg@arm.com# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
166510915Sandreas.sandberg@arm.com# tags are set to YES then doxygen will generate a graph for each documented
166610915Sandreas.sandberg@arm.com# file showing the direct and indirect include dependencies of the file with
166710915Sandreas.sandberg@arm.com# other documented files.
166810915Sandreas.sandberg@arm.com
166910915Sandreas.sandberg@arm.comINCLUDE_GRAPH          = YES
167010915Sandreas.sandberg@arm.com
167110915Sandreas.sandberg@arm.com# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
167210915Sandreas.sandberg@arm.com# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
167310915Sandreas.sandberg@arm.com# documented header file showing the documented files that directly or
167410915Sandreas.sandberg@arm.com# indirectly include this file.
167510915Sandreas.sandberg@arm.com
167610915Sandreas.sandberg@arm.comINCLUDED_BY_GRAPH      = YES
167710915Sandreas.sandberg@arm.com
167810915Sandreas.sandberg@arm.com# If the CALL_GRAPH and HAVE_DOT options are set to YES then
167910915Sandreas.sandberg@arm.com# doxygen will generate a call dependency graph for every global function
168010915Sandreas.sandberg@arm.com# or class method. Note that enabling this option will significantly increase
168110915Sandreas.sandberg@arm.com# the time of a run. So in most cases it will be better to enable call graphs
168210915Sandreas.sandberg@arm.com# for selected functions only using the \callgraph command.
168310915Sandreas.sandberg@arm.com
168410915Sandreas.sandberg@arm.comCALL_GRAPH             = NO
168510915Sandreas.sandberg@arm.com
168610915Sandreas.sandberg@arm.com# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
168710915Sandreas.sandberg@arm.com# doxygen will generate a caller dependency graph for every global function
168810915Sandreas.sandberg@arm.com# or class method. Note that enabling this option will significantly increase
168910915Sandreas.sandberg@arm.com# the time of a run. So in most cases it will be better to enable caller
169010915Sandreas.sandberg@arm.com# graphs for selected functions only using the \callergraph command.
169110915Sandreas.sandberg@arm.com
169210915Sandreas.sandberg@arm.comCALLER_GRAPH           = NO
169310915Sandreas.sandberg@arm.com
169410915Sandreas.sandberg@arm.com# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
169510915Sandreas.sandberg@arm.com# will generate a graphical hierarchy of all classes instead of a textual one.
169610915Sandreas.sandberg@arm.com
169710915Sandreas.sandberg@arm.comGRAPHICAL_HIERARCHY    = YES
169810915Sandreas.sandberg@arm.com
169910915Sandreas.sandberg@arm.com# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
170010915Sandreas.sandberg@arm.com# then doxygen will show the dependencies a directory has on other directories
170110915Sandreas.sandberg@arm.com# in a graphical way. The dependency relations are determined by the #include
170210915Sandreas.sandberg@arm.com# relations between the files in the directories.
170310915Sandreas.sandberg@arm.com
170410915Sandreas.sandberg@arm.comDIRECTORY_GRAPH        = YES
170510915Sandreas.sandberg@arm.com
170610915Sandreas.sandberg@arm.com# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
170710915Sandreas.sandberg@arm.com# generated by dot. Possible values are svg, png, jpg, or gif.
170810915Sandreas.sandberg@arm.com# If left blank png will be used. If you choose svg you need to set
170910915Sandreas.sandberg@arm.com# HTML_FILE_EXTENSION to xhtml in order to make the SVG files
171010915Sandreas.sandberg@arm.com# visible in IE 9+ (other browsers do not have this requirement).
171110915Sandreas.sandberg@arm.com
171210915Sandreas.sandberg@arm.comDOT_IMAGE_FORMAT       = png
171310915Sandreas.sandberg@arm.com
171410915Sandreas.sandberg@arm.com# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
171510915Sandreas.sandberg@arm.com# enable generation of interactive SVG images that allow zooming and panning.
171610915Sandreas.sandberg@arm.com# Note that this requires a modern browser other than Internet Explorer.
171710915Sandreas.sandberg@arm.com# Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you
171810915Sandreas.sandberg@arm.com# need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files
171910915Sandreas.sandberg@arm.com# visible. Older versions of IE do not have SVG support.
172010915Sandreas.sandberg@arm.com
172110915Sandreas.sandberg@arm.comINTERACTIVE_SVG        = NO
172210915Sandreas.sandberg@arm.com
172310915Sandreas.sandberg@arm.com# The tag DOT_PATH can be used to specify the path where the dot tool can be
172410915Sandreas.sandberg@arm.com# found. If left blank, it is assumed the dot tool can be found in the path.
172510915Sandreas.sandberg@arm.com
172610915Sandreas.sandberg@arm.comDOT_PATH               =
172710915Sandreas.sandberg@arm.com
172810915Sandreas.sandberg@arm.com# The DOTFILE_DIRS tag can be used to specify one or more directories that
172910915Sandreas.sandberg@arm.com# contain dot files that are included in the documentation (see the
173010915Sandreas.sandberg@arm.com# \dotfile command).
173110915Sandreas.sandberg@arm.com
173210915Sandreas.sandberg@arm.comDOTFILE_DIRS           =
173310915Sandreas.sandberg@arm.com
173410915Sandreas.sandberg@arm.com# The MSCFILE_DIRS tag can be used to specify one or more directories that
173510915Sandreas.sandberg@arm.com# contain msc files that are included in the documentation (see the
173610915Sandreas.sandberg@arm.com# \mscfile command).
173710915Sandreas.sandberg@arm.com
173810915Sandreas.sandberg@arm.comMSCFILE_DIRS           =
173910915Sandreas.sandberg@arm.com
174010915Sandreas.sandberg@arm.com# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
174110915Sandreas.sandberg@arm.com# nodes that will be shown in the graph. If the number of nodes in a graph
174210915Sandreas.sandberg@arm.com# becomes larger than this value, doxygen will truncate the graph, which is
174310915Sandreas.sandberg@arm.com# visualized by representing a node as a red box. Note that doxygen if the
174410915Sandreas.sandberg@arm.com# number of direct children of the root node in a graph is already larger than
174510915Sandreas.sandberg@arm.com# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
174610915Sandreas.sandberg@arm.com# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
174710915Sandreas.sandberg@arm.com
174810915Sandreas.sandberg@arm.comDOT_GRAPH_MAX_NODES    = 50
174910915Sandreas.sandberg@arm.com
175010915Sandreas.sandberg@arm.com# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
175110915Sandreas.sandberg@arm.com# graphs generated by dot. A depth value of 3 means that only nodes reachable
175210915Sandreas.sandberg@arm.com# from the root by following a path via at most 3 edges will be shown. Nodes
175310915Sandreas.sandberg@arm.com# that lay further from the root node will be omitted. Note that setting this
175410915Sandreas.sandberg@arm.com# option to 1 or 2 may greatly reduce the computation time needed for large
175510915Sandreas.sandberg@arm.com# code bases. Also note that the size of a graph can be further restricted by
175610915Sandreas.sandberg@arm.com# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
175710915Sandreas.sandberg@arm.com
175810915Sandreas.sandberg@arm.comMAX_DOT_GRAPH_DEPTH    = 0
175910915Sandreas.sandberg@arm.com
176010915Sandreas.sandberg@arm.com# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
176110915Sandreas.sandberg@arm.com# background. This is disabled by default, because dot on Windows does not
176210915Sandreas.sandberg@arm.com# seem to support this out of the box. Warning: Depending on the platform used,
176310915Sandreas.sandberg@arm.com# enabling this option may lead to badly anti-aliased labels on the edges of
176410915Sandreas.sandberg@arm.com# a graph (i.e. they become hard to read).
176510915Sandreas.sandberg@arm.com
176610915Sandreas.sandberg@arm.comDOT_TRANSPARENT        = NO
176710915Sandreas.sandberg@arm.com
176810915Sandreas.sandberg@arm.com# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
176910915Sandreas.sandberg@arm.com# files in one run (i.e. multiple -o and -T options on the command line). This
177010915Sandreas.sandberg@arm.com# makes dot run faster, but since only newer versions of dot (>1.8.10)
177110915Sandreas.sandberg@arm.com# support this, this feature is disabled by default.
177210915Sandreas.sandberg@arm.com
177310915Sandreas.sandberg@arm.comDOT_MULTI_TARGETS      = YES
177410915Sandreas.sandberg@arm.com
177510915Sandreas.sandberg@arm.com# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
177610915Sandreas.sandberg@arm.com# generate a legend page explaining the meaning of the various boxes and
177710915Sandreas.sandberg@arm.com# arrows in the dot generated graphs.
177810915Sandreas.sandberg@arm.com
177910915Sandreas.sandberg@arm.comGENERATE_LEGEND        = YES
178010915Sandreas.sandberg@arm.com
178110915Sandreas.sandberg@arm.com# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
178210915Sandreas.sandberg@arm.com# remove the intermediate dot files that are used to generate
178310915Sandreas.sandberg@arm.com# the various graphs.
178410915Sandreas.sandberg@arm.com
178510915Sandreas.sandberg@arm.comDOT_CLEANUP            = YES
1786