Pavle Radojkovic / mbed-mqtt

Library for MQTT

mbed-mqtt-master/paho_mqtt_embedded_c/doc/DoxyfileMQTTPacket.in@0:ba7e439238ab, 2022-06-20 (annotated)

Committer:
pavleradojkovic
Date:
Mon Jun 20 16:24:43 2022 +0000
Revision:
0:ba7e439238ab
Inital commit

Who changed what in which revision?

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