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