Maxim nexpaq / nexpaq_dev

Preliminary main mbed library for nexpaq development

features/FEATURE_BLE/ble.doxyfile@0:6c56fb4bc5f0, 2016-11-04 (annotated)

Committer:
nexpaq
Date:
Fri Nov 04 20:27:58 2016 +0000
Revision:
0:6c56fb4bc5f0
Moving to library for sharing updates

Who changed what in which revision?

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