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