ACKme / WiConnect

Host library for controlling a WiConnect enabled Wi-Fi module.

Dependents:   wiconnect-ota_example wiconnect-web_setup_example wiconnect-test-console wiconnect-tcp_server_example ... more

doc/mbed/mbed-wiconnect_library.doxyfile@42:8ffb253b09e7, 2015-09-28 (annotated)

Committer:
aymangrais
Date:
Mon Sep 28 03:38:43 2015 +0000
Revision:
42:8ffb253b09e7
Parent:
34:2616445d0823 
increase ota timeout to be 5 seconds (instead of 1.5 sec)

Who changed what in which revision?

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