1# Copyright (C) 2003, 2005 MySQL AB 2# Use is subject to license terms 3# 4# This program is free software; you can redistribute it and/or modify 5# it under the terms of the GNU General Public License, version 2.0, 6# as published by the Free Software Foundation. 7# 8# This program is also distributed with certain software (including 9# but not limited to OpenSSL) that is licensed under separate terms, 10# as designated in a particular file or component or in included license 11# documentation. The authors of MySQL hereby grant you an additional 12# permission to link the program and your derivative works with the 13# separately licensed software that they have included with MySQL. 14# 15# This program is distributed in the hope that it will be useful, 16# but WITHOUT ANY WARRANTY; without even the implied warranty of 17# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18# GNU General Public License, version 2.0, for more details. 19# 20# You should have received a copy of the GNU General Public License 21# along with this program; if not, write to the Free Software 22# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA 23 24# Doxyfile 1.2.12 25 26# This file describes the settings to be used by the documentation system 27# doxygen (www.doxygen.org) for a project 28# 29# All text after a hash (#) is considered a comment and will be ignored 30# The format is: 31# TAG = value [value, ...] 32# For lists items can also be appended using: 33# TAG += value [value, ...] 34# Values that contain spaces should be placed between quotes (" ") 35 36#--------------------------------------------------------------------------- 37# General configuration options 38#--------------------------------------------------------------------------- 39DETAILS_AT_TOP = YES 40HIDE_FRIEND_COMPOUNDS = YES 41 42# The PROJECT_NAME tag is a single word (or a sequence of words surrounded 43# by quotes) that should identify the project. 44 45PROJECT_NAME = 46 47# The PROJECT_NUMBER tag can be used to enter a project or revision number. 48# This could be handy for archiving the generated documentation or 49# if some version control system is used. 50 51PROJECT_NUMBER = 52 53# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 54# base path where the generated documentation will be put. 55# If a relative path is entered, it will be relative to the location 56# where doxygen was started. If left blank the current directory will be used. 57 58OUTPUT_DIRECTORY = 59 60# The OUTPUT_LANGUAGE tag is used to specify the language in which all 61# documentation generated by doxygen is written. Doxygen will use this 62# information to generate all constant output in the proper language. 63# The default language is English, other supported languages are: 64# Brazilian, Chinese, Croatian, Czech, Danish, Dutch, Finnish, French, 65# German, Hungarian, Italian, Japanese, Korean, Norwegian, Polish, 66# Portuguese, Romanian, Russian, Slovak, Slovene, Spanish and Swedish. 67 68OUTPUT_LANGUAGE = English 69 70# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 71# documentation are documented, even if no documentation was available. 72# Private class members and static file members will be hidden unless 73# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES 74 75EXTRACT_ALL = NO 76 77# If the EXTRACT_PRIVATE tag is set to YES all private members of a class 78# will be included in the documentation. 79 80EXTRACT_PRIVATE = NO 81 82# If the EXTRACT_STATIC tag is set to YES all static members of a file 83# will be included in the documentation. 84 85EXTRACT_STATIC = YES 86 87# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 88# undocumented members of documented classes, files or namespaces. 89# If set to NO (the default) these members will be included in the 90# various overviews, but no documentation section is generated. 91# This option has no effect if EXTRACT_ALL is enabled. 92 93HIDE_UNDOC_MEMBERS = NO 94 95# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 96# undocumented classes that are normally visible in the class hierarchy. 97# If set to NO (the default) these class will be included in the various 98# overviews. This option has no effect if EXTRACT_ALL is enabled. 99 100HIDE_UNDOC_CLASSES = NO 101 102# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 103# include brief member descriptions after the members that are listed in 104# the file and class documentation (similar to JavaDoc). 105# Set to NO to disable this. 106 107BRIEF_MEMBER_DESC = YES 108 109# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 110# the brief description of a member or function before the detailed description. 111# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 112# brief descriptions will be completely suppressed. 113 114REPEAT_BRIEF = YES 115 116# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 117# Doxygen will generate a detailed section even if there is only a brief 118# description. 119 120ALWAYS_DETAILED_SEC = NO 121 122# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 123# path before files name in the file list and in the header files. If set 124# to NO the shortest path that makes the file name unique will be used. 125 126FULL_PATH_NAMES = NO 127 128# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 129# can be used to strip a user defined part of the path. Stripping is 130# only done if one of the specified strings matches the left-hand part of 131# the path. It is allowed to use relative paths in the argument list. 132 133STRIP_FROM_PATH = 134 135# The INTERNAL_DOCS tag determines if documentation 136# that is typed after a \internal command is included. If the tag is set 137# to NO (the default) then the documentation will be excluded. 138# Set it to YES to include the internal documentation. 139 140INTERNAL_DOCS = NO 141 142# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 143# doxygen to hide any special comment blocks from generated source code 144# fragments. Normal C and C++ comments will always remain visible. 145 146STRIP_CODE_COMMENTS = YES 147 148# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 149# file names in lower case letters. If set to YES upper case letters are also 150# allowed. This is useful if you have classes or files whose names only differ 151# in case and if your file system supports case sensitive file names. Windows 152# users are adviced to set this option to NO. 153 154CASE_SENSE_NAMES = YES 155 156# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 157# (but less readable) file names. This can be useful is your file systems 158# doesn't support long names like on DOS, Mac, or CD-ROM. 159 160SHORT_NAMES = NO 161 162# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 163# will show members with their full class and namespace scopes in the 164# documentation. If set to YES the scope will be hidden. 165 166HIDE_SCOPE_NAMES = NO 167 168# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 169# will generate a verbatim copy of the header file for each class for 170# which an include is specified. Set to NO to disable this. 171 172VERBATIM_HEADERS = NO 173 174# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 175# will put list of the files that are included by a file in the documentation 176# of that file. 177 178SHOW_INCLUDE_FILES = YES 179 180# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 181# will interpret the first line (until the first dot) of a JavaDoc-style 182# comment as the brief description. If set to NO, the JavaDoc 183# comments will behave just like the Qt-style comments (thus requiring an 184# explict @brief command for a brief description. 185 186JAVADOC_AUTOBRIEF = NO 187 188# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 189# member inherits the documentation from any documented member that it 190# reimplements. 191 192INHERIT_DOCS = YES 193 194# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 195# is inserted in the documentation for inline members. 196 197INLINE_INFO = YES 198 199# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 200# will sort the (detailed) documentation of file and class members 201# alphabetically by member name. If set to NO the members will appear in 202# declaration order. 203 204SORT_MEMBER_DOCS = YES 205 206# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 207# tag is set to YES, then doxygen will reuse the documentation of the first 208# member in the group (if any) for the other members of the group. By default 209# all members of a group must be documented explicitly. 210 211DISTRIBUTE_GROUP_DOC = NO 212 213# The TAB_SIZE tag can be used to set the number of spaces in a tab. 214# Doxygen uses this value to replace tabs by spaces in code fragments. 215 216TAB_SIZE = 2 217 218# The GENERATE_TODOLIST tag can be used to enable (YES) or 219# disable (NO) the todo list. This list is created by putting \todo 220# commands in the documentation. 221 222GENERATE_TODOLIST = YES 223 224# The GENERATE_TESTLIST tag can be used to enable (YES) or 225# disable (NO) the test list. This list is created by putting \test 226# commands in the documentation. 227 228GENERATE_TESTLIST = YES 229 230# The GENERATE_BUGLIST tag can be used to enable (YES) or 231# disable (NO) the bug list. This list is created by putting \bug 232# commands in the documentation. 233 234GENERATE_BUGLIST = YES 235 236# This tag can be used to specify a number of aliases that acts 237# as commands in the documentation. An alias has the form "name=value". 238# For example adding "sideeffect=\par Side Effects:\n" will allow you to 239# put the command \sideeffect (or @sideeffect) in the documentation, which 240# will result in a user defined paragraph with heading "Side Effects:". 241# You can put \n's in the value part of an alias to insert newlines. 242 243ALIASES = 244 245# The ENABLED_SECTIONS tag can be used to enable conditional 246# documentation sections, marked by \if sectionname ... \endif. 247 248ENABLED_SECTIONS = 249 250# The MAX_INITIALIZER_LINES tag determines the maximum number of lines 251# the initial value of a variable or define consist of for it to appear in 252# the documentation. If the initializer consists of more lines than specified 253# here it will be hidden. Use a value of 0 to hide initializers completely. 254# The appearance of the initializer of individual variables and defines in the 255# documentation can be controlled using \showinitializer or \hideinitializer 256# command in the documentation regardless of this setting. 257 258MAX_INITIALIZER_LINES = 30 259 260# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources 261# only. Doxygen will then generate output that is more tailored for C. 262# For instance some of the names that are used will be different. The list 263# of all members will be omitted, etc. 264 265OPTIMIZE_OUTPUT_FOR_C = NO 266 267# Set the SHOW_USED_FILES tag to NO to disable the list of files generated 268# at the bottom of the documentation of classes and structs. If set to YES the 269# list will mention the files that were used to generate the documentation. 270 271SHOW_USED_FILES = NO 272 273#--------------------------------------------------------------------------- 274# configuration options related to warning and progress messages 275#--------------------------------------------------------------------------- 276 277# The QUIET tag can be used to turn on/off the messages that are generated 278# by doxygen. Possible values are YES and NO. If left blank NO is used. 279 280QUIET = NO 281 282# The WARNINGS tag can be used to turn on/off the warning messages that are 283# generated by doxygen. Possible values are YES and NO. If left blank 284# NO is used. 285 286WARNINGS = YES 287 288# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 289# for undocumented members. If EXTRACT_ALL is set to YES then this flag will 290# automatically be disabled. 291 292WARN_IF_UNDOCUMENTED = YES 293 294# The WARN_FORMAT tag determines the format of the warning messages that 295# doxygen can produce. The string should contain the $file, $line, and $text 296# tags, which will be replaced by the file and line number from which the 297# warning originated and the warning text. 298 299WARN_FORMAT = 300 301# The WARN_LOGFILE tag can be used to specify a file to which warning 302# and error messages should be written. If left blank the output is written 303# to stderr. 304 305WARN_LOGFILE = 306 307#--------------------------------------------------------------------------- 308# configuration options related to the input files 309#--------------------------------------------------------------------------- 310 311# The INPUT tag can be used to specify the files and/or directories that contain 312# documented source files. You may enter file names like "myfile.cpp" or 313# directories like "/usr/src/myproject". Separate the files or directories 314# with spaces. 315 316INPUT = . 317 318# If the value of the INPUT tag contains directories, you can use the 319# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 320# and *.h) to filter out the source-files in the directories. If left 321# blank file matching one of the following patterns are included: 322# *.c *.cc *.cxx *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp 323# *.h++ *.idl 324 325FILE_PATTERNS = 326 327# The RECURSIVE tag can be used to turn specify whether or not subdirectories 328# should be searched for input files as well. Possible values are YES and NO. 329# If left blank NO is used. 330 331RECURSIVE = NO 332 333# The EXCLUDE tag can be used to specify files and/or directories that should 334# excluded from the INPUT source files. This way you can easily exclude a 335# subdirectory from a directory tree whose root is specified with the INPUT tag. 336 337EXCLUDE = 338 339# If the value of the INPUT tag contains directories, you can use the 340# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 341# certain files from those directories. 342 343EXCLUDE_PATTERNS = 344 345# The EXAMPLE_PATH tag can be used to specify one or more files or 346# directories that contain example code fragments that are included (see 347# the \include command). 348 349EXAMPLE_PATH = . 350 351# If the value of the EXAMPLE_PATH tag contains directories, you can use the 352# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 353# and *.h) to filter out the source-files in the directories. If left 354# blank all files are included. 355 356EXAMPLE_PATTERNS = 357 358# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 359# searched for input files to be used with the \include or \dontinclude 360# commands irrespective of the value of the RECURSIVE tag. 361# Possible values are YES and NO. If left blank NO is used. 362 363EXAMPLE_RECURSIVE = NO 364 365# The IMAGE_PATH tag can be used to specify one or more files or 366# directories that contain image that are included in the documentation (see 367# the \image command). 368 369IMAGE_PATH = 370 371# The INPUT_FILTER tag can be used to specify a program that doxygen should 372# invoke to filter for each input file. Doxygen will invoke the filter program 373# by executing (via popen()) the command <filter> <input-file>, where <filter> 374# is the value of the INPUT_FILTER tag, and <input-file> is the name of an 375# input file. Doxygen will then use the output that the filter program writes 376# to standard output. 377 378INPUT_FILTER = 379 380# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 381# INPUT_FILTER) will be used to filter the input files when producing source 382# files to browse. 383 384FILTER_SOURCE_FILES = NO 385 386#--------------------------------------------------------------------------- 387# configuration options related to source browsing 388#--------------------------------------------------------------------------- 389 390# If the SOURCE_BROWSER tag is set to YES then a list of source files will 391# be generated. Documented entities will be cross-referenced with these sources. 392 393SOURCE_BROWSER = NO 394 395# Setting the INLINE_SOURCES tag to YES will include the body 396# of functions and classes directly in the documentation. 397 398INLINE_SOURCES = NO 399 400# If the REFERENCED_BY_RELATION tag is set to YES (the default) 401# then for each documented function all documented 402# functions referencing it will be listed. 403 404REFERENCED_BY_RELATION = YES 405 406# If the REFERENCES_RELATION tag is set to YES (the default) 407# then for each documented function all documented entities 408# called/used by that function will be listed. 409 410REFERENCES_RELATION = YES 411 412#--------------------------------------------------------------------------- 413# configuration options related to the alphabetical class index 414#--------------------------------------------------------------------------- 415 416# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 417# of all compounds will be generated. Enable this if the project 418# contains a lot of classes, structs, unions or interfaces. 419 420ALPHABETICAL_INDEX = NO 421 422# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 423# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 424# in which this list will be split (can be a number in the range [1..20]) 425 426COLS_IN_ALPHA_INDEX = 5 427 428# In case all classes in a project start with a common prefix, all 429# classes will be put under the same header in the alphabetical index. 430# The IGNORE_PREFIX tag can be used to specify one or more prefixes that 431# should be ignored while generating the index headers. 432 433IGNORE_PREFIX = 434 435#--------------------------------------------------------------------------- 436# configuration options related to the HTML output 437#--------------------------------------------------------------------------- 438 439# If the GENERATE_HTML tag is set to YES (the default) Doxygen will 440# generate HTML output. 441 442GENERATE_HTML = YES 443 444# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 445# If a relative path is entered the value of OUTPUT_DIRECTORY will be 446# put in front of it. If left blank `html' will be used as the default path. 447 448HTML_OUTPUT = ../.doxyout/ndbapi.html 449 450# The HTML_HEADER tag can be used to specify a personal HTML header for 451# each generated HTML page. If it is left blank doxygen will generate a 452# standard header. 453 454HTML_HEADER = 455 456# The HTML_FOOTER tag can be used to specify a personal HTML footer for 457# each generated HTML page. If it is left blank doxygen will generate a 458# standard footer. 459 460HTML_FOOTER = footer.html 461 462# The HTML_STYLESHEET tag can be used to specify a user defined cascading 463# style sheet that is used by each HTML page. It can be used to 464# fine-tune the look of the HTML output. If the tag is left blank doxygen 465# will generate a default style sheet 466 467HTML_STYLESHEET = 468 469# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 470# files or namespaces will be aligned in HTML using tables. If set to 471# NO a bullet list will be used. 472 473HTML_ALIGN_MEMBERS = NO 474 475# If the GENERATE_HTMLHELP tag is set to YES, additional index files 476# will be generated that can be used as input for tools like the 477# Microsoft HTML help workshop to generate a compressed HTML help file (.chm) 478# of the generated HTML documentation. 479 480GENERATE_HTMLHELP = NO 481 482# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 483# controls if a separate .chi index file is generated (YES) or that 484# it should be included in the master .chm file (NO). 485 486GENERATE_CHI = NO 487 488# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 489# controls whether a binary table of contents is generated (YES) or a 490# normal table of contents (NO) in the .chm file. 491 492BINARY_TOC = NO 493 494# The TOC_EXPAND flag can be set to YES to add extra items for group members 495# to the contents of the Html help documentation and to the tree view. 496 497TOC_EXPAND = NO 498 499# The DISABLE_INDEX tag can be used to turn on/off the condensed index at 500# top of each HTML page. The value NO (the default) enables the index and 501# the value YES disables it. 502 503DISABLE_INDEX = YES 504 505# This tag can be used to set the number of enum values (range [1..20]) 506# that doxygen will group on one line in the generated HTML documentation. 507 508ENUM_VALUES_PER_LINE = 4 509 510# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be 511# generated containing a tree-like index structure (just like the one that 512# is generated for HTML Help). For this to work a browser that supports 513# JavaScript and frames is required (for instance Mozilla, Netscape 4.0+, 514# or Internet explorer 4.0+). Note that for large projects the tree generation 515# can take a very long time. In such cases it is better to disable this feature. 516# Windows users are probably better off using the HTML help feature. 517 518GENERATE_TREEVIEW = NO 519 520# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 521# used to set the initial width (in pixels) of the frame in which the tree 522# is shown. 523 524TREEVIEW_WIDTH = 250 525 526#--------------------------------------------------------------------------- 527# configuration options related to the LaTeX output 528#--------------------------------------------------------------------------- 529 530# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 531# generate Latex output. 532 533GENERATE_LATEX = YES 534 535# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 536# If a relative path is entered the value of OUTPUT_DIRECTORY will be 537# put in front of it. If left blank `latex' will be used as the default path. 538 539LATEX_OUTPUT = ../.doxyout/ndbapi.latex 540 541# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 542# LaTeX documents. This may be useful for small projects and may help to 543# save some trees in general. 544 545COMPACT_LATEX = NO 546 547# The PAPER_TYPE tag can be used to set the paper type that is used 548# by the printer. Possible values are: a4, a4wide, letter, legal and 549# executive. If left blank a4wide will be used. 550 551PAPER_TYPE = 552 553# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 554# packages that should be included in the LaTeX output. 555 556EXTRA_PACKAGES = 557 558# The LATEX_HEADER tag can be used to specify a personal LaTeX header for 559# the generated latex document. The header should contain everything until 560# the first chapter. If it is left blank doxygen will generate a 561# standard header. Notice: only use this tag if you know what you are doing! 562 563LATEX_HEADER = 564 565# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 566# is prepared for conversion to pdf (using ps2pdf). The pdf file will 567# contain links (just like the HTML output) instead of page references 568# This makes the output suitable for online browsing using a pdf viewer. 569 570PDF_HYPERLINKS = YES 571 572# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 573# plain latex in the generated Makefile. Set this option to YES to get a 574# higher quality PDF documentation. 575 576USE_PDFLATEX = YES 577 578# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 579# command to the generated LaTeX files. This will instruct LaTeX to keep 580# running if errors occur, instead of asking the user for help. 581# This option is also used when generating formulas in HTML. 582 583LATEX_BATCHMODE = NO 584 585#--------------------------------------------------------------------------- 586# configuration options related to the RTF output 587#--------------------------------------------------------------------------- 588 589# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 590# The RTF output is optimised for Word 97 and may not look very pretty with 591# other RTF readers or editors. 592 593GENERATE_RTF = NO 594 595# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 596# If a relative path is entered the value of OUTPUT_DIRECTORY will be 597# put in front of it. If left blank `rtf' will be used as the default path. 598 599RTF_OUTPUT = ../ndbapi.rtf 600 601# If the COMPACT_RTF tag is set to YES Doxygen generates more compact 602# RTF documents. This may be useful for small projects and may help to 603# save some trees in general. 604 605COMPACT_RTF = NO 606 607# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 608# will contain hyperlink fields. The RTF file will 609# contain links (just like the HTML output) instead of page references. 610# This makes the output suitable for online browsing using WORD or other 611# programs which support those fields. 612# Note: wordpad (write) and others do not support links. 613 614RTF_HYPERLINKS = NO 615 616# Load stylesheet definitions from file. Syntax is similar to doxygen's 617# config file, i.e. a series of assigments. You only have to provide 618# replacements, missing definitions are set to their default value. 619 620RTF_STYLESHEET_FILE = 621 622# Set optional variables used in the generation of an rtf document. 623# Syntax is similar to doxygen's config file. 624 625RTF_EXTENSIONS_FILE = 626 627#--------------------------------------------------------------------------- 628# configuration options related to the man page output 629#--------------------------------------------------------------------------- 630 631# If the GENERATE_MAN tag is set to YES (the default) Doxygen will 632# generate man pages 633 634GENERATE_MAN = NO 635 636# The MAN_OUTPUT tag is used to specify where the man pages will be put. 637# If a relative path is entered the value of OUTPUT_DIRECTORY will be 638# put in front of it. If left blank `man' will be used as the default path. 639 640MAN_OUTPUT = 641 642# The MAN_EXTENSION tag determines the extension that is added to 643# the generated man pages (default is the subroutine's section .3) 644 645MAN_EXTENSION = 646 647# If the MAN_LINKS tag is set to YES and Doxygen generates man output, 648# then it will generate one additional man file for each entity 649# documented in the real man page(s). These additional files 650# only source the real man page, but without them the man command 651# would be unable to find the correct page. The default is NO. 652 653MAN_LINKS = NO 654 655#--------------------------------------------------------------------------- 656# configuration options related to the XML output 657#--------------------------------------------------------------------------- 658 659# If the GENERATE_XML tag is set to YES Doxygen will 660# generate an XML file that captures the structure of 661# the code including all documentation. Note that this 662# feature is still experimental and incomplete at the 663# moment. 664 665GENERATE_XML = NO 666 667#--------------------------------------------------------------------------- 668# Configuration options related to the preprocessor 669#--------------------------------------------------------------------------- 670 671# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 672# evaluate all C-preprocessor directives found in the sources and include 673# files. 674 675ENABLE_PREPROCESSING = YES 676 677# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 678# names in the source code. If set to NO (the default) only conditional 679# compilation will be performed. Macro expansion can be done in a controlled 680# way by setting EXPAND_ONLY_PREDEF to YES. 681 682MACRO_EXPANSION = YES 683 684# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 685# then the macro expansion is limited to the macros specified with the 686# PREDEFINED and EXPAND_AS_PREDEFINED tags. 687 688EXPAND_ONLY_PREDEF = YES 689 690# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 691# in the INCLUDE_PATH (see below) will be search if a #include is found. 692 693SEARCH_INCLUDES = YES 694 695# The INCLUDE_PATH tag can be used to specify one or more directories that 696# contain include files that are not input files but should be processed by 697# the preprocessor. 698 699INCLUDE_PATH = 700 701# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 702# patterns (like *.h and *.hpp) to filter out the header-files in the 703# directories. If left blank, the patterns specified with FILE_PATTERNS will 704# be used. 705 706INCLUDE_FILE_PATTERNS = 707 708# The PREDEFINED tag can be used to specify one or more macro names that 709# are defined before the preprocessor is started (similar to the -D option of 710# gcc). The argument of the tag is a list of macros of the form: name 711# or name=definition (no spaces). If the definition and the = are 712# omitted =1 is assumed. 713 714PREDEFINED = DOXYGEN_SHOULD_SKIP_DEPRECATED \ 715 DOXYGEN_SHOULD_SKIP_INTERNAL \ 716 protected=private 717 718# If the MACRO_EXPANSION and EXPAND_PREDEF_ONLY tags are set to YES then 719# this tag can be used to specify a list of macro names that should be expanded. 720# The macro definition that is found in the sources will be used. 721# Use the PREDEFINED tag if you want to use a different macro definition. 722 723EXPAND_AS_DEFINED = 724 725# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 726# doxygen's preprocessor will remove all function-like macros that are alone 727# on a line and do not end with a semicolon. Such function macros are typically 728# used for boiler-plate code, and will confuse the parser if not removed. 729 730SKIP_FUNCTION_MACROS = YES 731 732#--------------------------------------------------------------------------- 733# Configuration::addtions related to external references 734#--------------------------------------------------------------------------- 735 736# The TAGFILES tag can be used to specify one or more tagfiles. 737 738TAGFILES = 739 740# When a file name is specified after GENERATE_TAGFILE, doxygen will create 741# a tag file that is based on the input files it reads. 742 743GENERATE_TAGFILE = 744 745# If the ALLEXTERNALS tag is set to YES all external classes will be listed 746# in the class index. If set to NO only the inherited external classes 747# will be listed. 748 749ALLEXTERNALS = NO 750 751# The PERL_PATH should be the absolute path and name of the perl script 752# interpreter (i.e. the result of `which perl'). 753 754PERL_PATH = 755 756#--------------------------------------------------------------------------- 757# Configuration options related to the dot tool 758#--------------------------------------------------------------------------- 759 760# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 761# generate a inheritance diagram (in Html, RTF and LaTeX) for classes with base or 762# super classes. Setting the tag to NO turns the diagrams off. Note that this 763# option is superceded by the HAVE_DOT option below. This is only a fallback. It is 764# recommended to install and use dot, since it yield more powerful graphs. 765 766CLASS_DIAGRAMS = YES 767 768# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 769# available from the path. This tool is part of Graphviz, a graph visualization 770# toolkit from AT&T and Lucent Bell Labs. The other options in this section 771# have no effect if this option is set to NO (the default) 772 773HAVE_DOT = NO 774 775# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 776# will generate a graph for each documented class showing the direct and 777# indirect inheritance relations. Setting this tag to YES will force the 778# the CLASS_DIAGRAMS tag to NO. 779 780CLASS_GRAPH = YES 781 782# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 783# will generate a graph for each documented class showing the direct and 784# indirect implementation dependencies (inheritance, containment, and 785# class references variables) of the class with other documented classes. 786 787COLLABORATION_GRAPH = YES 788 789# If set to YES, the inheritance and collaboration graphs will show the 790# relations between templates and their instances. 791 792TEMPLATE_RELATIONS = YES 793 794# If set to YES, the inheritance and collaboration graphs will hide 795# inheritance and usage relations if the target is undocumented 796# or is not a class. 797 798HIDE_UNDOC_RELATIONS = YES 799 800# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 801# tags are set to YES then doxygen will generate a graph for each documented 802# file showing the direct and indirect include dependencies of the file with 803# other documented files. 804 805INCLUDE_GRAPH = YES 806 807# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 808# HAVE_DOT tags are set to YES then doxygen will generate a graph for each 809# documented header file showing the documented files that directly or 810# indirectly include this file. 811 812INCLUDED_BY_GRAPH = YES 813 814# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 815# will graphical hierarchy of all classes instead of a textual one. 816 817GRAPHICAL_HIERARCHY = YES 818 819# The tag DOT_PATH can be used to specify the path where the dot tool can be 820# found. If left blank, it is assumed the dot tool can be found on the path. 821 822DOT_PATH = 823 824# The DOTFILE_DIRS tag can be used to specify one or more directories that 825# contain dot files that are included in the documentation (see the 826# \dotfile command). 827 828DOTFILE_DIRS = 829 830# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width 831# (in pixels) of the graphs generated by dot. If a graph becomes larger than 832# this value, doxygen will try to truncate the graph, so that it fits within 833# the specified constraint. Beware that most browsers cannot cope with very 834# large images. 835 836MAX_DOT_GRAPH_WIDTH = 1024 837 838# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height 839# (in pixels) of the graphs generated by dot. If a graph becomes larger than 840# this value, doxygen will try to truncate the graph, so that it fits within 841# the specified constraint. Beware that most browsers cannot cope with very 842# large images. 843 844MAX_DOT_GRAPH_HEIGHT = 1024 845 846# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 847# generate a legend page explaining the meaning of the various boxes and 848# arrows in the dot generated graphs. 849 850GENERATE_LEGEND = YES 851 852# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 853# remove the intermedate dot files that are used to generate 854# the various graphs. 855 856DOT_CLEANUP = YES 857 858#--------------------------------------------------------------------------- 859# Configuration::addtions related to the search engine 860#--------------------------------------------------------------------------- 861 862# The SEARCHENGINE tag specifies whether or not a search engine should be 863# used. If set to NO the values of all tags below this one will be ignored. 864 865SEARCHENGINE = NO 866 867# The CGI_NAME tag should be the name of the CGI script that 868# starts the search engine (doxysearch) with the correct parameters. 869# A script with this name will be generated by doxygen. 870 871CGI_NAME = 872 873# The CGI_URL tag should be the absolute URL to the directory where the 874# cgi binaries are located. See the documentation of your http daemon for 875# details. 876 877CGI_URL = 878 879# The DOC_URL tag should be the absolute URL to the directory where the 880# documentation is located. If left blank the absolute path to the 881# documentation, with file:// prepended to it, will be used. 882 883DOC_URL = 884 885# The DOC_ABSPATH tag should be the absolute path to the directory where the 886# documentation is located. If left blank the directory on the local machine 887# will be used. 888 889DOC_ABSPATH = 890 891# The BIN_ABSPATH tag must point to the directory where the doxysearch binary 892# is installed. 893 894BIN_ABSPATH = 895 896# The EXT_DOC_PATHS tag can be used to specify one or more paths to 897# documentation generated for other projects. This allows doxysearch to search 898# the documentation for these projects as well. 899 900EXT_DOC_PATHS = 901