Lee Kai Xuan / mbed-os

mbed-os

Fork of mbed-os by erkin yucel

tools/misc/Doxyfile@0:f269e3021894, 2016-10-23 (annotated)

Committer:
elessair
Date:
Sun Oct 23 15:10:02 2016 +0000
Revision:
0:f269e3021894
Initial commit

Who changed what in which revision?

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