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