Includes library modifications to allow access to AIN_4 (AIN_0 / 5)

Committer:
bryantaylor
Date:
Tue Sep 20 21:26:12 2016 +0000
Revision:
0:eafc3fd41f75
hackathon

Who changed what in which revision?

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