High level Bluetooth Low Energy API and radio abstraction layer

Dependents:   BLE_ANCS_SDAPI BLE_temperature BLE_HeartRate BLE_ANCS_SDAPI_IRC ... more

Overview

The BLE_API is a high level abstraction for using Bluetooth Low Energy on multiple platforms. For details and examples using the BLE_API please see the BLE_API Summary Page. Or click on the API Documentation tab above.

Supported Services

Supported services can be found in the BLE_API/services folder.

Committer:
rgrover1
Date:
Thu Dec 10 09:15:04 2015 +0000
Revision:
1036:7af23cdcfcac
Parent:
1035:d8ba3cb5a39a
Synchronized with git rev aac31815
Author: Rohit Grover
Merge branch 'endian' of https://github.com/marcuschangarm/ble into marcuschangarm-endian

Who changed what in which revision?

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