1# Doxyfile 1.4.5 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# The PROJECT_NAME tag is a single word (or a sequence of words surrounded 18# by quotes) that should identify the project. 19 20PROJECT_NAME = QtXmlPatterns 21 22# The PROJECT_NUMBER tag can be used to enter a project or revision number. 23# This could be handy for archiving the generated documentation or 24# if some version control system is used. 25 26PROJECT_NUMBER = 27 28# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 29# base path where the generated documentation will be put. 30# If a relative path is entered, it will be relative to the location 31# where doxygen was started. If left blank the current directory will be used. 32 33OUTPUT_DIRECTORY = internal-docs 34 35# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 36# 4096 sub-directories (in 2 levels) under the output directory of each output 37# format and will distribute the generated files over these directories. 38# Enabling this option can be useful when feeding doxygen a huge amount of 39# source files, where putting all generated files in the same directory would 40# otherwise cause performance problems for the file system. 41 42CREATE_SUBDIRS = NO 43 44# The OUTPUT_LANGUAGE tag is used to specify the language in which all 45# documentation generated by doxygen is written. Doxygen will use this 46# information to generate all constant output in the proper language. 47# The default language is English, other supported languages are: 48# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, 49# Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese, 50# Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian, 51# Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, 52# Swedish, and Ukrainian. 53 54OUTPUT_LANGUAGE = English 55 56# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 57# include brief member descriptions after the members that are listed in 58# the file and class documentation (similar to JavaDoc). 59# Set to NO to disable this. 60 61BRIEF_MEMBER_DESC = YES 62 63# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 64# the brief description of a member or function before the detailed description. 65# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 66# brief descriptions will be completely suppressed. 67 68REPEAT_BRIEF = YES 69 70# This tag implements a quasi-intelligent brief description abbreviator 71# that is used to form the text in various listings. Each string 72# in this list, if found as the leading text of the brief description, will be 73# stripped from the text and the result after processing the whole list, is 74# used as the annotated text. Otherwise, the brief description is used as-is. 75# If left blank, the following values are used ("$name" is automatically 76# replaced with the name of the entity): "The $name class" "The $name widget" 77# "The $name file" "is" "provides" "specifies" "contains" 78# "represents" "a" "an" "the" 79 80ABBREVIATE_BRIEF = 81 82# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 83# Doxygen will generate a detailed section even if there is only a brief 84# description. 85 86ALWAYS_DETAILED_SEC = NO 87 88# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 89# inherited members of a class in the documentation of that class as if those 90# members were ordinary class members. Constructors, destructors and assignment 91# operators of the base classes will not be shown. 92 93INLINE_INHERITED_MEMB = NO 94 95# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 96# path before files name in the file list and in the header files. If set 97# to NO the shortest path that makes the file name unique will be used. 98 99FULL_PATH_NAMES = YES 100 101# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 102# can be used to strip a user-defined part of the path. Stripping is 103# only done if one of the specified strings matches the left-hand part of 104# the path. The tag can be used to show relative paths in the file list. 105# If left blank the directory from which doxygen is run is used as the 106# path to strip. 107 108STRIP_FROM_PATH = 109 110# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 111# the path mentioned in the documentation of a class, which tells 112# the reader which header file to include in order to use a class. 113# If left blank only the name of the header file containing the class 114# definition is used. Otherwise one should specify the include paths that 115# are normally passed to the compiler using the -I flag. 116 117STRIP_FROM_INC_PATH = 118 119# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 120# (but less readable) file names. This can be useful is your file systems 121# doesn't support long names like on DOS, Mac, or CD-ROM. 122 123SHORT_NAMES = NO 124 125# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 126# will interpret the first line (until the first dot) of a JavaDoc-style 127# comment as the brief description. If set to NO, the JavaDoc 128# comments will behave just like the Qt-style comments (thus requiring an 129# explicit @brief command for a brief description. 130 131JAVADOC_AUTOBRIEF = NO 132 133# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 134# treat a multi-line C++ special comment block (i.e. a block of //! or /// 135# comments) as a brief description. This used to be the default behaviour. 136# The new default is to treat a multi-line C++ comment block as a detailed 137# description. Set this tag to YES if you prefer the old behaviour instead. 138 139MULTILINE_CPP_IS_BRIEF = NO 140 141# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 142# member inherits the documentation from any documented member that it 143# re-implements. 144 145INHERIT_DOCS = YES 146 147# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce 148# a new page for each member. If set to NO, the documentation of a member will 149# be part of the file/class/namespace that contains it. 150 151SEPARATE_MEMBER_PAGES = NO 152 153# The TAB_SIZE tag can be used to set the number of spaces in a tab. 154# Doxygen uses this value to replace tabs by spaces in code fragments. 155 156TAB_SIZE = 4 157 158# This tag can be used to specify a number of aliases that acts 159# as commands in the documentation. An alias has the form "name=value". 160# For example adding "sideeffect=\par Side Effects:\n" will allow you to 161# put the command \sideeffect (or @sideeffect) in the documentation, which 162# will result in a user-defined paragraph with heading "Side Effects:". 163# You can put \n's in the value part of an alias to insert newlines. 164 165ALIASES = 166 167# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 168# sources only. Doxygen will then generate output that is more tailored for C. 169# For instance, some of the names that are used will be different. The list 170# of all members will be omitted, etc. 171 172OPTIMIZE_OUTPUT_FOR_C = NO 173 174# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java 175# sources only. Doxygen will then generate output that is more tailored for Java. 176# For instance, namespaces will be presented as packages, qualified scopes 177# will look different, etc. 178 179OPTIMIZE_OUTPUT_JAVA = NO 180 181# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to 182# include (a tag file for) the STL sources as input, then you should 183# set this tag to YES in order to let doxygen match functions declarations and 184# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. 185# func(std::string) {}). This also make the inheritance and collaboration 186# diagrams that involve STL classes more complete and accurate. 187 188BUILTIN_STL_SUPPORT = YES 189 190# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 191# tag is set to YES, then doxygen will reuse the documentation of the first 192# member in the group (if any) for the other members of the group. By default 193# all members of a group must be documented explicitly. 194 195DISTRIBUTE_GROUP_DOC = NO 196 197# Set the SUBGROUPING tag to YES (the default) to allow class member groups of 198# the same type (for instance a group of public functions) to be put as a 199# subgroup of that type (e.g. under the Public Functions section). Set it to 200# NO to prevent subgrouping. Alternatively, this can be done per class using 201# the \nosubgrouping command. 202 203SUBGROUPING = YES 204 205#--------------------------------------------------------------------------- 206# Build related configuration options 207#--------------------------------------------------------------------------- 208 209# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 210# documentation are documented, even if no documentation was available. 211# Private class members and static file members will be hidden unless 212# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES 213 214EXTRACT_ALL = YES 215 216# If the EXTRACT_PRIVATE tag is set to YES all private members of a class 217# will be included in the documentation. 218 219EXTRACT_PRIVATE = yes 220 221# If the EXTRACT_STATIC tag is set to YES all static members of a file 222# will be included in the documentation. 223 224EXTRACT_STATIC = YES 225 226# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 227# defined locally in source files will be included in the documentation. 228# If set to NO only classes defined in header files are included. 229 230EXTRACT_LOCAL_CLASSES = YES 231 232# This flag is only useful for Objective-C code. When set to YES local 233# methods, which are defined in the implementation section but not in 234# the interface are included in the documentation. 235# If set to NO (the default) only methods in the interface are included. 236 237EXTRACT_LOCAL_METHODS = NO 238 239# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 240# undocumented members of documented classes, files or namespaces. 241# If set to NO (the default) these members will be included in the 242# various overviews, but no documentation section is generated. 243# This option has no effect if EXTRACT_ALL is enabled. 244 245HIDE_UNDOC_MEMBERS = NO 246 247# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 248# undocumented classes that are normally visible in the class hierarchy. 249# If set to NO (the default) these classes will be included in the various 250# overviews. This option has no effect if EXTRACT_ALL is enabled. 251 252HIDE_UNDOC_CLASSES = NO 253 254# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 255# friend (class|struct|union) declarations. 256# If set to NO (the default) these declarations will be included in the 257# documentation. 258 259HIDE_FRIEND_COMPOUNDS = NO 260 261# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 262# documentation blocks found inside the body of a function. 263# If set to NO (the default) these blocks will be appended to the 264# function's detailed documentation block. 265 266HIDE_IN_BODY_DOCS = NO 267 268# The INTERNAL_DOCS tag determines if documentation 269# that is typed after a \internal command is included. If the tag is set 270# to NO (the default) then the documentation will be excluded. 271# Set it to YES to include the internal documentation. 272 273INTERNAL_DOCS = YES 274 275# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 276# file names in lower-case letters. If set to YES upper-case letters are also 277# allowed. This is useful if you have classes or files whose names only differ 278# in case and if your file system supports case sensitive file names. Windows 279# and Mac users are advised to set this option to NO. 280 281CASE_SENSE_NAMES = YES 282 283# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 284# will show members with their full class and namespace scopes in the 285# documentation. If set to YES the scope will be hidden. 286 287HIDE_SCOPE_NAMES = NO 288 289# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 290# will put a list of the files that are included by a file in the documentation 291# of that file. 292 293SHOW_INCLUDE_FILES = YES 294 295# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 296# is inserted in the documentation for inline members. 297 298INLINE_INFO = YES 299 300# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 301# will sort the (detailed) documentation of file and class members 302# alphabetically by member name. If set to NO the members will appear in 303# declaration order. 304 305SORT_MEMBER_DOCS = YES 306 307# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 308# brief documentation of file, namespace and class members alphabetically 309# by member name. If set to NO (the default) the members will appear in 310# declaration order. 311 312SORT_BRIEF_DOCS = YES 313 314# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 315# sorted by fully-qualified names, including namespaces. If set to 316# NO (the default), the class list will be sorted only by class name, 317# not including the namespace part. 318# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 319# Note: This option applies only to the class list, not to the 320# alphabetical list. 321 322SORT_BY_SCOPE_NAME = YES 323 324# The GENERATE_TODOLIST tag can be used to enable (YES) or 325# disable (NO) the todo list. This list is created by putting \todo 326# commands in the documentation. 327 328GENERATE_TODOLIST = YES 329 330# The GENERATE_TESTLIST tag can be used to enable (YES) or 331# disable (NO) the test list. This list is created by putting \test 332# commands in the documentation. 333 334GENERATE_TESTLIST = YES 335 336# The GENERATE_BUGLIST tag can be used to enable (YES) or 337# disable (NO) the bug list. This list is created by putting \bug 338# commands in the documentation. 339 340GENERATE_BUGLIST = YES 341 342# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 343# disable (NO) the deprecated list. This list is created by putting 344# \deprecated commands in the documentation. 345 346GENERATE_DEPRECATEDLIST= YES 347 348# The ENABLED_SECTIONS tag can be used to enable conditional 349# documentation sections, marked by \if sectionname ... \endif. 350 351ENABLED_SECTIONS = 352 353# The MAX_INITIALIZER_LINES tag determines the maximum number of lines 354# the initial value of a variable or define consists of for it to appear in 355# the documentation. If the initializer consists of more lines than specified 356# here it will be hidden. Use a value of 0 to hide initializers completely. 357# The appearance of the initializer of individual variables and defines in the 358# documentation can be controlled using \showinitializer or \hideinitializer 359# command in the documentation regardless of this setting. 360 361MAX_INITIALIZER_LINES = 30 362 363# Set the SHOW_USED_FILES tag to NO to disable the list of files generated 364# at the bottom of the documentation of classes and structs. If set to YES the 365# list will mention the files that were used to generate the documentation. 366 367SHOW_USED_FILES = YES 368 369# If the sources in your project are distributed over multiple directories 370# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy 371# in the documentation. The default is YES. 372 373SHOW_DIRECTORIES = YES 374 375# The FILE_VERSION_FILTER tag can be used to specify a program or script that 376# doxygen should invoke to get the current version for each file (typically from the 377# version control system). Doxygen will invoke the program by executing (via 378# popen()) the command <command> <input-file>, where <command> is the value of 379# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file 380# provided by doxygen. Whatever the program writes to standard output 381# is used as the file version. See the manual for examples. 382 383FILE_VERSION_FILTER = 384 385#--------------------------------------------------------------------------- 386# configuration options related to warning and progress messages 387#--------------------------------------------------------------------------- 388 389# The QUIET tag can be used to turn on/off the messages that are generated 390# by doxygen. Possible values are YES and NO. If left blank NO is used. 391 392# Having it set to not, output a lot of status messages to stdout, we still 393# get the warning into the log file 394QUIET = YES 395 396# The WARNINGS tag can be used to turn on/off the warning messages that are 397# generated by doxygen. Possible values are YES and NO. If left blank 398# NO is used. 399 400WARNINGS = YES 401 402# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 403# for undocumented members. If EXTRACT_ALL is set to YES then this flag will 404# automatically be disabled. 405 406WARN_IF_UNDOCUMENTED = NO 407 408# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 409# potential errors in the documentation, such as not documenting some 410# parameters in a documented function, or documenting parameters that 411# don't exist or using markup commands wrongly. 412 413WARN_IF_DOC_ERROR = YES 414 415# This WARN_NO_PARAMDOC option can be abled to get warnings for 416# functions that are documented, but have no documentation for their parameters 417# or return value. If set to NO (the default) doxygen will only warn about 418# wrong or incomplete parameter documentation, but not about the absence of 419# documentation. 420 421WARN_NO_PARAMDOC = NO 422 423# The WARN_FORMAT tag determines the format of the warning messages that 424# doxygen can produce. The string should contain the $file, $line, and $text 425# tags, which will be replaced by the file and line number from which the 426# warning originated and the warning text. Optionally the format may contain 427# $version, which will be replaced by the version of the file (if it could 428# be obtained via FILE_VERSION_FILTER) 429 430WARN_FORMAT = "$file:$line: $text" 431 432# The WARN_LOGFILE tag can be used to specify a file to which warning 433# and error messages should be written. If left blank the output is written 434# to stderr. 435 436WARN_LOGFILE = internal-docs/doxygen.log 437 438#--------------------------------------------------------------------------- 439# configuration options related to the input files 440#--------------------------------------------------------------------------- 441 442# The INPUT tag can be used to specify the files and/or directories that contain 443# documented source files. You may enter file names like "myfile.cpp" or 444# directories like "/usr/src/myproject". Separate the files or directories 445# with spaces. 446 447INPUT = . ../../tests/auto/xmlpatternsxqts/ ../../tests/auto/xmlpatternsview 448 449# If the value of the INPUT tag contains directories, you can use the 450# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 451# and *.h) to filter out the source-files in the directories. If left 452# blank the following patterns are tested: 453 454FILE_PATTERNS = *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.dox *.gperf 455 456# The RECURSIVE tag can be used to turn specify whether or not subdirectories 457# should be searched for input files as well. Possible values are YES and NO. 458# If left blank NO is used. 459 460RECURSIVE = YES 461 462# The EXCLUDE tag can be used to specify files and/or directories that should 463# excluded from the INPUT source files. This way you can easily exclude a 464# subdirectory from a directory tree whose root is specified with the INPUT tag. 465 466EXCLUDE = 467 468# The EXCLUDE_SYMLINKS tag can be used select whether or not files or 469# directories that are symbolic links (a Unix filesystem feature) are excluded 470# from the input. 471 472EXCLUDE_SYMLINKS = NO 473 474# If the value of the INPUT tag contains directories, you can use the 475# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 476# certain files from those directories. Note that the wildcards are matched 477# against the file with absolute path, so to exclude all test directories 478# for example use the pattern */test/* 479 480# The Qt API uses qdoc and Doxygen doesn't like its tags, so exclude the q* files. 481EXCLUDE_PATTERNS = *.moc *.moc.cpp moc_*.cpp ui_*.h 482 483# The EXAMPLE_PATH tag can be used to specify one or more files or 484# directories that contain example code fragments that are included (see 485# the \include command). 486 487EXAMPLE_PATH = 488 489# If the value of the EXAMPLE_PATH tag contains directories, you can use the 490# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 491# and *.h) to filter out the source-files in the directories. If left 492# blank all files are included. 493 494EXAMPLE_PATTERNS = 495 496# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 497# searched for input files to be used with the \include or \dontinclude 498# commands irrespective of the value of the RECURSIVE tag. 499# Possible values are YES and NO. If left blank NO is used. 500 501EXAMPLE_RECURSIVE = YES 502 503# The IMAGE_PATH tag can be used to specify one or more files or 504# directories that contain image that are included in the documentation (see 505# the \image command). 506 507IMAGE_PATH = 508 509# The INPUT_FILTER tag can be used to specify a program that doxygen should 510# invoke to filter for each input file. Doxygen will invoke the filter program 511# by executing (via popen()) the command <filter> <input-file>, where <filter> 512# is the value of the INPUT_FILTER tag, and <input-file> is the name of an 513# input file. Doxygen will then use the output that the filter program writes 514# to standard output. If FILTER_PATTERNS is specified, this tag will be 515# ignored. 516 517INPUT_FILTER = 518 519# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 520# basis. Doxygen will compare the file name with each pattern and apply the 521# filter if there is a match. The filters are a list of the form: 522# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 523# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER 524# is applied to all files. 525 526FILTER_PATTERNS = 527 528# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 529# INPUT_FILTER) will be used to filter the input files when producing source 530# files to browse (i.e. when SOURCE_BROWSER is set to YES). 531 532FILTER_SOURCE_FILES = NO 533 534#--------------------------------------------------------------------------- 535# configuration options related to source browsing 536#--------------------------------------------------------------------------- 537 538# If the SOURCE_BROWSER tag is set to YES then a list of source files will 539# be generated. Documented entities will be cross-referenced with these sources. 540# Note: To get rid of all source code in the generated output, make sure also 541# VERBATIM_HEADERS is set to NO. 542 543SOURCE_BROWSER = YES 544 545# Setting the INLINE_SOURCES tag to YES will include the body 546# of functions and classes directly in the documentation. 547 548INLINE_SOURCES = NO 549 550# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 551# doxygen to hide any special comment blocks from generated source code 552# fragments. Normal C and C++ comments will always remain visible. 553 554STRIP_CODE_COMMENTS = YES 555 556# If the REFERENCED_BY_RELATION tag is set to YES (the default) 557# then for each documented function all documented 558# functions referencing it will be listed. 559 560REFERENCED_BY_RELATION = YES 561 562# If the REFERENCES_RELATION tag is set to YES (the default) 563# then for each documented function all documented entities 564# called/used by that function will be listed. 565 566REFERENCES_RELATION = YES 567 568# If the USE_HTAGS tag is set to YES then the references to source code 569# will point to the HTML generated by the htags(1) tool instead of doxygen 570# built-in source browser. The htags tool is part of GNU's global source 571# tagging system (see http://www.gnu.org/software/global/global.html). You 572# will need version 4.8.6 or higher. 573 574USE_HTAGS = NO 575 576# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 577# will generate a verbatim copy of the header file for each class for 578# which an include is specified. Set to NO to disable this. 579 580VERBATIM_HEADERS = YES 581 582#--------------------------------------------------------------------------- 583# configuration options related to the alphabetical class index 584#--------------------------------------------------------------------------- 585 586# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 587# of all compounds will be generated. Enable this if the project 588# contains a lot of classes, structs, unions or interfaces. 589 590ALPHABETICAL_INDEX = NO 591 592# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 593# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 594# in which this list will be split (can be a number in the range [1..20]) 595 596COLS_IN_ALPHA_INDEX = 5 597 598# In case all classes in a project start with a common prefix, all 599# classes will be put under the same header in the alphabetical index. 600# The IGNORE_PREFIX tag can be used to specify one or more prefixes that 601# should be ignored while generating the index headers. 602 603IGNORE_PREFIX = 604 605#--------------------------------------------------------------------------- 606# configuration options related to the HTML output 607#--------------------------------------------------------------------------- 608 609# If the GENERATE_HTML tag is set to YES (the default) Doxygen will 610# generate HTML output. 611 612GENERATE_HTML = YES 613 614# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 615# If a relative path is entered the value of OUTPUT_DIRECTORY will be 616# put in front of it. If left blank `html' will be used as the default path. 617 618HTML_OUTPUT = 619 620# The HTML_FILE_EXTENSION tag can be used to specify the file extension for 621# each generated HTML page (for example: .htm,.php,.asp). If it is left blank 622# doxygen will generate files with .html extension. 623 624HTML_FILE_EXTENSION = .html 625 626# The HTML_HEADER tag can be used to specify a personal HTML header for 627# each generated HTML page. If it is left blank doxygen will generate a 628# standard header. 629 630HTML_HEADER = 631 632# The HTML_FOOTER tag can be used to specify a personal HTML footer for 633# each generated HTML page. If it is left blank doxygen will generate a 634# standard footer. 635 636HTML_FOOTER = 637 638# The HTML_STYLESHEET tag can be used to specify a user-defined cascading 639# style sheet that is used by each HTML page. It can be used to 640# fine-tune the look of the HTML output. If the tag is left blank doxygen 641# will generate a default style sheet. Note that doxygen will try to copy 642# the style sheet file to the HTML output directory, so don't put your own 643# stylesheet in the HTML output directory as well, or it will be erased! 644 645HTML_STYLESHEET = 646 647# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 648# files or namespaces will be aligned in HTML using tables. If set to 649# NO a bullet list will be used. 650 651HTML_ALIGN_MEMBERS = YES 652 653# If the GENERATE_HTMLHELP tag is set to YES, additional index files 654# will be generated that can be used as input for tools like the 655# Microsoft HTML help workshop to generate a compressed HTML help file (.chm) 656# of the generated HTML documentation. 657 658GENERATE_HTMLHELP = NO 659 660# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 661# be used to specify the file name of the resulting .chm file. You 662# can add a path in front of the file if the result should not be 663# written to the html output directory. 664 665CHM_FILE = 666 667# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 668# be used to specify the location (absolute path including file name) of 669# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 670# the HTML help compiler on the generated index.hhp. 671 672HHC_LOCATION = 673 674# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 675# controls if a separate .chi index file is generated (YES) or that 676# it should be included in the master .chm file (NO). 677 678GENERATE_CHI = NO 679 680# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 681# controls whether a binary table of contents is generated (YES) or a 682# normal table of contents (NO) in the .chm file. 683 684BINARY_TOC = NO 685 686# The TOC_EXPAND flag can be set to YES to add extra items for group members 687# to the contents of the HTML help documentation and to the tree view. 688 689TOC_EXPAND = NO 690 691# The DISABLE_INDEX tag can be used to turn on/off the condensed index at 692# top of each HTML page. The value NO (the default) enables the index and 693# the value YES disables it. 694 695DISABLE_INDEX = NO 696 697# This tag can be used to set the number of enum values (range [1..20]) 698# that doxygen will group on one line in the generated HTML documentation. 699 700ENUM_VALUES_PER_LINE = 4 701 702# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be 703# generated containing a tree-like index structure (just like the one that 704# is generated for HTML Help). For this to work a browser that supports 705# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, 706# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are 707# probably better off using the HTML help feature. 708 709GENERATE_TREEVIEW = NO 710 711# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 712# used to set the initial width (in pixels) of the frame in which the tree 713# is shown. 714 715TREEVIEW_WIDTH = 250 716 717#--------------------------------------------------------------------------- 718# configuration options related to the LaTeX output 719#--------------------------------------------------------------------------- 720 721# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 722# generate Latex output. 723 724GENERATE_LATEX = NO 725 726# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 727# If a relative path is entered the value of OUTPUT_DIRECTORY will be 728# put in front of it. If left blank `latex' will be used as the default path. 729 730LATEX_OUTPUT = latex 731 732# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 733# invoked. If left blank `latex' will be used as the default command name. 734 735LATEX_CMD_NAME = latex 736 737# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 738# generate index for LaTeX. If left blank `makeindex' will be used as the 739# default command name. 740 741MAKEINDEX_CMD_NAME = makeindex 742 743# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 744# LaTeX documents. This may be useful for small projects and may help to 745# save some trees in general. 746 747COMPACT_LATEX = NO 748 749# The PAPER_TYPE tag can be used to set the paper type that is used 750# by the printer. Possible values are: a4, a4wide, letter, legal and 751# executive. If left blank a4wide will be used. 752 753PAPER_TYPE = a4wide 754 755# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 756# packages that should be included in the LaTeX output. 757 758EXTRA_PACKAGES = 759 760# The LATEX_HEADER tag can be used to specify a personal LaTeX header for 761# the generated latex document. The header should contain everything until 762# the first chapter. If it is left blank doxygen will generate a 763# standard header. Notice: only use this tag if you know what you are doing! 764 765LATEX_HEADER = 766 767# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 768# is prepared for conversion to pdf (using ps2pdf). The pdf file will 769# contain links (just like the HTML output) instead of page references 770# This makes the output suitable for online browsing using a pdf viewer. 771 772PDF_HYPERLINKS = NO 773 774# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 775# plain latex in the generated Makefile. Set this option to YES to get a 776# higher quality PDF documentation. 777 778USE_PDFLATEX = NO 779 780# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 781# command to the generated LaTeX files. This will instruct LaTeX to keep 782# running if errors occur, instead of asking the user for help. 783# This option is also used when generating formulas in HTML. 784 785LATEX_BATCHMODE = NO 786 787# If LATEX_HIDE_INDICES is set to YES then doxygen will not 788# include the index chapters (such as File Index, Compound Index, etc.) 789# in the output. 790 791LATEX_HIDE_INDICES = NO 792 793#--------------------------------------------------------------------------- 794# configuration options related to the RTF output 795#--------------------------------------------------------------------------- 796 797# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 798# The RTF output is optimized for Word 97 and may not look very pretty with 799# other RTF readers or editors. 800 801GENERATE_RTF = NO 802 803# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 804# If a relative path is entered the value of OUTPUT_DIRECTORY will be 805# put in front of it. If left blank `rtf' will be used as the default path. 806 807RTF_OUTPUT = rtf 808 809# If the COMPACT_RTF tag is set to YES Doxygen generates more compact 810# RTF documents. This may be useful for small projects and may help to 811# save some trees in general. 812 813COMPACT_RTF = NO 814 815# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 816# will contain hyperlink fields. The RTF file will 817# contain links (just like the HTML output) instead of page references. 818# This makes the output suitable for online browsing using WORD or other 819# programs which support those fields. 820# Note: wordpad (write) and others do not support links. 821 822RTF_HYPERLINKS = NO 823 824# Load stylesheet definitions from file. Syntax is similar to doxygen's 825# config file, i.e. a series of assignments. You only have to provide 826# replacements, missing definitions are set to their default value. 827 828RTF_STYLESHEET_FILE = 829 830# Set optional variables used in the generation of an rtf document. 831# Syntax is similar to doxygen's config file. 832 833RTF_EXTENSIONS_FILE = 834 835#--------------------------------------------------------------------------- 836# configuration options related to the man page output 837#--------------------------------------------------------------------------- 838 839# If the GENERATE_MAN tag is set to YES (the default) Doxygen will 840# generate man pages 841 842GENERATE_MAN = NO 843 844# The MAN_OUTPUT tag is used to specify where the man pages will be put. 845# If a relative path is entered the value of OUTPUT_DIRECTORY will be 846# put in front of it. If left blank `man' will be used as the default path. 847 848MAN_OUTPUT = man 849 850# The MAN_EXTENSION tag determines the extension that is added to 851# the generated man pages (default is the subroutine's section .3) 852 853MAN_EXTENSION = .3 854 855# If the MAN_LINKS tag is set to YES and Doxygen generates man output, 856# then it will generate one additional man file for each entity 857# documented in the real man page(s). These additional files 858# only source the real man page, but without them the man command 859# would be unable to find the correct page. The default is NO. 860 861MAN_LINKS = NO 862 863#--------------------------------------------------------------------------- 864# configuration options related to the XML output 865#--------------------------------------------------------------------------- 866 867# If the GENERATE_XML tag is set to YES Doxygen will 868# generate an XML file that captures the structure of 869# the code including all documentation. 870 871GENERATE_XML = NO 872 873# The XML_OUTPUT tag is used to specify where the XML pages will be put. 874# If a relative path is entered the value of OUTPUT_DIRECTORY will be 875# put in front of it. If left blank `xml' will be used as the default path. 876 877XML_OUTPUT = xml 878 879# The XML_SCHEMA tag can be used to specify an XML schema, 880# which can be used by a validating XML parser to check the 881# syntax of the XML files. 882 883XML_SCHEMA = 884 885# The XML_DTD tag can be used to specify an XML DTD, 886# which can be used by a validating XML parser to check the 887# syntax of the XML files. 888 889XML_DTD = 890 891# If the XML_PROGRAMLISTING tag is set to YES Doxygen will 892# dump the program listings (including syntax highlighting 893# and cross-referencing information) to the XML output. Note that 894# enabling this will significantly increase the size of the XML output. 895 896XML_PROGRAMLISTING = YES 897 898#--------------------------------------------------------------------------- 899# configuration options for the AutoGen Definitions output 900#--------------------------------------------------------------------------- 901 902# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 903# generate an AutoGen Definitions (see autogen.sf.net) file 904# that captures the structure of the code including all 905# documentation. Note that this feature is still experimental 906# and incomplete at the moment. 907 908GENERATE_AUTOGEN_DEF = NO 909 910#--------------------------------------------------------------------------- 911# configuration options related to the Perl module output 912#--------------------------------------------------------------------------- 913 914# If the GENERATE_PERLMOD tag is set to YES Doxygen will 915# generate a Perl module file that captures the structure of 916# the code including all documentation. Note that this 917# feature is still experimental and incomplete at the 918# moment. 919 920GENERATE_PERLMOD = NO 921 922# If the PERLMOD_LATEX tag is set to YES Doxygen will generate 923# the necessary Makefile rules, Perl scripts and LaTeX code to be able 924# to generate PDF and DVI output from the Perl module output. 925 926PERLMOD_LATEX = NO 927 928# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 929# nicely formatted so it can be parsed by a human reader. This is useful 930# if you want to understand what is going on. On the other hand, if this 931# tag is set to NO the size of the Perl module output will be much smaller 932# and Perl will parse it just the same. 933 934PERLMOD_PRETTY = YES 935 936# The names of the make variables in the generated doxyrules.make file 937# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 938# This is useful so different doxyrules.make files included by the same 939# Makefile don't overwrite each other's variables. 940 941PERLMOD_MAKEVAR_PREFIX = 942 943#--------------------------------------------------------------------------- 944# Configuration options related to the preprocessor 945#--------------------------------------------------------------------------- 946 947# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 948# evaluate all C-preprocessor directives found in the sources and include 949# files. 950 951ENABLE_PREPROCESSING = YES 952 953# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 954# names in the source code. If set to NO (the default) only conditional 955# compilation will be performed. Macro expansion can be done in a controlled 956# way by setting EXPAND_ONLY_PREDEF to YES. 957 958MACRO_EXPANSION = YES 959 960# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 961# then the macro expansion is limited to the macros specified with the 962# PREDEFINED and EXPAND_AS_DEFINED tags. 963 964EXPAND_ONLY_PREDEF = YES 965 966# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 967# in the INCLUDE_PATH (see below) will be search if a #include is found. 968 969SEARCH_INCLUDES = YES 970 971# The INCLUDE_PATH tag can be used to specify one or more directories that 972# contain include files that are not input files but should be processed by 973# the preprocessor. 974 975INCLUDE_PATH = 976 977# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 978# patterns (like *.h and *.hpp) to filter out the header-files in the 979# directories. If left blank, the patterns specified with FILE_PATTERNS will 980# be used. 981 982INCLUDE_FILE_PATTERNS = 983 984# The PREDEFINED tag can be used to specify one or more macro names that 985# are defined before the preprocessor is started (similar to the -D option of 986# gcc). The argument of the tag is a list of macros of the form: name 987# or name=definition (no spaces). If the definition and the = are 988# omitted =1 is assumed. To prevent a macro definition from being 989# undefined via #undef or recursively expanded use the := operator 990# instead of the = operator. 991 992PREDEFINED = Q_SLOTS="slots" \ 993 Q_SIGNALS="signals" 994 995# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 996# this tag can be used to specify a list of macro names that should be expanded. 997# The macro definition that is found in the sources will be used. 998# Use the PREDEFINED tag if you want to use a different macro definition. 999 1000EXPAND_AS_DEFINED = 1001 1002# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 1003# doxygen's preprocessor will remove all function-like macros that are alone 1004# on a line, have an all uppercase name, and do not end with a semicolon. Such 1005# function macros are typically used for boiler-plate code, and will confuse 1006# the parser if not removed. 1007 1008SKIP_FUNCTION_MACROS = YES 1009 1010#--------------------------------------------------------------------------- 1011# Configuration::additions related to external references 1012#--------------------------------------------------------------------------- 1013 1014# The TAGFILES option can be used to specify one or more tagfiles. 1015# Optionally an initial location of the external documentation 1016# can be added for each tagfile. The format of a tag file without 1017# this location is as follows: 1018# TAGFILES = file1 file2 ... 1019# Adding location for the tag files is done as follows: 1020# TAGFILES = file1=loc1 "file2 = loc2" ... 1021# where "loc1" and "loc2" can be relative or absolute paths or 1022# URLs. If a location is present for each tag, the installdox tool 1023# does not have to be run to correct the links. 1024# Note that each tag file must have a unique name 1025# (where the name does NOT include the path) 1026# If a tag file is not located in the directory in which doxygen 1027# is run, you must also specify the path to the tagfile here. 1028 1029TAGFILES = 1030 1031# When a file name is specified after GENERATE_TAGFILE, doxygen will create 1032# a tag file that is based on the input files it reads. 1033 1034GENERATE_TAGFILE = 1035 1036# If the ALLEXTERNALS tag is set to YES all external classes will be listed 1037# in the class index. If set to NO only the inherited external classes 1038# will be listed. 1039 1040ALLEXTERNALS = NO 1041 1042# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 1043# in the modules index. If set to NO, only the current project's groups will 1044# be listed. 1045 1046EXTERNAL_GROUPS = YES 1047 1048# The PERL_PATH should be the absolute path and name of the perl script 1049# interpreter (i.e. the result of `which perl'). 1050 1051PERL_PATH = /usr/bin/perl 1052 1053#--------------------------------------------------------------------------- 1054# Configuration options related to the dot tool 1055#--------------------------------------------------------------------------- 1056 1057# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 1058# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base 1059# or super classes. Setting the tag to NO turns the diagrams off. Note that 1060# this option is superseded by the HAVE_DOT option below. This is only a 1061# fallback. It is recommended to install and use dot, since it yields more 1062# powerful graphs. 1063 1064CLASS_DIAGRAMS = YES 1065 1066# If set to YES, the inheritance and collaboration graphs will hide 1067# inheritance and usage relations if the target is undocumented 1068# or is not a class. 1069 1070HIDE_UNDOC_RELATIONS = YES 1071 1072# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 1073# available from the path. This tool is part of Graphviz, a graph visualization 1074# toolkit from AT&T and Lucent Bell Labs. The other options in this section 1075# have no effect if this option is set to NO (the default) 1076 1077HAVE_DOT = YES 1078 1079CALLER_GRAPH = NO 1080 1081# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 1082# will generate a graph for each documented class showing the direct and 1083# indirect inheritance relations. Setting this tag to YES will force the 1084# the CLASS_DIAGRAMS tag to NO. 1085 1086CLASS_GRAPH = YES 1087 1088# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 1089# will generate a graph for each documented class showing the direct and 1090# indirect implementation dependencies (inheritance, containment, and 1091# class references variables) of the class with other documented classes. 1092 1093COLLABORATION_GRAPH = YES 1094 1095# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen 1096# will generate a graph for groups, showing the direct groups dependencies 1097 1098GROUP_GRAPHS = YES 1099 1100# If the UML_LOOK tag is set to YES doxygen will generate inheritance and 1101# collaboration diagrams in a style similar to the OMG's Unified Modeling 1102# Language. 1103 1104UML_LOOK = NO 1105 1106# If set to YES, the inheritance and collaboration graphs will show the 1107# relations between templates and their instances. 1108 1109TEMPLATE_RELATIONS = YES 1110 1111# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 1112# tags are set to YES then doxygen will generate a graph for each documented 1113# file showing the direct and indirect include dependencies of the file with 1114# other documented files. 1115 1116INCLUDE_GRAPH = YES 1117 1118# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 1119# HAVE_DOT tags are set to YES then doxygen will generate a graph for each 1120# documented header file showing the documented files that directly or 1121# indirectly include this file. 1122 1123INCLUDED_BY_GRAPH = YES 1124 1125# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will 1126# generate a call dependency graph for every global function or class method. 1127# Note that enabling this option will significantly increase the time of a run. 1128# So in most cases it will be better to enable call graphs for selected 1129# functions only using the \callgraph command. 1130 1131CALL_GRAPH = NO 1132 1133# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 1134# will graphical hierarchy of all classes instead of a textual one. 1135 1136GRAPHICAL_HIERARCHY = YES 1137 1138# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES 1139# then doxygen will show the dependencies a directory has on other directories 1140# in a graphical way. The dependency relations are determined by the #include 1141# relations between the files in the directories. 1142 1143DIRECTORY_GRAPH = YES 1144 1145# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 1146# generated by dot. Possible values are png, jpg, or gif 1147# If left blank png will be used. 1148 1149DOT_IMAGE_FORMAT = png 1150 1151# The tag DOT_PATH can be used to specify the path where the dot tool can be 1152# found. If left blank, it is assumed the dot tool can be found in the path. 1153 1154DOT_PATH = 1155 1156# The DOTFILE_DIRS tag can be used to specify one or more directories that 1157# contain dot files that are included in the documentation (see the 1158# \dotfile command). 1159 1160DOTFILE_DIRS = schema/doc/ 1161 1162# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 1163# background. This is disabled by default, which results in a white background. 1164# Warning: Depending on the platform used, enabling this option may lead to 1165# badly anti-aliased labels on the edges of a graph (i.e. they become hard to 1166# read). 1167 1168DOT_TRANSPARENT = YES 1169 1170# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output 1171# files in one run (i.e. multiple -o and -T options on the command line). This 1172# makes dot run faster, but since only newer versions of dot (>1.8.10) 1173# support this, this feature is disabled by default. 1174 1175DOT_MULTI_TARGETS = YES 1176 1177# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 1178# generate a legend page explaining the meaning of the various boxes and 1179# arrows in the dot generated graphs. 1180 1181GENERATE_LEGEND = YES 1182 1183# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 1184# remove the intermediate dot files that are used to generate 1185# the various graphs. 1186 1187DOT_CLEANUP = YES 1188 1189#--------------------------------------------------------------------------- 1190# Configuration::additions related to the search engine 1191#--------------------------------------------------------------------------- 1192 1193# The SEARCHENGINE tag specifies whether or not a search engine should be 1194# used. If set to NO the values of all tags below this one will be ignored. 1195 1196SEARCHENGINE = NO 1197