annotate Doxyfile @ 269:ac8eb07afcf5

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