Daiki Kato / mbed-os-lychee

mbed-os for GR-LYCHEE

Dependents:   mbed-os-example-blinky-gr-lychee GR-Boads_Camera_sample GR-Boards_Audio_Recoder GR-Boads_Camera_DisplayApp ... more

tools/misc/Doxyfile@0:f782d9c66c49, 2018-02-02 (annotated)

Committer:
dkato
Date:
Fri Feb 02 05:42:23 2018 +0000
Revision:
0:f782d9c66c49
mbed-os for GR-LYCHEE

Who changed what in which revision?

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