ON Semiconductor / mbed-os

Dependents:   mbed-TFT-example-NCS36510 mbed-Accelerometer-example-NCS36510 mbed-Accelerometer-example-NCS36510

Committer:
group-onsemi
Date:
Wed Jan 25 20:34:15 2017 +0000
Revision:
0:098463de4c5d
Initial commit

Who changed what in which revision?

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