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