Mayank Gupta / Mbed OS pelion-example-frdm

Example

Dependencies:   FXAS21002 FXOS8700Q

simple-mbed-cloud-client/mbed-cloud-client/mbed-coap/doxygen/libcoap_doxy@0:11cc2b7889af, 2019-11-19 (annotated)

Committer:
maygup01
Date:
Tue Nov 19 09:49:38 2019 +0000
Revision:
0:11cc2b7889af
Example

Who changed what in which revision?

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