blob: 6906cc82c00602a15fb23531cd3bcc6faa317940 [file] [log] [blame]
 Nico Huber a9fc4f4 2012-12-10 13:34:11 +0000 [diff] [blame] 1 # Doxyfile 1.8.13 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 double hash (##) is considered a comment and is placed in 7 # front of the TAG it is preceding. 8 # 9 # All text after a single hash (#) is considered a comment and will be ignored. 10 # The format is: 11 # TAG = value [value, ...] 12 # For lists, items can also be appended using: 13 # TAG += value [value, ...] 14 # Values that contain spaces should be placed between quotes (\" \"). 15 16 #--------------------------------------------------------------------------- 17 # Project related configuration options 18 #--------------------------------------------------------------------------- 19 20 # This tag specifies the encoding used for all characters in the config file 21 # that follow. The default is UTF-8 which is also the encoding used for all text 22 # before the first occurrence of this tag. Doxygen uses libiconv (or the iconv 23 # built into libc) for the transcoding. See http://www.gnu.org/software/libiconv 24 # for the list of possible encodings. 25 # The default value is: UTF-8. 26 27 DOXYFILE_ENCODING = UTF-8 28 29 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by 30 # double-quotes, unless you are using Doxywizard) that should identify the 31 # project for which the documentation is generated. This name is used in the 32 # title of most generated pages and in a few other places. 33 # The default value is: My Project. 34 35 PROJECT_NAME = "libflashrom" 36 37 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This 38 # could be handy for archiving the generated documentation or if some version 39 # control system is used. 40 41 PROJECT_NUMBER = 42 43 # Using the PROJECT_BRIEF tag one can provide an optional one line description 44 # for a project that appears at the top of each page and should give viewer a 45 # quick idea about the purpose of the project. Keep the description short. 46 47 PROJECT_BRIEF = 48 49 # With the PROJECT_LOGO tag one can specify a logo or an icon that is included 50 # in the documentation. The maximum height of the logo should not exceed 55 51 # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy 52 # the logo to the output directory. 53 54 PROJECT_LOGO = 55 56 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path 57 # into which the generated documentation will be written. If a relative path is 58 # entered, it will be relative to the location where doxygen was started. If 59 # left blank the current directory will be used. 60 61 OUTPUT_DIRECTORY = "libflashrom-doc" 62 63 # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- 64 # directories (in 2 levels) under the output directory of each output format and 65 # will distribute the generated files over these directories. Enabling this 66 # option can be useful when feeding doxygen a huge amount of source files, where 67 # putting all generated files in the same directory would otherwise causes 68 # performance problems for the file system. 69 # The default value is: NO. 70 71 CREATE_SUBDIRS = NO 72 73 # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII 74 # characters to appear in the names of generated files. If set to NO, non-ASCII 75 # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode 76 # U+3044. 77 # The default value is: NO. 78 79 ALLOW_UNICODE_NAMES = NO 80 81 # The OUTPUT_LANGUAGE tag is used to specify the language in which all 82 # documentation generated by doxygen is written. Doxygen will use this 83 # information to generate all constant output in the proper language. 84 # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, 85 # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), 86 # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, 87 # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), 88 # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, 89 # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, 90 # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, 91 # Ukrainian and Vietnamese. 92 # The default value is: English. 93 94 OUTPUT_LANGUAGE = English 95 96 # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member 97 # descriptions after the members that are listed in the file and class 98 # documentation (similar to Javadoc). Set to NO to disable this. 99 # The default value is: YES. 100 101 BRIEF_MEMBER_DESC = YES 102 103 # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief 104 # description of a member or function before the detailed description 105 # 106 # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 107 # brief descriptions will be completely suppressed. 108 # The default value is: YES. 109 110 REPEAT_BRIEF = YES 111 112 # This tag implements a quasi-intelligent brief description abbreviator that is 113 # used to form the text in various listings. Each string in this list, if found 114 # as the leading text of the brief description, will be stripped from the text 115 # and the result, after processing the whole list, is used as the annotated 116 # text. Otherwise, the brief description is used as-is. If left blank, the 117 # following values are used ($name is automatically replaced with the name of 118 # the entity):The$name class, The $name widget, The$name file, is, provides, 119 # specifies, contains, represents, a, an and the. 120 121 ABBREVIATE_BRIEF = 122 123 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 124 # doxygen will generate a detailed section even if there is only a brief 125 # description. 126 # The default value is: NO. 127 128 ALWAYS_DETAILED_SEC = NO 129 130 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 131 # inherited members of a class in the documentation of that class as if those 132 # members were ordinary class members. Constructors, destructors and assignment 133 # operators of the base classes will not be shown. 134 # The default value is: NO. 135 136 INLINE_INHERITED_MEMB = NO 137 138 # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path 139 # before files name in the file list and in the header files. If set to NO the 140 # shortest path that makes the file name unique will be used 141 # The default value is: YES. 142 143 FULL_PATH_NAMES = YES 144 145 # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. 146 # Stripping is only done if one of the specified strings matches the left-hand 147 # part of the path. The tag can be used to show relative paths in the file list. 148 # If left blank the directory from which doxygen is run is used as the path to 149 # strip. 150 # 151 # Note that you can specify absolute paths here, but also relative paths, which 152 # will be relative from the directory where doxygen is started. 153 # This tag requires that the tag FULL_PATH_NAMES is set to YES. 154 155 STRIP_FROM_PATH = 156 157 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the 158 # path mentioned in the documentation of a class, which tells the reader which 159 # header file to include in order to use a class. If left blank only the name of 160 # the header file containing the class definition is used. Otherwise one should 161 # specify the list of include paths that are normally passed to the compiler 162 # using the -I flag. 163 164 STRIP_FROM_INC_PATH = 165 166 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but 167 # less readable) file names. This can be useful is your file systems doesn't 168 # support long names like on DOS, Mac, or CD-ROM. 169 # The default value is: NO. 170 171 SHORT_NAMES = NO 172 173 # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the 174 # first line (until the first dot) of a Javadoc-style comment as the brief 175 # description. If set to NO, the Javadoc-style will behave just like regular Qt- 176 # style comments (thus requiring an explicit @brief command for a brief 177 # description.) 178 # The default value is: NO. 179 180 JAVADOC_AUTOBRIEF = NO 181 182 # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first 183 # line (until the first dot) of a Qt-style comment as the brief description. If 184 # set to NO, the Qt-style will behave just like regular Qt-style comments (thus 185 # requiring an explicit \brief command for a brief description.) 186 # The default value is: NO. 187 188 QT_AUTOBRIEF = NO 189 190 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a 191 # multi-line C++ special comment block (i.e. a block of //! or /// comments) as 192 # a brief description. This used to be the default behavior. The new default is 193 # to treat a multi-line C++ comment block as a detailed description. Set this 194 # tag to YES if you prefer the old behavior instead. 195 # 196 # Note that setting this tag to YES also means that rational rose comments are 197 # not recognized any more. 198 # The default value is: NO. 199 200 MULTILINE_CPP_IS_BRIEF = NO 201 202 # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the 203 # documentation from any documented member that it re-implements. 204 # The default value is: YES. 205 206 INHERIT_DOCS = YES 207 208 # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new 209 # page for each member. If set to NO, the documentation of a member will be part 210 # of the file/class/namespace that contains it. 211 # The default value is: NO. 212 213 SEPARATE_MEMBER_PAGES = NO 214 215 # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen 216 # uses this value to replace tabs by spaces in code fragments. 217 # Minimum value: 1, maximum value: 16, default value: 4. 218 219 TAB_SIZE = 8 220 221 # This tag can be used to specify a number of aliases that act as commands in 222 # the documentation. An alias has the form: 223 # name=value 224 # For example adding 225 # "sideeffect=@par Side Effects:\n" 226 # will allow you to put the command \sideeffect (or @sideeffect) in the 227 # documentation, which will result in a user-defined paragraph with heading 228 # "Side Effects:". You can put \n's in the value part of an alias to insert 229 # newlines. 230 231 ALIASES = 232 233 # This tag can be used to specify a number of word-keyword mappings (TCL only). 234 # A mapping has the form "name=value". For example adding "class=itcl::class" 235 # will allow you to use the command class in the itcl::class meaning. 236 237 TCL_SUBST = 238 239 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources 240 # only. Doxygen will then generate output that is more tailored for C. For 241 # instance, some of the names that are used will be different. The list of all 242 # members will be omitted, etc. 243 # The default value is: NO. 244 245 OPTIMIZE_OUTPUT_FOR_C = YES 246 247 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or 248 # Python sources only. Doxygen will then generate output that is more tailored 249 # for that language. For instance, namespaces will be presented as packages, 250 # qualified scopes will look different, etc. 251 # The default value is: NO. 252 253 OPTIMIZE_OUTPUT_JAVA = NO 254 255 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 256 # sources. Doxygen will then generate output that is tailored for Fortran. 257 # The default value is: NO. 258 259 OPTIMIZE_FOR_FORTRAN = NO 260 261 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 262 # sources. Doxygen will then generate output that is tailored for VHDL. 263 # The default value is: NO. 264 265 OPTIMIZE_OUTPUT_VHDL = NO 266 267 # Doxygen selects the parser to use depending on the extension of the files it 268 # parses. With this tag you can assign which parser to use for a given 269 # extension. Doxygen has a built-in mapping, but you can override or extend it 270 # using this tag. The format is ext=language, where ext is a file extension, and 271 # language is one of the parsers supported by doxygen: IDL, Java, Javascript, 272 # C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: 273 # FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: 274 # Fortran. In the later case the parser tries to guess whether the code is fixed 275 # or free formatted code, this is the default for Fortran type files), VHDL. For 276 # instance to make doxygen treat .inc files as Fortran files (default is PHP), 277 # and .f files as C (default is Fortran), use: inc=Fortran f=C. 278 # 279 # Note: For files without extension you can use no_extension as a placeholder. 280 # 281 # Note that for custom extensions you also need to set FILE_PATTERNS otherwise 282 # the files are not read by doxygen. 283 284 EXTENSION_MAPPING = 285 286 # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments 287 # according to the Markdown format, which allows for more readable 288 # documentation. See http://daringfireball.net/projects/markdown/ for details. 289 # The output of markdown processing is further processed by doxygen, so you can 290 # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in 291 # case of backward compatibilities issues. 292 # The default value is: YES. 293 294 MARKDOWN_SUPPORT = YES 295 296 # When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up 297 # to that level are automatically included in the table of contents, even if 298 # they do not have an id attribute. 299 # Note: This feature currently applies only to Markdown headings. 300 # Minimum value: 0, maximum value: 99, default value: 0. 301 # This tag requires that the tag MARKDOWN_SUPPORT is set to YES. 302 303 TOC_INCLUDE_HEADINGS = 0 304 305 # When enabled doxygen tries to link words that correspond to documented 306 # classes, or namespaces to their corresponding documentation. Such a link can 307 # be prevented in individual cases by putting a % sign in front of the word or 308 # globally by setting AUTOLINK_SUPPORT to NO. 309 # The default value is: YES. 310 311 AUTOLINK_SUPPORT = YES 312 313 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 314 # to include (a tag file for) the STL sources as input, then you should set this 315 # tag to YES in order to let doxygen match functions declarations and 316 # definitions whose arguments contain STL classes (e.g. func(std::string); 317 # versus func(std::string) {}). This also make the inheritance and collaboration 318 # diagrams that involve STL classes more complete and accurate. 319 # The default value is: NO. 320 321 BUILTIN_STL_SUPPORT = NO 322 323 # If you use Microsoft's C++/CLI language, you should set this option to YES to 324 # enable parsing support. 325 # The default value is: NO. 326 327 CPP_CLI_SUPPORT = NO 328 329 # Set the SIP_SUPPORT tag to YES if your project consists of sip (see: 330 # http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen 331 # will parse them like normal C++ but will assume all classes use public instead 332 # of private inheritance when no explicit protection keyword is present. 333 # The default value is: NO. 334 335 SIP_SUPPORT = NO 336 337 # For Microsoft's IDL there are propget and propput attributes to indicate 338 # getter and setter methods for a property. Setting this option to YES will make 339 # doxygen to replace the get and set methods by a property in the documentation. 340 # This will only work if the methods are indeed getting or setting a simple 341 # type. If this is not the case, or you want to show the methods anyway, you 342 # should set this option to NO. 343 # The default value is: YES. 344 345 IDL_PROPERTY_SUPPORT = YES 346 347 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 348 # tag is set to YES then doxygen will reuse the documentation of the first 349 # member in the group (if any) for the other members of the group. By default 350 # all members of a group must be documented explicitly. 351 # The default value is: NO. 352 353 DISTRIBUTE_GROUP_DOC = NO 354 355 # If one adds a struct or class to a group and this option is enabled, then also 356 # any nested class or struct is added to the same group. By default this option 357 # is disabled and one has to add nested compounds explicitly via \ingroup. 358 # The default value is: NO. 359 360 GROUP_NESTED_COMPOUNDS = NO 361 362 # Set the SUBGROUPING tag to YES to allow class member groups of the same type 363 # (for instance a group of public functions) to be put as a subgroup of that 364 # type (e.g. under the Public Functions section). Set it to NO to prevent 365 # subgrouping. Alternatively, this can be done per class using the 366 # \nosubgrouping command. 367 # The default value is: YES. 368 369 SUBGROUPING = YES 370 371 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions 372 # are shown inside the group in which they are included (e.g. using \ingroup) 373 # instead of on a separate page (for HTML and Man pages) or section (for LaTeX 374 # and RTF). 375 # 376 # Note that this feature does not work in combination with 377 # SEPARATE_MEMBER_PAGES. 378 # The default value is: NO. 379 380 INLINE_GROUPED_CLASSES = NO 381 382 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions 383 # with only public data fields or simple typedef fields will be shown inline in 384 # the documentation of the scope in which they are defined (i.e. file, 385 # namespace, or group documentation), provided this scope is documented. If set 386 # to NO, structs, classes, and unions are shown on a separate page (for HTML and 387 # Man pages) or section (for LaTeX and RTF). 388 # The default value is: NO. 389 390 INLINE_SIMPLE_STRUCTS = NO 391 392 # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or 393 # enum is documented as struct, union, or enum with the name of the typedef. So 394 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct 395 # with name TypeT. When disabled the typedef will appear as a member of a file, 396 # namespace, or class. And the struct will be named TypeS. This can typically be 397 # useful for C code in case the coding convention dictates that all compound 398 # types are typedef'ed and only the typedef is referenced, never the tag name. 399 # The default value is: NO. 400 401 TYPEDEF_HIDES_STRUCT = NO 402 403 # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This 404 # cache is used to resolve symbols given their name and scope. Since this can be 405 # an expensive process and often the same symbol appears multiple times in the 406 # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small 407 # doxygen will become slower. If the cache is too large, memory is wasted. The 408 # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range 409 # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 410 # symbols. At the end of a run doxygen will report the cache usage and suggest 411 # the optimal cache size from a speed point of view. 412 # Minimum value: 0, maximum value: 9, default value: 0. 413 414 LOOKUP_CACHE_SIZE = 0 415 416 #--------------------------------------------------------------------------- 417 # Build related configuration options 418 #--------------------------------------------------------------------------- 419 420 # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in 421 # documentation are documented, even if no documentation was available. Private 422 # class members and static file members will be hidden unless the 423 # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. 424 # Note: This will also disable the warnings about undocumented members that are 425 # normally produced when WARNINGS is set to YES. 426 # The default value is: NO. 427 428 EXTRACT_ALL = NO 429 430 # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will 431 # be included in the documentation. 432 # The default value is: NO. 433 434 EXTRACT_PRIVATE = NO 435 436 # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal 437 # scope will be included in the documentation. 438 # The default value is: NO. 439 440 EXTRACT_PACKAGE = NO 441 442 # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be 443 # included in the documentation. 444 # The default value is: NO. 445 446 EXTRACT_STATIC = NO 447 448 # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined 449 # locally in source files will be included in the documentation. If set to NO, 450 # only classes defined in header files are included. Does not have any effect 451 # for Java sources. 452 # The default value is: YES. 453 454 EXTRACT_LOCAL_CLASSES = YES 455 456 # This flag is only useful for Objective-C code. If set to YES, local methods, 457 # which are defined in the implementation section but not in the interface are 458 # included in the documentation. If set to NO, only methods in the interface are 459 # included. 460 # The default value is: NO. 461 462 EXTRACT_LOCAL_METHODS = NO 463 464 # If this flag is set to YES, the members of anonymous namespaces will be 465 # extracted and appear in the documentation as a namespace called 466 # 'anonymous_namespace{file}', where file will be replaced with the base name of 467 # the file that contains the anonymous namespace. By default anonymous namespace 468 # are hidden. 469 # The default value is: NO. 470 471 EXTRACT_ANON_NSPACES = NO 472 473 # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all 474 # undocumented members inside documented classes or files. If set to NO these 475 # members will be included in the various overviews, but no documentation 476 # section is generated. This option has no effect if EXTRACT_ALL is enabled. 477 # The default value is: NO. 478 479 HIDE_UNDOC_MEMBERS = NO 480 481 # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all 482 # undocumented classes that are normally visible in the class hierarchy. If set 483 # to NO, these classes will be included in the various overviews. This option 484 # has no effect if EXTRACT_ALL is enabled. 485 # The default value is: NO. 486 487 HIDE_UNDOC_CLASSES = NO 488 489 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend 490 # (class|struct|union) declarations. If set to NO, these declarations will be 491 # included in the documentation. 492 # The default value is: NO. 493 494 HIDE_FRIEND_COMPOUNDS = NO 495 496 # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any 497 # documentation blocks found inside the body of a function. If set to NO, these 498 # blocks will be appended to the function's detailed documentation block. 499 # The default value is: NO. 500 501 HIDE_IN_BODY_DOCS = NO 502 503 # The INTERNAL_DOCS tag determines if documentation that is typed after a 504 # \internal command is included. If the tag is set to NO then the documentation 505 # will be excluded. Set it to YES to include the internal documentation. 506 # The default value is: NO. 507 508 INTERNAL_DOCS = NO 509 510 # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file 511 # names in lower-case letters. If set to YES, upper-case letters are also 512 # allowed. This is useful if you have classes or files whose names only differ 513 # in case and if your file system supports case sensitive file names. Windows 514 # and Mac users are advised to set this option to NO. 515 # The default value is: system dependent. 516 517 CASE_SENSE_NAMES = YES 518 519 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with 520 # their full class and namespace scopes in the documentation. If set to YES, the 521 # scope will be hidden. 522 # The default value is: NO. 523 524 HIDE_SCOPE_NAMES = NO 525 526 # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will 527 # append additional text to a page's title, such as Class Reference. If set to 528 # YES the compound reference will be hidden. 529 # The default value is: NO. 530 531 HIDE_COMPOUND_REFERENCE= NO 532 533 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of 534 # the files that are included by a file in the documentation of that file. 535 # The default value is: YES. 536 537 SHOW_INCLUDE_FILES = YES 538 539 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each 540 # grouped member an include statement to the documentation, telling the reader 541 # which file to include in order to use the member. 542 # The default value is: NO. 543 544 SHOW_GROUPED_MEMB_INC = NO 545 546 # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include 547 # files with double quotes in the documentation rather than with sharp brackets. 548 # The default value is: NO. 549 550 FORCE_LOCAL_INCLUDES = NO 551 552 # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the 553 # documentation for inline members. 554 # The default value is: YES. 555 556 INLINE_INFO = YES 557 558 # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the 559 # (detailed) documentation of file and class members alphabetically by member 560 # name. If set to NO, the members will appear in declaration order. 561 # The default value is: YES. 562 563 SORT_MEMBER_DOCS = YES 564 565 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief 566 # descriptions of file, namespace and class members alphabetically by member 567 # name. If set to NO, the members will appear in declaration order. Note that 568 # this will also influence the order of the classes in the class list. 569 # The default value is: NO. 570 571 SORT_BRIEF_DOCS = NO 572 573 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the 574 # (brief and detailed) documentation of class members so that constructors and 575 # destructors are listed first. If set to NO the constructors will appear in the 576 # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. 577 # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief 578 # member documentation. 579 # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting 580 # detailed member documentation. 581 # The default value is: NO. 582 583 SORT_MEMBERS_CTORS_1ST = NO 584 585 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy 586 # of group names into alphabetical order. If set to NO the group names will 587 # appear in their defined order. 588 # The default value is: NO. 589 590 SORT_GROUP_NAMES = NO 591 592 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by 593 # fully-qualified names, including namespaces. If set to NO, the class list will 594 # be sorted only by class name, not including the namespace part. 595 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 596 # Note: This option applies only to the class list, not to the alphabetical 597 # list. 598 # The default value is: NO. 599 600 SORT_BY_SCOPE_NAME = NO 601 602 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper 603 # type resolution of all parameters of a function it will reject a match between 604 # the prototype and the implementation of a member function even if there is 605 # only one candidate or it is obvious which candidate to choose by doing a 606 # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still 607 # accept a match between prototype and implementation in such cases. 608 # The default value is: NO. 609 610 STRICT_PROTO_MATCHING = NO 611 612 # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo 613 # list. This list is created by putting \todo commands in the documentation. 614 # The default value is: YES. 615 616 GENERATE_TODOLIST = YES 617 618 # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test 619 # list. This list is created by putting \test commands in the documentation. 620 # The default value is: YES. 621 622 GENERATE_TESTLIST = YES 623 624 # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug 625 # list. This list is created by putting \bug commands in the documentation. 626 # The default value is: YES. 627 628 GENERATE_BUGLIST = YES 629 630 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) 631 # the deprecated list. This list is created by putting \deprecated commands in 632 # the documentation. 633 # The default value is: YES. 634 635 GENERATE_DEPRECATEDLIST= YES 636 637 # The ENABLED_SECTIONS tag can be used to enable conditional documentation 638 # sections, marked by \if ... \endif and \cond 639 # ... \endcond blocks. 640 641 ENABLED_SECTIONS = 642 643 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the 644 # initial value of a variable or macro / define can have for it to appear in the 645 # documentation. If the initializer consists of more lines than specified here 646 # it will be hidden. Use a value of 0 to hide initializers completely. The 647 # appearance of the value of individual variables and macros / defines can be 648 # controlled using \showinitializer or \hideinitializer command in the 649 # documentation regardless of this setting. 650 # Minimum value: 0, maximum value: 10000, default value: 30. 651 652 MAX_INITIALIZER_LINES = 30 653 654 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at 655 # the bottom of the documentation of classes and structs. If set to YES, the 656 # list will mention the files that were used to generate the documentation. 657 # The default value is: YES. 658 659 SHOW_USED_FILES = YES 660 661 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This 662 # will remove the Files entry from the Quick Index and from the Folder Tree View 663 # (if specified). 664 # The default value is: YES. 665 666 SHOW_FILES = YES 667 668 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces 669 # page. This will remove the Namespaces entry from the Quick Index and from the 670 # Folder Tree View (if specified). 671 # The default value is: YES. 672 673 SHOW_NAMESPACES = YES 674 675 # The FILE_VERSION_FILTER tag can be used to specify a program or script that 676 # doxygen should invoke to get the current version for each file (typically from 677 # the version control system). Doxygen will invoke the program by executing (via 678 # popen()) the command command input-file, where command is the value of the 679 # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided 680 # by doxygen. Whatever the program writes to standard output is used as the file 681 # version. For an example see the documentation. 682 683 FILE_VERSION_FILTER = 684 685 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed 686 # by doxygen. The layout file controls the global structure of the generated 687 # output files in an output format independent way. To create the layout file 688 # that represents doxygen's defaults, run doxygen with the -l option. You can 689 # optionally specify a file name after the option, if omitted DoxygenLayout.xml 690 # will be used as the name of the layout file. 691 # 692 # Note that if you run doxygen from a directory containing a file called 693 # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE 694 # tag is left empty. 695 696 LAYOUT_FILE = 697 698 # The CITE_BIB_FILES tag can be used to specify one or more bib files containing 699 # the reference definitions. This must be a list of .bib files. The .bib 700 # extension is automatically appended if omitted. This requires the bibtex tool 701 # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. 702 # For LaTeX the style of the bibliography can be controlled using 703 # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the 704 # search path. See also \cite for info how to create references. 705 706 CITE_BIB_FILES = 707 708 #--------------------------------------------------------------------------- 709 # Configuration options related to warning and progress messages 710 #--------------------------------------------------------------------------- 711 712 # The QUIET tag can be used to turn on/off the messages that are generated to 713 # standard output by doxygen. If QUIET is set to YES this implies that the 714 # messages are off. 715 # The default value is: NO. 716 717 QUIET = NO 718 719 # The WARNINGS tag can be used to turn on/off the warning messages that are 720 # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES 721 # this implies that the warnings are on. 722 # 723 # Tip: Turn warnings on while writing the documentation. 724 # The default value is: YES. 725 726 WARNINGS = YES 727 728 # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate 729 # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag 730 # will automatically be disabled. 731 # The default value is: YES. 732 733 WARN_IF_UNDOCUMENTED = YES 734 735 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for 736 # potential errors in the documentation, such as not documenting some parameters 737 # in a documented function, or documenting parameters that don't exist or using 738 # markup commands wrongly. 739 # The default value is: YES. 740 741 WARN_IF_DOC_ERROR = YES 742 743 # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that 744 # are documented, but have no documentation for their parameters or return 745 # value. If set to NO, doxygen will only warn about wrong or incomplete 746 # parameter documentation, but not about the absence of documentation. 747 # The default value is: NO. 748 749 WARN_NO_PARAMDOC = NO 750 751 # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when 752 # a warning is encountered. 753 # The default value is: NO. 754 755 WARN_AS_ERROR = NO 756 757 # The WARN_FORMAT tag determines the format of the warning messages that doxygen 758 # can produce. The string should contain the $file,$line, and $text tags, which 759 # will be replaced by the file and line number from which the warning originated 760 # and the warning text. Optionally the format may contain$version, which will 761 # be replaced by the version of the file (if it could be obtained via 762 # FILE_VERSION_FILTER) 763 # The default value is: $file:$line: $text. 764 765 WARN_FORMAT = "$file:$line:$text" 766 767 # The WARN_LOGFILE tag can be used to specify a file to which warning and error 768 # messages should be written. If left blank the output is written to standard 769 # error (stderr). 770 771 WARN_LOGFILE = 772 773 #--------------------------------------------------------------------------- 774 # Configuration options related to the input files 775 #--------------------------------------------------------------------------- 776 777 # The INPUT tag is used to specify the files and/or directories that contain 778 # documented source files. You may enter file names like myfile.cpp or 779 # directories like /usr/src/myproject. Separate the files or directories with 780 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING 781 # Note: If this tag is empty the current directory is searched. 782 783 INPUT = libflashrom.c \ 784 libflashrom.h \ Nico Huber 4f21328 2019-06-15 17:33:49 +0200 [diff] [blame] 785 flashrom.c \ 786 layout.c \ Nico Huber a9fc4f4 2012-12-10 13:34:11 +0000 [diff] [blame] 787 788 # This tag can be used to specify the character encoding of the source files 789 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses 790 # libiconv (or the iconv built into libc) for the transcoding. See the libiconv 791 # documentation (see: http://www.gnu.org/software/libiconv) for the list of 792 # possible encodings. 793 # The default value is: UTF-8. 794 795 INPUT_ENCODING = UTF-8 796 797 # If the value of the INPUT tag contains directories, you can use the 798 # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and 799 # *.h) to filter out the source-files in the directories. 800 # 801 # Note that for custom extensions or not directly supported extensions you also 802 # need to set EXTENSION_MAPPING for the extension otherwise the files are not 803 # read by doxygen. 804 # 805 # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, 806 # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, 807 # *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, 808 # *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, 809 # *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf. 810 811 FILE_PATTERNS = 812 813 # The RECURSIVE tag can be used to specify whether or not subdirectories should 814 # be searched for input files as well. 815 # The default value is: NO. 816 817 RECURSIVE = NO 818 819 # The EXCLUDE tag can be used to specify files and/or directories that should be 820 # excluded from the INPUT source files. This way you can easily exclude a 821 # subdirectory from a directory tree whose root is specified with the INPUT tag. 822 # 823 # Note that relative paths are relative to the directory from which doxygen is 824 # run. 825 826 EXCLUDE = 827 828 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or 829 # directories that are symbolic links (a Unix file system feature) are excluded 830 # from the input. 831 # The default value is: NO. 832 833 EXCLUDE_SYMLINKS = NO 834 835 # If the value of the INPUT tag contains directories, you can use the 836 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 837 # certain files from those directories. 838 # 839 # Note that the wildcards are matched against the file with absolute path, so to 840 # exclude all test directories for example use the pattern */test/* 841 842 EXCLUDE_PATTERNS = 843 844 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 845 # (namespaces, classes, functions, etc.) that should be excluded from the 846 # output. The symbol name can be a fully qualified name, a word, or if the 847 # wildcard * is used, a substring. Examples: ANamespace, AClass, 848 # AClass::ANamespace, ANamespace::*Test 849 # 850 # Note that the wildcards are matched against the file with absolute path, so to 851 # exclude all test directories use the pattern */test/* 852 853 EXCLUDE_SYMBOLS = 854 855 # The EXAMPLE_PATH tag can be used to specify one or more files or directories 856 # that contain example code fragments that are included (see the \include 857 # command). 858 859 EXAMPLE_PATH = 860 861 # If the value of the EXAMPLE_PATH tag contains directories, you can use the 862 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and 863 # *.h) to filter out the source-files in the directories. If left blank all 864 # files are included. 865 866 EXAMPLE_PATTERNS = 867 868 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 869 # searched for input files to be used with the \include or \dontinclude commands 870 # irrespective of the value of the RECURSIVE tag. 871 # The default value is: NO. 872 873 EXAMPLE_RECURSIVE = NO 874 875 # The IMAGE_PATH tag can be used to specify one or more files or directories 876 # that contain images that are to be included in the documentation (see the 877 # \image command). 878 879 IMAGE_PATH = 880 881 # The INPUT_FILTER tag can be used to specify a program that doxygen should 882 # invoke to filter for each input file. Doxygen will invoke the filter program 883 # by executing (via popen()) the command: 884 # 885 # 886 # 887 # where is the value of the INPUT_FILTER tag, and is the 888 # name of an input file. Doxygen will then use the output that the filter 889 # program writes to standard output. If FILTER_PATTERNS is specified, this tag 890 # will be ignored. 891 # 892 # Note that the filter must not add or remove lines; it is applied before the 893 # code is scanned, but not when the output code is generated. If lines are added 894 # or removed, the anchors will not be placed correctly. 895 # 896 # Note that for custom extensions or not directly supported extensions you also 897 # need to set EXTENSION_MAPPING for the extension otherwise the files are not 898 # properly processed by doxygen. 899 900 INPUT_FILTER = 901 902 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 903 # basis. Doxygen will compare the file name with each pattern and apply the 904 # filter if there is a match. The filters are a list of the form: pattern=filter 905 # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how 906 # filters are used. If the FILTER_PATTERNS tag is empty or if none of the 907 # patterns match the file name, INPUT_FILTER is applied. 908 # 909 # Note that for custom extensions or not directly supported extensions you also 910 # need to set EXTENSION_MAPPING for the extension otherwise the files are not 911 # properly processed by doxygen. 912 913 FILTER_PATTERNS = 914 915 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 916 # INPUT_FILTER) will also be used to filter the input files that are used for 917 # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). 918 # The default value is: NO. 919 920 FILTER_SOURCE_FILES = NO 921 922 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file 923 # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and 924 # it is also possible to disable source filtering for a specific pattern using 925 # *.ext= (so without naming a filter). 926 # This tag requires that the tag FILTER_SOURCE_FILES is set to YES. 927 928 FILTER_SOURCE_PATTERNS = 929 930 # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that 931 # is part of the input, its contents will be placed on the main page 932 # (index.html). This can be useful if you have a project on for instance GitHub 933 # and want to reuse the introduction page also for the doxygen output. 934 935 USE_MDFILE_AS_MAINPAGE = 936 937 #--------------------------------------------------------------------------- 938 # Configuration options related to source browsing 939 #--------------------------------------------------------------------------- 940 941 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be 942 # generated. Documented entities will be cross-referenced with these sources. 943 # 944 # Note: To get rid of all source code in the generated output, make sure that 945 # also VERBATIM_HEADERS is set to NO. 946 # The default value is: NO. 947 948 SOURCE_BROWSER = NO 949 950 # Setting the INLINE_SOURCES tag to YES will include the body of functions, 951 # classes and enums directly into the documentation. 952 # The default value is: NO. 953 954 INLINE_SOURCES = NO 955 956 # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any 957 # special comment blocks from generated source code fragments. Normal C, C++ and 958 # Fortran comments will always remain visible. 959 # The default value is: YES. 960 961 STRIP_CODE_COMMENTS = YES 962 963 # If the REFERENCED_BY_RELATION tag is set to YES then for each documented 964 # function all documented functions referencing it will be listed. 965 # The default value is: NO. 966 967 REFERENCED_BY_RELATION = NO 968 969 # If the REFERENCES_RELATION tag is set to YES then for each documented function 970 # all documented entities called/used by that function will be listed. 971 # The default value is: NO. 972 973 REFERENCES_RELATION = NO 974 975 # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set 976 # to YES then the hyperlinks from functions in REFERENCES_RELATION and 977 # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will 978 # link to the documentation. 979 # The default value is: YES. 980 981 REFERENCES_LINK_SOURCE = YES 982 983 # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the 984 # source code will show a tooltip with additional information such as prototype, 985 # brief description and links to the definition and documentation. Since this 986 # will make the HTML file larger and loading of large files a bit slower, you 987 # can opt to disable this feature. 988 # The default value is: YES. 989 # This tag requires that the tag SOURCE_BROWSER is set to YES. 990 991 SOURCE_TOOLTIPS = YES 992 993 # If the USE_HTAGS tag is set to YES then the references to source code will 994 # point to the HTML generated by the htags(1) tool instead of doxygen built-in 995 # source browser. The htags tool is part of GNU's global source tagging system 996 # (see http://www.gnu.org/software/global/global.html). You will need version 997 # 4.8.6 or higher. 998 # 999 # To use it do the following: 1000 # - Install the latest version of global 1001 # - Enable SOURCE_BROWSER and USE_HTAGS in the config file 1002 # - Make sure the INPUT points to the root of the source tree 1003 # - Run doxygen as normal 1004 # 1005 # Doxygen will invoke htags (and that will in turn invoke gtags), so these 1006 # tools must be available from the command line (i.e. in the search path). 1007 # 1008 # The result: instead of the source browser generated by doxygen, the links to 1009 # source code will now point to the output of htags. 1010 # The default value is: NO. 1011 # This tag requires that the tag SOURCE_BROWSER is set to YES. 1012 1013 USE_HTAGS = NO 1014 1015 # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a 1016 # verbatim copy of the header file for each class for which an include is 1017 # specified. Set to NO to disable this. 1018 # See also: Section \class. 1019 # The default value is: YES. 1020 1021 VERBATIM_HEADERS = NO 1022 1023 #--------------------------------------------------------------------------- 1024 # Configuration options related to the alphabetical class index 1025 #--------------------------------------------------------------------------- 1026 1027 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all 1028 # compounds will be generated. Enable this if the project contains a lot of 1029 # classes, structs, unions or interfaces. 1030 # The default value is: YES. 1031 1032 ALPHABETICAL_INDEX = YES 1033 1034 # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in 1035 # which the alphabetical index list will be split. 1036 # Minimum value: 1, maximum value: 20, default value: 5. 1037 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1038 1039 COLS_IN_ALPHA_INDEX = 5 1040 1041 # In case all classes in a project start with a common prefix, all classes will 1042 # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag 1043 # can be used to specify a prefix (or a list of prefixes) that should be ignored 1044 # while generating the index headers. 1045 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1046 1047 IGNORE_PREFIX = 1048 1049 #--------------------------------------------------------------------------- 1050 # Configuration options related to the HTML output 1051 #--------------------------------------------------------------------------- 1052 1053 # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output 1054 # The default value is: YES. 1055 1056 GENERATE_HTML = YES 1057 1058 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a 1059 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1060 # it. 1061 # The default directory is: html. 1062 # This tag requires that the tag GENERATE_HTML is set to YES. 1063 1064 HTML_OUTPUT = html 1065 1066 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each 1067 # generated HTML page (for example: .htm, .php, .asp). 1068 # The default value is: .html. 1069 # This tag requires that the tag GENERATE_HTML is set to YES. 1070 1071 HTML_FILE_EXTENSION = .html 1072 1073 # The HTML_HEADER tag can be used to specify a user-defined HTML header file for 1074 # each generated HTML page. If the tag is left blank doxygen will generate a 1075 # standard header. 1076 # 1077 # To get valid HTML the header file that includes any scripts and style sheets 1078 # that doxygen needs, which is dependent on the configuration options used (e.g. 1079 # the setting GENERATE_TREEVIEW). It is highly recommended to start with a 1080 # default header using 1081 # doxygen -w html new_header.html new_footer.html new_stylesheet.css 1082 # YourConfigFile 1083 # and then modify the file new_header.html. See also section "Doxygen usage" 1084 # for information on how to generate the default header that doxygen normally 1085 # uses. 1086 # Note: The header is subject to change so you typically have to regenerate the 1087 # default header when upgrading to a newer version of doxygen. For a description 1088 # of the possible markers and block names see the documentation. 1089 # This tag requires that the tag GENERATE_HTML is set to YES. 1090 1091 HTML_HEADER = 1092 1093 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each 1094 # generated HTML page. If the tag is left blank doxygen will generate a standard 1095 # footer. See HTML_HEADER for more information on how to generate a default 1096 # footer and what special commands can be used inside the footer. See also 1097 # section "Doxygen usage" for information on how to generate the default footer 1098 # that doxygen normally uses. 1099 # This tag requires that the tag GENERATE_HTML is set to YES. 1100 1101 HTML_FOOTER = 1102 1103 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style 1104 # sheet that is used by each HTML page. It can be used to fine-tune the look of 1105 # the HTML output. If left blank doxygen will generate a default style sheet. 1106 # See also section "Doxygen usage" for information on how to generate the style 1107 # sheet that doxygen normally uses. 1108 # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as 1109 # it is more robust and this tag (HTML_STYLESHEET) will in the future become 1110 # obsolete. 1111 # This tag requires that the tag GENERATE_HTML is set to YES. 1112 1113 HTML_STYLESHEET = 1114 1115 # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined 1116 # cascading style sheets that are included after the standard style sheets 1117 # created by doxygen. Using this option one can overrule certain style aspects. 1118 # This is preferred over using HTML_STYLESHEET since it does not replace the 1119 # standard style sheet and is therefore more robust against future updates. 1120 # Doxygen will copy the style sheet files to the output directory. 1121 # Note: The order of the extra style sheet files is of importance (e.g. the last 1122 # style sheet in the list overrules the setting of the previous ones in the 1123 # list). For an example see the documentation. 1124 # This tag requires that the tag GENERATE_HTML is set to YES. 1125 1126 HTML_EXTRA_STYLESHEET = 1127 1128 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or 1129 # other source files which should be copied to the HTML output directory. Note 1130 # that these files will be copied to the base HTML output directory. Use the 1131 # \$relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these 1132 # files. In the HTML_STYLESHEET file, use the file name only. Also note that the 1133 # files will be copied as-is; there are no commands or markers available. 1134 # This tag requires that the tag GENERATE_HTML is set to YES. 1135 1136 HTML_EXTRA_FILES = 1137 1138 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen 1139 # will adjust the colors in the style sheet and background images according to 1140 # this color. Hue is specified as an angle on a colorwheel, see 1141 # http://en.wikipedia.org/wiki/Hue for more information. For instance the value 1142 # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 1143 # purple, and 360 is red again. 1144 # Minimum value: 0, maximum value: 359, default value: 220. 1145 # This tag requires that the tag GENERATE_HTML is set to YES. 1146 1147 HTML_COLORSTYLE_HUE = 220 1148 1149 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors 1150 # in the HTML output. For a value of 0 the output will use grayscales only. A 1151 # value of 255 will produce the most vivid colors. 1152 # Minimum value: 0, maximum value: 255, default value: 100. 1153 # This tag requires that the tag GENERATE_HTML is set to YES. 1154 1155 HTML_COLORSTYLE_SAT = 100 1156 1157 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the 1158 # luminance component of the colors in the HTML output. Values below 100 1159 # gradually make the output lighter, whereas values above 100 make the output 1160 # darker. The value divided by 100 is the actual gamma applied, so 80 represents 1161 # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not 1162 # change the gamma. 1163 # Minimum value: 40, maximum value: 240, default value: 80. 1164 # This tag requires that the tag GENERATE_HTML is set to YES. 1165 1166 HTML_COLORSTYLE_GAMMA = 80 1167 1168 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML 1169 # page will contain the date and time when the page was generated. Setting this 1170 # to YES can help to show when doxygen was last run and thus if the 1171 # documentation is up to date. 1172 # The default value is: NO. 1173 # This tag requires that the tag GENERATE_HTML is set to YES. 1174 1175 HTML_TIMESTAMP = YES 1176 1177 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 1178 # documentation will contain sections that can be hidden and shown after the 1179 # page has loaded. 1180 # The default value is: NO. 1181 # This tag requires that the tag GENERATE_HTML is set to YES. 1182 1183 HTML_DYNAMIC_SECTIONS = NO 1184 1185 # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries 1186 # shown in the various tree structured indices initially; the user can expand 1187 # and collapse entries dynamically later on. Doxygen will expand the tree to 1188 # such a level that at most the specified number of entries are visible (unless 1189 # a fully collapsed tree already exceeds this amount). So setting the number of 1190 # entries 1 will produce a full collapsed tree by default. 0 is a special value 1191 # representing an infinite number of entries and will result in a full expanded 1192 # tree by default. 1193 # Minimum value: 0, maximum value: 9999, default value: 100. 1194 # This tag requires that the tag GENERATE_HTML is set to YES. 1195 1196 HTML_INDEX_NUM_ENTRIES = 100 1197 1198 # If the GENERATE_DOCSET tag is set to YES, additional index files will be 1199 # generated that can be used as input for Apple's Xcode 3 integrated development 1200 # environment (see: http://developer.apple.com/tools/xcode/), introduced with 1201 # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a 1202 # Makefile in the HTML output directory. Running make will produce the docset in 1203 # that directory and running make install will install the docset in 1204 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at 1205 # startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html 1206 # for more information. 1207 # The default value is: NO. 1208 # This tag requires that the tag GENERATE_HTML is set to YES. 1209 1210 GENERATE_DOCSET = NO 1211 1212 # This tag determines the name of the docset feed. A documentation feed provides 1213 # an umbrella under which multiple documentation sets from a single provider 1214 # (such as a company or product suite) can be grouped. 1215 # The default value is: Doxygen generated docs. 1216 # This tag requires that the tag GENERATE_DOCSET is set to YES. 1217 1218 DOCSET_FEEDNAME = "Doxygen generated docs" 1219 1220 # This tag specifies a string that should uniquely identify the documentation 1221 # set bundle. This should be a reverse domain-name style string, e.g. 1222 # com.mycompany.MyDocSet. Doxygen will append .docset to the name. 1223 # The default value is: org.doxygen.Project. 1224 # This tag requires that the tag GENERATE_DOCSET is set to YES. 1225 1226 DOCSET_BUNDLE_ID = org.doxygen.Project 1227 1228 # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify 1229 # the documentation publisher. This should be a reverse domain-name style 1230 # string, e.g. com.mycompany.MyDocSet.documentation. 1231 # The default value is: org.doxygen.Publisher. 1232 # This tag requires that the tag GENERATE_DOCSET is set to YES. 1233 1234 DOCSET_PUBLISHER_ID = org.doxygen.Publisher 1235 1236 # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. 1237 # The default value is: Publisher. 1238 # This tag requires that the tag GENERATE_DOCSET is set to YES. 1239 1240 DOCSET_PUBLISHER_NAME = Publisher 1241 1242 # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three 1243 # additional HTML index files: index.hhp, index.hhc, and index.hhk. The 1244 # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop 1245 # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on 1246 # Windows. 1247 # 1248 # The HTML Help Workshop contains a compiler that can convert all HTML output 1249 # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML 1250 # files are now used as the Windows 98 help format, and will replace the old 1251 # Windows help format (.hlp) on all Windows platforms in the future. Compressed 1252 # HTML files also contain an index, a table of contents, and you can search for 1253 # words in the documentation. The HTML workshop also contains a viewer for 1254 # compressed HTML files. 1255 # The default value is: NO. 1256 # This tag requires that the tag GENERATE_HTML is set to YES. 1257 1258 GENERATE_HTMLHELP = NO 1259 1260 # The CHM_FILE tag can be used to specify the file name of the resulting .chm 1261 # file. You can add a path in front of the file if the result should not be 1262 # written to the html output directory. 1263 # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1264 1265 CHM_FILE = 1266 1267 # The HHC_LOCATION tag can be used to specify the location (absolute path 1268 # including file name) of the HTML help compiler (hhc.exe). If non-empty, 1269 # doxygen will try to run the HTML help compiler on the generated index.hhp. 1270 # The file has to be specified with full path. 1271 # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1272 1273 HHC_LOCATION = 1274 1275 # The GENERATE_CHI flag controls if a separate .chi index file is generated 1276 # (YES) or that it should be included in the master .chm file (NO). 1277 # The default value is: NO. 1278 # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1279 1280 GENERATE_CHI = NO 1281 1282 # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) 1283 # and project file content. 1284 # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1285 1286 CHM_INDEX_ENCODING = 1287 1288 # The BINARY_TOC flag controls whether a binary table of contents is generated 1289 # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it 1290 # enables the Previous and Next buttons. 1291 # The default value is: NO. 1292 # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1293 1294 BINARY_TOC = NO 1295 1296 # The TOC_EXPAND flag can be set to YES to add extra items for group members to 1297 # the table of contents of the HTML help documentation and to the tree view. 1298 # The default value is: NO. 1299 # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1300 1301 TOC_EXPAND = NO 1302 1303 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and 1304 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that 1305 # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help 1306 # (.qch) of the generated HTML documentation. 1307 # The default value is: NO. 1308 # This tag requires that the tag GENERATE_HTML is set to YES. 1309 1310 GENERATE_QHP = NO 1311 1312 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify 1313 # the file name of the resulting .qch file. The path specified is relative to 1314 # the HTML output folder. 1315 # This tag requires that the tag GENERATE_QHP is set to YES. 1316 1317 QCH_FILE = 1318 1319 # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help 1320 # Project output. For more information please see Qt Help Project / Namespace 1321 # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). 1322 # The default value is: org.doxygen.Project. 1323 # This tag requires that the tag GENERATE_QHP is set to YES. 1324 1325 QHP_NAMESPACE = org.doxygen.Project 1326 1327 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt 1328 # Help Project output. For more information please see Qt Help Project / Virtual 1329 # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- 1330 # folders). 1331 # The default value is: doc. 1332 # This tag requires that the tag GENERATE_QHP is set to YES. 1333 1334 QHP_VIRTUAL_FOLDER = doc 1335 1336 # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom 1337 # filter to add. For more information please see Qt Help Project / Custom 1338 # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- 1339 # filters). 1340 # This tag requires that the tag GENERATE_QHP is set to YES. 1341 1342 QHP_CUST_FILTER_NAME = 1343 1344 # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the 1345 # custom filter to add. For more information please see Qt Help Project / Custom 1346 # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- 1347 # filters). 1348 # This tag requires that the tag GENERATE_QHP is set to YES. 1349 1350 QHP_CUST_FILTER_ATTRS = 1351 1352 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this 1353 # project's filter section matches. Qt Help Project / Filter Attributes (see: 1354 # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). 1355 # This tag requires that the tag GENERATE_QHP is set to YES. 1356 1357 QHP_SECT_FILTER_ATTRS = 1358 1359 # The QHG_LOCATION tag can be used to specify the location of Qt's 1360 # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the 1361 # generated .qhp file. 1362 # This tag requires that the tag GENERATE_QHP is set to YES. 1363 1364 QHG_LOCATION = 1365 1366 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be 1367 # generated, together with the HTML files, they form an Eclipse help plugin. To 1368 # install this plugin and make it available under the help contents menu in 1369 # Eclipse, the contents of the directory containing the HTML and XML files needs 1370 # to be copied into the plugins directory of eclipse. The name of the directory 1371 # within the plugins directory should be the same as the ECLIPSE_DOC_ID value. 1372 # After copying Eclipse needs to be restarted before the help appears. 1373 # The default value is: NO. 1374 # This tag requires that the tag GENERATE_HTML is set to YES. 1375 1376 GENERATE_ECLIPSEHELP = NO 1377 1378 # A unique identifier for the Eclipse help plugin. When installing the plugin 1379 # the directory name containing the HTML and XML files should also have this 1380 # name. Each documentation set should have its own identifier. 1381 # The default value is: org.doxygen.Project. 1382 # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. 1383 1384 ECLIPSE_DOC_ID = org.doxygen.Project 1385 1386 # If you want full control over the layout of the generated HTML pages it might 1387 # be necessary to disable the index and replace it with your own. The 1388 # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top 1389 # of each HTML page. A value of NO enables the index and the value YES disables 1390 # it. Since the tabs in the index contain the same information as the navigation 1391 # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. 1392 # The default value is: NO. 1393 # This tag requires that the tag GENERATE_HTML is set to YES. 1394 1395 DISABLE_INDEX = NO 1396 1397 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 1398 # structure should be generated to display hierarchical information. If the tag 1399 # value is set to YES, a side panel will be generated containing a tree-like 1400 # index structure (just like the one that is generated for HTML Help). For this 1401 # to work a browser that supports JavaScript, DHTML, CSS and frames is required 1402 # (i.e. any modern browser). Windows users are probably better off using the 1403 # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can 1404 # further fine-tune the look of the index. As an example, the default style 1405 # sheet generated by doxygen has an example that shows how to put an image at 1406 # the root of the tree instead of the PROJECT_NAME. Since the tree basically has 1407 # the same information as the tab index, you could consider setting 1408 # DISABLE_INDEX to YES when enabling this option. 1409 # The default value is: NO. 1410 # This tag requires that the tag GENERATE_HTML is set to YES. 1411 1412 GENERATE_TREEVIEW = NO 1413 1414 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that 1415 # doxygen will group on one line in the generated HTML documentation. 1416 # 1417 # Note that a value of 0 will completely suppress the enum values from appearing 1418 # in the overview section. 1419 # Minimum value: 0, maximum value: 20, default value: 4. 1420 # This tag requires that the tag GENERATE_HTML is set to YES. 1421 1422 ENUM_VALUES_PER_LINE = 4 1423 1424 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used 1425 # to set the initial width (in pixels) of the frame in which the tree is shown. 1426 # Minimum value: 0, maximum value: 1500, default value: 250. 1427 # This tag requires that the tag GENERATE_HTML is set to YES. 1428 1429 TREEVIEW_WIDTH = 250 1430 1431 # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to 1432 # external symbols imported via tag files in a separate window. 1433 # The default value is: NO. 1434 # This tag requires that the tag GENERATE_HTML is set to YES. 1435 1436 EXT_LINKS_IN_WINDOW = NO 1437 1438 # Use this tag to change the font size of LaTeX formulas included as images in 1439 # the HTML documentation. When you change the font size after a successful 1440 # doxygen run you need to manually remove any form_*.png images from the HTML 1441 # output directory to force them to be regenerated. 1442 # Minimum value: 8, maximum value: 50, default value: 10. 1443 # This tag requires that the tag GENERATE_HTML is set to YES. 1444 1445 FORMULA_FONTSIZE = 10 1446 1447 # Use the FORMULA_TRANPARENT tag to determine whether or not the images 1448 # generated for formulas are transparent PNGs. Transparent PNGs are not 1449 # supported properly for IE 6.0, but are supported on all modern browsers. 1450 # 1451 # Note that when changing this option you need to delete any form_*.png files in 1452 # the HTML output directory before the changes have effect. 1453 # The default value is: YES. 1454 # This tag requires that the tag GENERATE_HTML is set to YES. 1455 1456 FORMULA_TRANSPARENT = YES 1457 1458 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see 1459 # http://www.mathjax.org) which uses client side Javascript for the rendering 1460 # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX 1461 # installed or if you want to formulas look prettier in the HTML output. When 1462 # enabled you may also need to install MathJax separately and configure the path 1463 # to it using the MATHJAX_RELPATH option. 1464 # The default value is: NO. 1465 # This tag requires that the tag GENERATE_HTML is set to YES. 1466 1467 USE_MATHJAX = NO 1468 1469 # When MathJax is enabled you can set the default output format to be used for 1470 # the MathJax output. See the MathJax site (see: 1471 # http://docs.mathjax.org/en/latest/output.html) for more details. 1472 # Possible values are: HTML-CSS (which is slower, but has the best 1473 # compatibility), NativeMML (i.e. MathML) and SVG. 1474 # The default value is: HTML-CSS. 1475 # This tag requires that the tag USE_MATHJAX is set to YES. 1476 1477 MATHJAX_FORMAT = HTML-CSS 1478 1479 # When MathJax is enabled you need to specify the location relative to the HTML 1480 # output directory using the MATHJAX_RELPATH option. The destination directory 1481 # should contain the MathJax.js script. For instance, if the mathjax directory 1482 # is located at the same level as the HTML output directory, then 1483 # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax 1484 # Content Delivery Network so you can quickly see the result without installing 1485 # MathJax. However, it is strongly recommended to install a local copy of 1486 # MathJax from http://www.mathjax.org before deployment. 1487 # The default value is: http://cdn.mathjax.org/mathjax/latest. 1488 # This tag requires that the tag USE_MATHJAX is set to YES. 1489 1490 MATHJAX_RELPATH = http://www.mathjax.org/mathjax 1491 1492 # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax 1493 # extension names that should be enabled during MathJax rendering. For example 1494 # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols 1495 # This tag requires that the tag USE_MATHJAX is set to YES. 1496 1497 MATHJAX_EXTENSIONS = 1498 1499 # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces 1500 # of code that will be used on startup of the MathJax code. See the MathJax site 1501 # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an 1502 # example see the documentation. 1503 # This tag requires that the tag USE_MATHJAX is set to YES. 1504 1505 MATHJAX_CODEFILE = 1506 1507 # When the SEARCHENGINE tag is enabled doxygen will generate a search box for 1508 # the HTML output. The underlying search engine uses javascript and DHTML and 1509 # should work on any modern browser. Note that when using HTML help 1510 # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) 1511 # there is already a search function so this one should typically be disabled. 1512 # For large projects the javascript based search engine can be slow, then 1513 # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to 1514 # search using the keyboard; to jump to the search box use + S 1515 # (what the is depends on the OS and browser, but it is typically 1516 # , /