Mark Radbourne / Mbed 2 deprecated iothub_client_sample_amqp

Demo using MBED TLS

Dependencies:   EthernetInterface NTPClient iothub_amqp_transport iothub_client mbed-rtos mbed

Fork of iothub_client_sample_amqp by Azure IoT

mbedtls/doxygen/mbedtls.doxyfile@58:f50b97b08851, 2017-01-05 (annotated)

Committer:
markrad
Date:
Thu Jan 05 00:20:03 2017 +0000
Revision:
58:f50b97b08851
Sample using MBED TLS

Who changed what in which revision?

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