+4

.reuse/dep5

reviewed

··· 6 6 doc/changes/misc_features/* 7 7 doc/changes/misc_fixes/* 8 8 doc/changes/state_trackers/* 9 9 + doc/changes/ipc/* 10 10 + doc/changes/xrt/* 11 11 + doc/changes/auxiliary/* 12 12 + doc/changes/compositor/* 9 13 Copyright: 2020, Collabora, Ltd. and the Monado contributors 10 14 License: CC0-1.0 11 15 Comment: Prevents needing a license header per fragment between releases.

+11 -1

README.md

reviewed

··· 1 1 # Monado - XR Runtime (XRT) 2 2 3 3 + <!-- 4 4 + Copyright 2018-2020, Collabora, Ltd. 5 5 + SPDX-License-Identifier: CC-BY-4.0 6 6 + 7 7 + This must stay in sync with the last section! 8 8 + --> 9 9 + 10 10 + 3 11 > * Promotional homepage: <https://monado.dev> 4 12 > * Maintained at <https://gitlab.freedesktop.org/monado/monado> 5 13 > * Latest API documentation: <https://monado.pages.freedesktop.org/monado> ··· 266 274 267 275 For this file only: 268 276 269 269 - > Copyright 2018-2019 Collabora, Ltd. 277 277 + > Copyright 2018-2020, Collabora, Ltd. 270 278 > Code of Conduct section: excerpt adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 1.4.1, 271 279 > available at <https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>, 272 280 > and from the freedesktop.org-specific version of that code, ··· 274 282 > 275 283 > 276 284 > SPDX-License-Identifier: CC-BY-4.0 285 285 + 286 286 + <!-- This must stay in sync with the comment at the start! -->

+3 -2463

doc/Doxyfile.in

reviewed

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

+3

doc/images/in-process.drawio.svg.license

reviewed

··· 1 1 + Copyright 2020, Collabora, Ltd. 2 2 + 3 3 + SPDX-License-Identifier: BSL-1.0

+3

doc/images/monado-input-class-relationships.drawio.svg.license

reviewed

··· 1 1 + Copyright 2020, Collabora, Ltd. 2 2 + 3 3 + SPDX-License-Identifier: BSL-1.0

+3

doc/images/out-of-proc.drawio.svg.license

reviewed

··· 1 1 + Copyright 2020, Collabora, Ltd. 2 2 + 3 3 + SPDX-License-Identifier: BSL-1.0

+5

doc/mainpage.md

reviewed

··· 1 1 # Monado 2 2 3 3 + <!-- 4 4 + Copyright 2018-2020, Collabora, Ltd. and the Monado contributors 5 5 + SPDX-License-Identifier: BSL-1.0 6 6 + --> 7 7 + 3 8 This documentation is intended for developers wanting to dive into the code of 4 9 Monado. And assumes that you have read [README.md][], the file also holds 5 10 getting started information and general documentation.

+5

doc/roadmap.md

reviewed

··· 1 1 # Roadmap 2 2 3 3 + <!-- 4 4 + Copyright 2018-2020, Collabora, Ltd. and the Monado contributors 5 5 + SPDX-License-Identifier: BSL-1.0 6 6 + --> 7 7 + 3 8 ## Short term 4 9 5 10 * **cmake**: Make a proper FindXCB.cmake file.

+5

doc/targets.md

reviewed

··· 1 1 # Understanding and Writing Targets 2 2 3 3 + <!-- 4 4 + Copyright 2018-2020, Collabora, Ltd. and the Monado contributors 5 5 + SPDX-License-Identifier: BSL-1.0 6 6 + --> 7 7 + 3 8 Monado is designed to be a collection of related but independent modules. The 4 9 final build product that brings all the desired components together, potentially 5 10 with additional code, is called the "target". There are several targets included

+5

doc/writing-a-new-driver.md

reviewed

··· 1 1 # Writing a new driver 2 2 3 3 + <!-- 4 4 + Copyright 2018-2020, Collabora, Ltd. and the Monado contributors 5 5 + SPDX-License-Identifier: BSL-1.0 6 6 + --> 7 7 + 3 8 This document will tell you in broad strokes what you need to do to create a 4 9 driver in Monado. Like the many ones already in there @ref drv. It is not a step 5 10 by step guide to making a driver. Also what you need to do can vary a lot

+5

src/external/glad/url.txt

reviewed

··· 1 1 + <!-- 2 2 + SPDX-FileCopyrightText: 2020, Collabora, Ltd. and the Monado contributors 3 3 + SPDX-License-Identifier: CC0-1.0 4 4 + --> 5 5 + 1 6 http://gen.glad.sh/#profile=gl%3Dcore%2Cgles1%3Dcommon&api=egl%3D1.4%2Cgl%3D4.5%2Cgles2%3D3.2&extensions=EGL_ANDROID_get_native_client_buffer%2CEGL_ANDROID_image_native_buffer%2CEGL_EXT_image_dma_buf_import%2CEGL_EXT_image_dma_buf_import_modifiers%2CEGL_KHR_image%2CEGL_KHR_platform_android%2CGL_EXT_memory_object%2CGL_EXT_memory_object_fd%2CGL_EXT_memory_object_win32%2CGL_OES_EGL_image%2CGL_OES_EGL_image_external%2CGL_OES_EGL_image_external_essl3&options=MERGE%2CMERGE&generator=c 2 7 3 8