Austin Blackstone / Mbed 2 deprecated client-lwip-lightswitch-demo-expanded

mbed client lightswitch demo

Dependencies:   mbed Socket lwip-eth lwip-sys lwip

Fork of mbed-client-classic-example-lwip by Austin Blackstone

mbed-client/doxygen/mbedclient_doxy@11:cada08fc8a70, 2016-06-09 (annotated)

Committer:
mbedAustin
Date:
Thu Jun 09 17:08:36 2016 +0000
Revision:
11:cada08fc8a70
Commit for public Consumption

Who changed what in which revision?

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