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