Sean Wilson / Mbed OS AdiSense1000_V21

AdiSense1000_V21 MBED API

Fork of AdiSense1000 by PoC_Team

Doxyfile@28:4eb837cd71df, 2018-05-17 (annotated)

Committer:
kevin1990
Date:
Thu May 17 10:34:45 2018 +0100
Revision:
28:4eb837cd71df
Adding host library and example code for v1.3 release

Who changed what in which revision?

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