A metronome using the FRDM K64F board

Committer:
ram54288
Date:
Sun May 14 18:40:18 2017 +0000
Revision:
0:a7a43371b306
Initial commit

Who changed what in which revision?

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