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