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