leo hendrickson / Mbed OS example-Ethernet-mbed-Cloud-connect

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

simple-mbed-cloud-client/mbed-cloud-client/mbed-client/doxygen/mbedclient_doxy@0:8f0bb79ddd48, 2021-05-04 (annotated)

Committer:
leothedragon
Date:
Tue May 04 08:55:12 2021 +0000
Revision:
0:8f0bb79ddd48
nmn

Who changed what in which revision?

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