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