EL4121 Embedded System / mbed-os

mbed-os

Dependents:   cobaLCDJoyMotor_Thread odometry_omni_3roda_v3 odometry_omni_3roda_v1 odometry_omni_3roda_v2 ... more

features/FEATURE_BLE/ble.doxyfile@0:b74591d5ab33, 2017-12-11 (annotated)

Committer:
be_bryan
Date:
Mon Dec 11 17:54:04 2017 +0000
Revision:
0:b74591d5ab33
motor ++

Who changed what in which revision?

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