Pfp Cybersecurity (Aka Power Fingerprinting, Inc.) / Mbed OS pfp-emon-nxp

Important changes to repositories hosted on mbed.com

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

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

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

Dependencies:   FXAS21002 FXOS8700Q

simple-mbed-cloud-client/mbed-cloud-client/mbed-client/doxygen/mbedclient_doxy@2:990c985a69ae, 2020-03-20 (annotated)

Committer:
vithyat
Date:
Fri Mar 20 20:15:18 2020 +0000
Revision:
2:990c985a69ae
Parent:
0:977e87915078 
Update to work with P2Scan runtime

Who changed what in which revision?

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