1# Doxyfile 1.2.15 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 = "L4 Miscellaneous Functions Library" 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 = l4util 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 = NO 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 = YES 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 = NO 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 = "reviewer=\par Reviewer:\n" \ 232 "witness=\par Witnesses:\n" \ 233 "risks=\par Risks:\n" 234 235# The ENABLED_SECTIONS tag can be used to enable conditional 236# documentation sections, marked by \if sectionname ... \endif. 237 238ENABLED_SECTIONS = 239 240# The MAX_INITIALIZER_LINES tag determines the maximum number of lines 241# the initial value of a variable or define consist of for it to appear in 242# the documentation. If the initializer consists of more lines than specified 243# here it will be hidden. Use a value of 0 to hide initializers completely. 244# The appearance of the initializer of individual variables and defines in the 245# documentation can be controlled using \showinitializer or \hideinitializer 246# command in the documentation regardless of this setting. 247 248MAX_INITIALIZER_LINES = 249 250# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources 251# only. Doxygen will then generate output that is more tailored for C. 252# For instance some of the names that are used will be different. The list 253# of all members will be omitted, etc. 254 255OPTIMIZE_OUTPUT_FOR_C = YES 256 257# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources 258# only. Doxygen will then generate output that is more tailored for Java. 259# For instance namespaces will be presented as packages, qualified scopes 260# will look different, etc. 261 262OPTIMIZE_OUTPUT_JAVA = NO 263 264# Set the SHOW_USED_FILES tag to NO to disable the list of files generated 265# at the bottom of the documentation of classes and structs. If set to YES the 266# list will mention the files that were used to generate the documentation. 267 268SHOW_USED_FILES = NO 269 270#--------------------------------------------------------------------------- 271# configuration options related to warning and progress messages 272#--------------------------------------------------------------------------- 273 274# The QUIET tag can be used to turn on/off the messages that are generated 275# by doxygen. Possible values are YES and NO. If left blank NO is used. 276 277QUIET = YES 278 279# The WARNINGS tag can be used to turn on/off the warning messages that are 280# generated by doxygen. Possible values are YES and NO. If left blank 281# NO is used. 282 283WARNINGS = YES 284 285# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 286# for undocumented members. If EXTRACT_ALL is set to YES then this flag will 287# automatically be disabled. 288 289WARN_IF_UNDOCUMENTED = YES 290 291# The WARN_FORMAT tag determines the format of the warning messages that 292# doxygen can produce. The string should contain the $file, $line, and $text 293# tags, which will be replaced by the file and line number from which the 294# warning originated and the warning text. 295 296WARN_FORMAT = "$file:$line: $text" 297 298# The WARN_LOGFILE tag can be used to specify a file to which warning 299# and error messages should be written. If left blank the output is written 300# to stderr. 301 302WARN_LOGFILE = 303 304#--------------------------------------------------------------------------- 305# configuration options related to the input files 306#--------------------------------------------------------------------------- 307 308# The INPUT tag can be used to specify the files and/or directories that contain 309# documented source files. You may enter file names like "myfile.cpp" or 310# directories like "/usr/src/myproject". Separate the files or directories 311# with spaces. 312 313@INCLUDE = $(L4DIR)/pkg/l4util/doc/files.cfg 314 315# If the value of the INPUT tag contains directories, you can use the 316# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 317# and *.h) to filter out the source-files in the directories. If left 318# blank the following patterns are tested: 319# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp 320# *.h++ *.idl *.odl 321 322FILE_PATTERNS = *.h \ 323 *.idl 324 325# The RECURSIVE tag can be used to turn specify whether or not subdirectories 326# should be searched for input files as well. Possible values are YES and NO. 327# If left blank NO is used. 328 329RECURSIVE = YES 330 331# The EXCLUDE tag can be used to specify files and/or directories that should 332# excluded from the INPUT source files. This way you can easily exclude a 333# subdirectory from a directory tree whose root is specified with the INPUT tag. 334 335EXCLUDE = 336 337# The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories 338# that are symbolic links (a Unix filesystem feature) are excluded from the input. 339 340EXCLUDE_SYMLINKS = NO 341 342# If the value of the INPUT tag contains directories, you can use the 343# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 344# certain files from those directories. 345 346EXCLUDE_PATTERNS = 347 348# The EXAMPLE_PATH tag can be used to specify one or more files or 349# directories that contain example code fragments that are included (see 350# the \include command). 351 352EXAMPLE_PATH = 353 354# If the value of the EXAMPLE_PATH tag contains directories, you can use the 355# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 356# and *.h) to filter out the source-files in the directories. If left 357# blank all files are included. 358 359EXAMPLE_PATTERNS = 360 361# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 362# searched for input files to be used with the \include or \dontinclude 363# commands irrespective of the value of the RECURSIVE tag. 364# Possible values are YES and NO. If left blank NO is used. 365 366EXAMPLE_RECURSIVE = NO 367 368# The IMAGE_PATH tag can be used to specify one or more files or 369# directories that contain image that are included in the documentation (see 370# the \image command). 371 372IMAGE_PATH = . 373 374# The INPUT_FILTER tag can be used to specify a program that doxygen should 375# invoke to filter for each input file. Doxygen will invoke the filter program 376# by executing (via popen()) the command <filter> <input-file>, where <filter> 377# is the value of the INPUT_FILTER tag, and <input-file> is the name of an 378# input file. Doxygen will then use the output that the filter program writes 379# to standard output. 380 381INPUT_FILTER = 382 383# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 384# INPUT_FILTER) will be used to filter the input files when producing source 385# files to browse. 386 387FILTER_SOURCE_FILES = NO 388 389#--------------------------------------------------------------------------- 390# configuration options related to source browsing 391#--------------------------------------------------------------------------- 392 393# If the SOURCE_BROWSER tag is set to YES then a list of source files will 394# be generated. Documented entities will be cross-referenced with these sources. 395 396SOURCE_BROWSER = YES 397 398# Setting the INLINE_SOURCES tag to YES will include the body 399# of functions and classes directly in the documentation. 400 401INLINE_SOURCES = NO 402 403# If the REFERENCED_BY_RELATION tag is set to YES (the default) 404# then for each documented function all documented 405# functions referencing it will be listed. 406 407REFERENCED_BY_RELATION = YES 408 409# If the REFERENCES_RELATION tag is set to YES (the default) 410# then for each documented function all documented entities 411# called/used by that function will be listed. 412 413REFERENCES_RELATION = YES 414 415#--------------------------------------------------------------------------- 416# configuration options related to the alphabetical class index 417#--------------------------------------------------------------------------- 418 419# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 420# of all compounds will be generated. Enable this if the project 421# contains a lot of classes, structs, unions or interfaces. 422 423ALPHABETICAL_INDEX = NO 424 425# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 426# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 427# in which this list will be split (can be a number in the range [1..20]) 428 429COLS_IN_ALPHA_INDEX = 5 430 431# In case all classes in a project start with a common prefix, all 432# classes will be put under the same header in the alphabetical index. 433# The IGNORE_PREFIX tag can be used to specify one or more prefixes that 434# should be ignored while generating the index headers. 435 436IGNORE_PREFIX = 437 438#--------------------------------------------------------------------------- 439# configuration options related to the HTML output 440#--------------------------------------------------------------------------- 441 442# If the GENERATE_HTML tag is set to YES (the default) Doxygen will 443# generate HTML output. 444 445GENERATE_HTML = YES 446 447# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 448# If a relative path is entered the value of OUTPUT_DIRECTORY will be 449# put in front of it. If left blank `html' will be used as the default path. 450 451HTML_OUTPUT = html 452 453# The HTML_FILE_EXTENSION tag can be used to specify the file extension for 454# each generated HTML page (for example: .htm,.php,.asp). If it is left blank 455# doxygen will generate files with .html extension. 456 457HTML_FILE_EXTENSION = .html 458 459# The HTML_HEADER tag can be used to specify a personal HTML header for 460# each generated HTML page. If it is left blank doxygen will generate a 461# standard header. 462 463HTML_HEADER = $(L4DIR)/pkg/l4util/doc/header.html 464 465# The HTML_FOOTER tag can be used to specify a personal HTML footer for 466# each generated HTML page. If it is left blank doxygen will generate a 467# standard footer. 468 469HTML_FOOTER = $(L4DIR)/pkg/l4util/doc/footer.html 470 471# The HTML_STYLESHEET tag can be used to specify a user defined cascading 472# style sheet that is used by each HTML page. It can be used to 473# fine-tune the look of the HTML output. If the tag is left blank doxygen 474# will generate a default style sheet 475 476HTML_STYLESHEET = 477 478# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 479# files or namespaces will be aligned in HTML using tables. If set to 480# NO a bullet list will be used. 481 482HTML_ALIGN_MEMBERS = YES 483 484# If the GENERATE_HTMLHELP tag is set to YES, additional index files 485# will be generated that can be used as input for tools like the 486# Microsoft HTML help workshop to generate a compressed HTML help file (.chm) 487# of the generated HTML documentation. 488 489GENERATE_HTMLHELP = NO 490 491# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 492# controls if a separate .chi index file is generated (YES) or that 493# it should be included in the master .chm file (NO). 494 495GENERATE_CHI = NO 496 497# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 498# controls whether a binary table of contents is generated (YES) or a 499# normal table of contents (NO) in the .chm file. 500 501BINARY_TOC = NO 502 503# The TOC_EXPAND flag can be set to YES to add extra items for group members 504# to the contents of the Html help documentation and to the tree view. 505 506TOC_EXPAND = NO 507 508# The DISABLE_INDEX tag can be used to turn on/off the condensed index at 509# top of each HTML page. The value NO (the default) enables the index and 510# the value YES disables it. 511 512DISABLE_INDEX = YES 513 514# This tag can be used to set the number of enum values (range [1..20]) 515# that doxygen will group on one line in the generated HTML documentation. 516 517ENUM_VALUES_PER_LINE = 4 518 519# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be 520# generated containing a tree-like index structure (just like the one that 521# is generated for HTML Help). For this to work a browser that supports 522# JavaScript and frames is required (for instance Mozilla, Netscape 4.0+, 523# or Internet explorer 4.0+). Note that for large projects the tree generation 524# can take a very long time. In such cases it is better to disable this feature. 525# Windows users are probably better off using the HTML help feature. 526 527GENERATE_TREEVIEW = NO 528 529# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 530# used to set the initial width (in pixels) of the frame in which the tree 531# is shown. 532 533TREEVIEW_WIDTH = 250 534 535#--------------------------------------------------------------------------- 536# configuration options related to the LaTeX output 537#--------------------------------------------------------------------------- 538 539# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 540# generate Latex output. 541 542GENERATE_LATEX = NO 543 544# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 545# If a relative path is entered the value of OUTPUT_DIRECTORY will be 546# put in front of it. If left blank `latex' will be used as the default path. 547 548LATEX_OUTPUT = latex 549 550# 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. 551 552LATEX_CMD_NAME = latex 553 554# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 555# generate index for LaTeX. If left blank `makeindex' will be used as the 556# default command name. 557 558MAKEINDEX_CMD_NAME = makeindex 559 560# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 561# LaTeX documents. This may be useful for small projects and may help to 562# save some trees in general. 563 564COMPACT_LATEX = NO 565 566# The PAPER_TYPE tag can be used to set the paper type that is used 567# by the printer. Possible values are: a4, a4wide, letter, legal and 568# executive. If left blank a4wide will be used. 569 570PAPER_TYPE = a4wide 571 572# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 573# packages that should be included in the LaTeX output. 574 575EXTRA_PACKAGES = 576 577# The LATEX_HEADER tag can be used to specify a personal LaTeX header for 578# the generated latex document. The header should contain everything until 579# the first chapter. If it is left blank doxygen will generate a 580# standard header. Notice: only use this tag if you know what you are doing! 581 582LATEX_HEADER = 583 584# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 585# is prepared for conversion to pdf (using ps2pdf). The pdf file will 586# contain links (just like the HTML output) instead of page references 587# This makes the output suitable for online browsing using a pdf viewer. 588 589PDF_HYPERLINKS = NO 590 591# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 592# plain latex in the generated Makefile. Set this option to YES to get a 593# higher quality PDF documentation. 594 595USE_PDFLATEX = NO 596 597# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 598# command to the generated LaTeX files. This will instruct LaTeX to keep 599# running if errors occur, instead of asking the user for help. 600# This option is also used when generating formulas in HTML. 601 602LATEX_BATCHMODE = NO 603 604#--------------------------------------------------------------------------- 605# configuration options related to the RTF output 606#--------------------------------------------------------------------------- 607 608# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 609# The RTF output is optimised for Word 97 and may not look very pretty with 610# other RTF readers or editors. 611 612GENERATE_RTF = NO 613 614# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 615# If a relative path is entered the value of OUTPUT_DIRECTORY will be 616# put in front of it. If left blank `rtf' will be used as the default path. 617 618RTF_OUTPUT = rtf 619 620# If the COMPACT_RTF tag is set to YES Doxygen generates more compact 621# RTF documents. This may be useful for small projects and may help to 622# save some trees in general. 623 624COMPACT_RTF = NO 625 626# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 627# will contain hyperlink fields. The RTF file will 628# contain links (just like the HTML output) instead of page references. 629# This makes the output suitable for online browsing using WORD or other 630# programs which support those fields. 631# Note: wordpad (write) and others do not support links. 632 633RTF_HYPERLINKS = NO 634 635# Load stylesheet definitions from file. Syntax is similar to doxygen's 636# config file, i.e. a series of assigments. You only have to provide 637# replacements, missing definitions are set to their default value. 638 639RTF_STYLESHEET_FILE = 640 641# Set optional variables used in the generation of an rtf document. 642# Syntax is similar to doxygen's config file. 643 644RTF_EXTENSIONS_FILE = 645 646#--------------------------------------------------------------------------- 647# configuration options related to the man page output 648#--------------------------------------------------------------------------- 649 650# If the GENERATE_MAN tag is set to YES (the default) Doxygen will 651# generate man pages 652 653GENERATE_MAN = NO 654 655# The MAN_OUTPUT tag is used to specify where the man pages will be put. 656# If a relative path is entered the value of OUTPUT_DIRECTORY will be 657# put in front of it. If left blank `man' will be used as the default path. 658 659MAN_OUTPUT = man 660 661# The MAN_EXTENSION tag determines the extension that is added to 662# the generated man pages (default is the subroutine's section .3) 663 664MAN_EXTENSION = .3 665 666# If the MAN_LINKS tag is set to YES and Doxygen generates man output, 667# then it will generate one additional man file for each entity 668# documented in the real man page(s). These additional files 669# only source the real man page, but without them the man command 670# would be unable to find the correct page. The default is NO. 671 672MAN_LINKS = NO 673 674#--------------------------------------------------------------------------- 675# configuration options related to the XML output 676#--------------------------------------------------------------------------- 677 678# If the GENERATE_XML tag is set to YES Doxygen will 679# generate an XML file that captures the structure of 680# the code including all documentation. Note that this 681# feature is still experimental and incomplete at the 682# moment. 683 684GENERATE_XML = NO 685 686#--------------------------------------------------------------------------- 687# configuration options for the AutoGen Definitions output 688#--------------------------------------------------------------------------- 689 690# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 691# generate an AutoGen Definitions (see autogen.sf.net) file 692# that captures the structure of the code including all 693# documentation. Note that this feature is still experimental 694# and incomplete at the moment. 695 696GENERATE_AUTOGEN_DEF = NO 697 698#--------------------------------------------------------------------------- 699# Configuration options related to the preprocessor 700#--------------------------------------------------------------------------- 701 702# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 703# evaluate all C-preprocessor directives found in the sources and include 704# files. 705 706ENABLE_PREPROCESSING = YES 707 708# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 709# names in the source code. If set to NO (the default) only conditional 710# compilation will be performed. Macro expansion can be done in a controlled 711# way by setting EXPAND_ONLY_PREDEF to YES. 712 713MACRO_EXPANSION = YES 714 715# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 716# then the macro expansion is limited to the macros specified with the 717# PREDEFINED and EXPAND_AS_PREDEFINED tags. 718 719EXPAND_ONLY_PREDEF = NO 720 721# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 722# in the INCLUDE_PATH (see below) will be search if a #include is found. 723 724SEARCH_INCLUDES = YES 725 726# The INCLUDE_PATH tag can be used to specify one or more directories that 727# contain include files that are not input files but should be processed by 728# the preprocessor. 729 730INCLUDE_PATH = 731 732# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 733# patterns (like *.h and *.hpp) to filter out the header-files in the 734# directories. If left blank, the patterns specified with FILE_PATTERNS will 735# be used. 736 737INCLUDE_FILE_PATTERNS = 738 739# The PREDEFINED tag can be used to specify one or more macro names that 740# are defined before the preprocessor is started (similar to the -D option of 741# gcc). The argument of the tag is a list of macros of the form: name 742# or name=definition (no spaces). If the definition and the = are 743# omitted =1 is assumed. 744 745PREDEFINED = DOXYGEN \ 746 L4_INLINE=inline \ 747 EXTERN_C_BEGIN= \ 748 EXTERN_C_END= \ 749 __attribute__(x)= 750 751# If the MACRO_EXPANSION and EXPAND_PREDEF_ONLY tags are set to YES then 752# this tag can be used to specify a list of macro names that should be expanded. 753# The macro definition that is found in the sources will be used. 754# Use the PREDEFINED tag if you want to use a different macro definition. 755 756EXPAND_AS_DEFINED = 757 758# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 759# doxygen's preprocessor will remove all function-like macros that are alone 760# on a line and do not end with a semicolon. Such function macros are typically 761# used for boiler-plate code, and will confuse the parser if not removed. 762 763SKIP_FUNCTION_MACROS = YES 764 765#--------------------------------------------------------------------------- 766# Configuration::addtions related to external references 767#--------------------------------------------------------------------------- 768 769# The TAGFILES tag can be used to specify one or more tagfiles. 770 771TAGFILES = 772 773# When a file name is specified after GENERATE_TAGFILE, doxygen will create 774# a tag file that is based on the input files it reads. 775 776GENERATE_TAGFILE = 777 778# If the ALLEXTERNALS tag is set to YES all external classes will be listed 779# in the class index. If set to NO only the inherited external classes 780# will be listed. 781 782ALLEXTERNALS = NO 783 784# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 785# in the modules index. If set to NO, only the current project's groups will 786# be listed. 787 788EXTERNAL_GROUPS = YES 789 790# The PERL_PATH should be the absolute path and name of the perl script 791# interpreter (i.e. the result of `which perl'). 792 793PERL_PATH = /usr/bin/perl 794 795#--------------------------------------------------------------------------- 796# Configuration options related to the dot tool 797#--------------------------------------------------------------------------- 798 799# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 800# generate a inheritance diagram (in Html, RTF and LaTeX) for classes with base or 801# super classes. Setting the tag to NO turns the diagrams off. Note that this 802# option is superceded by the HAVE_DOT option below. This is only a fallback. It is 803# recommended to install and use dot, since it yield more powerful graphs. 804 805CLASS_DIAGRAMS = YES 806 807# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 808# available from the path. This tool is part of Graphviz, a graph visualization 809# toolkit from AT&T and Lucent Bell Labs. The other options in this section 810# have no effect if this option is set to NO (the default) 811 812HAVE_DOT = NO 813 814# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 815# will generate a graph for each documented class showing the direct and 816# indirect inheritance relations. Setting this tag to YES will force the 817# the CLASS_DIAGRAMS tag to NO. 818 819CLASS_GRAPH = YES 820 821# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 822# will generate a graph for each documented class showing the direct and 823# indirect implementation dependencies (inheritance, containment, and 824# class references variables) of the class with other documented classes. 825 826COLLABORATION_GRAPH = YES 827 828# If set to YES, the inheritance and collaboration graphs will show the 829# relations between templates and their instances. 830 831TEMPLATE_RELATIONS = YES 832 833# If set to YES, the inheritance and collaboration graphs will hide 834# inheritance and usage relations if the target is undocumented 835# or is not a class. 836 837HIDE_UNDOC_RELATIONS = YES 838 839# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 840# tags are set to YES then doxygen will generate a graph for each documented 841# file showing the direct and indirect include dependencies of the file with 842# other documented files. 843 844INCLUDE_GRAPH = YES 845 846# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 847# HAVE_DOT tags are set to YES then doxygen will generate a graph for each 848# documented header file showing the documented files that directly or 849# indirectly include this file. 850 851INCLUDED_BY_GRAPH = YES 852 853# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 854# will graphical hierarchy of all classes instead of a textual one. 855 856GRAPHICAL_HIERARCHY = YES 857 858# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 859# generated by dot. Possible values are png, jpg, or gif 860# If left blank png will be used. 861 862DOT_IMAGE_FORMAT = png 863 864# The tag DOT_PATH can be used to specify the path where the dot tool can be 865# found. If left blank, it is assumed the dot tool can be found on the path. 866 867DOT_PATH = 868 869# The DOTFILE_DIRS tag can be used to specify one or more directories that 870# contain dot files that are included in the documentation (see the 871# \dotfile command). 872 873DOTFILE_DIRS = 874 875# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width 876# (in pixels) of the graphs generated by dot. If a graph becomes larger than 877# this value, doxygen will try to truncate the graph, so that it fits within 878# the specified constraint. Beware that most browsers cannot cope with very 879# large images. 880 881MAX_DOT_GRAPH_WIDTH = 1024 882 883# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height 884# (in pixels) of the graphs generated by dot. If a graph becomes larger than 885# this value, doxygen will try to truncate the graph, so that it fits within 886# the specified constraint. Beware that most browsers cannot cope with very 887# large images. 888 889MAX_DOT_GRAPH_HEIGHT = 1024 890 891# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 892# generate a legend page explaining the meaning of the various boxes and 893# arrows in the dot generated graphs. 894 895GENERATE_LEGEND = YES 896 897# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 898# remove the intermedate dot files that are used to generate 899# the various graphs. 900 901DOT_CLEANUP = YES 902 903#--------------------------------------------------------------------------- 904# Configuration::addtions related to the search engine 905#--------------------------------------------------------------------------- 906 907# The SEARCHENGINE tag specifies whether or not a search engine should be 908# used. If set to NO the values of all tags below this one will be ignored. 909 910SEARCHENGINE = NO 911 912