Matthew Lister / BLE_API

BLE_API

ble.doxyfile@1134:d540a48f650d, 2016-04-06 (annotated)

Committer:
vcoubard
Date:
Wed Apr 06 19:13:52 2016 +0100
Revision:
1134:d540a48f650d
Parent:
1131:692ddf04fc42
Child:
1184:246cbece99c2
Synchronized with git rev d363d7ee

Author: Rohit Grover

Merge branch 'develop'

Who changed what in which revision?

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