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