Nathan Yonkee / Mbed 2 deprecated Nucleo_sinewave_output_copy

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   mbed

mbed-os/doxyfile_options@9:d58e77ebd769, 2018-03-02 (annotated)

Committer:
Nathan Yonkee
Date:
Fri Mar 02 07:12:37 2018 -0700
Revision:
9:d58e77ebd769
add mbed-os library

Who changed what in which revision?

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