Changeset 9a83b91 for doc/user.cfg


Ignore:
Timestamp:
May 18, 2006, 8:51:59 PM (18 years ago)
Author:
Paul Brossier <piem@altern.org>
Branches:
feature/autosink, feature/cnn, feature/cnn_org, feature/constantq, feature/crepe, feature/crepe_org, feature/pitchshift, feature/pydocstrings, feature/timestretch, fix/ffmpeg5, master, pitchshift, sampler, timestretch, yinfft+
Children:
e604630
Parents:
6e35163
Message:

update doxygen configs, include README from aubio.h
update doxygen configs, include README from aubio.h

File:
1 edited

Legend:

Unmodified
Added
Removed
  • doc/user.cfg

    r6e35163 r9a83b91  
     1# Doxyfile 1.4.6
     2
     3# This file describes the settings to be used by the documentation system
     4# doxygen (www.doxygen.org) for a project
    15#
    2 PROJECT_NAME      = "Aubio"
    3 OUTPUT_DIRECTORY  = user
    4 GENERATE_LATEX    = YES
    5 GENERATE_MAN      = YES
    6 GENERATE_RTF      = YES
    7 CASE_SENSE_NAMES  = NO
    8 INPUT             = ../src
    9 QUIET             = YES
    10 JAVADOC_AUTOBRIEF = YES
    11 
    12 HTML_STYLESHEET   = aubio.css
    13 SEARCHENGINE      = YES
     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# Project related 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           = aubio
     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         = 0.3.0
     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       = user
     34
     35# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
     36# 4096 sub-directories (in 2 levels) under the output directory of each output
     37# format and will distribute the generated files over these directories.
     38# Enabling this option can be useful when feeding doxygen a huge amount of
     39# source files, where putting all generated files in the same directory would
     40# otherwise cause performance problems for the file system.
     41
     42CREATE_SUBDIRS         = NO
     43
     44# The OUTPUT_LANGUAGE tag is used to specify the language in which all
     45# documentation generated by doxygen is written. Doxygen will use this
     46# information to generate all constant output in the proper language.
     47# The default language is English, other supported languages are:
     48# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish,
     49# Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese,
     50# Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian,
     51# Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish,
     52# Swedish, and Ukrainian.
     53
     54OUTPUT_LANGUAGE        = English
     55
     56# This tag can be used to specify the encoding used in the generated output.
     57# The encoding is not always determined by the language that is chosen,
     58# but also whether or not the output is meant for Windows or non-Windows users.
     59# In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES
     60# forces the Windows encoding (this is the default for the Windows binary),
     61# whereas setting the tag to NO uses a Unix-style encoding (the default for
     62# all platforms other than Windows).
     63
     64USE_WINDOWS_ENCODING   = NO
     65
     66# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
     67# include brief member descriptions after the members that are listed in
     68# the file and class documentation (similar to JavaDoc).
     69# Set to NO to disable this.
     70
     71BRIEF_MEMBER_DESC      = YES
     72
     73# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
     74# the brief description of a member or function before the detailed description.
     75# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
     76# brief descriptions will be completely suppressed.
     77
     78REPEAT_BRIEF           = YES
     79
     80# This tag implements a quasi-intelligent brief description abbreviator
     81# that is used to form the text in various listings. Each string
     82# in this list, if found as the leading text of the brief description, will be
     83# stripped from the text and the result after processing the whole list, is
     84# used as the annotated text. Otherwise, the brief description is used as-is.
     85# If left blank, the following values are used ("$name" is automatically
     86# replaced with the name of the entity): "The $name class" "The $name widget"
     87# "The $name file" "is" "provides" "specifies" "contains"
     88# "represents" "a" "an" "the"
     89
     90ABBREVIATE_BRIEF       =
     91
     92# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
     93# Doxygen will generate a detailed section even if there is only a brief
     94# description.
     95
     96ALWAYS_DETAILED_SEC    = NO
     97
     98# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
     99# inherited members of a class in the documentation of that class as if those
     100# members were ordinary class members. Constructors, destructors and assignment
     101# operators of the base classes will not be shown.
     102
     103INLINE_INHERITED_MEMB  = NO
     104
     105# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
     106# path before files name in the file list and in the header files. If set
     107# to NO the shortest path that makes the file name unique will be used.
     108
     109FULL_PATH_NAMES        = NO
     110
     111# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
     112# can be used to strip a user-defined part of the path. Stripping is
     113# only done if one of the specified strings matches the left-hand part of
     114# the path. The tag can be used to show relative paths in the file list.
     115# If left blank the directory from which doxygen is run is used as the
     116# path to strip.
     117
     118STRIP_FROM_PATH        =
     119
     120# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
     121# the path mentioned in the documentation of a class, which tells
     122# the reader which header file to include in order to use a class.
     123# If left blank only the name of the header file containing the class
     124# definition is used. Otherwise one should specify the include paths that
     125# are normally passed to the compiler using the -I flag.
     126
     127STRIP_FROM_INC_PATH    =
     128
     129# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
     130# (but less readable) file names. This can be useful is your file systems
     131# doesn't support long names like on DOS, Mac, or CD-ROM.
     132
     133SHORT_NAMES            = NO
     134
     135# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
     136# will interpret the first line (until the first dot) of a JavaDoc-style
     137# comment as the brief description. If set to NO, the JavaDoc
     138# comments will behave just like the Qt-style comments (thus requiring an
     139# explicit @brief command for a brief description.
     140
     141JAVADOC_AUTOBRIEF      = YES
     142
     143# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
     144# treat a multi-line C++ special comment block (i.e. a block of //! or ///
     145# comments) as a brief description. This used to be the default behaviour.
     146# The new default is to treat a multi-line C++ comment block as a detailed
     147# description. Set this tag to YES if you prefer the old behaviour instead.
     148
     149MULTILINE_CPP_IS_BRIEF = NO
     150
     151# If the DETAILS_AT_TOP tag is set to YES then Doxygen
     152# will output the detailed description near the top, like JavaDoc.
     153# If set to NO, the detailed description appears after the member
     154# documentation.
     155
     156DETAILS_AT_TOP         = NO
     157
     158# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
     159# member inherits the documentation from any documented member that it
     160# re-implements.
     161
     162INHERIT_DOCS           = YES
     163
     164# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
     165# a new page for each member. If set to NO, the documentation of a member will
     166# be part of the file/class/namespace that contains it.
     167
     168SEPARATE_MEMBER_PAGES  = NO
     169
     170# The TAB_SIZE tag can be used to set the number of spaces in a tab.
     171# Doxygen uses this value to replace tabs by spaces in code fragments.
     172
     173TAB_SIZE               = 4
     174
     175# This tag can be used to specify a number of aliases that acts
     176# as commands in the documentation. An alias has the form "name=value".
     177# For example adding "sideeffect=\par Side Effects:\n" will allow you to
     178# put the command \sideeffect (or @sideeffect) in the documentation, which
     179# will result in a user-defined paragraph with heading "Side Effects:".
     180# You can put \n's in the value part of an alias to insert newlines.
     181
     182ALIASES                =
     183
     184# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
     185# sources only. Doxygen will then generate output that is more tailored for C.
     186# For instance, some of the names that are used will be different. The list
     187# of all members will be omitted, etc.
     188
     189OPTIMIZE_OUTPUT_FOR_C  = YES
     190
     191# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
     192# sources only. Doxygen will then generate output that is more tailored for Java.
     193# For instance, namespaces will be presented as packages, qualified scopes
     194# will look different, etc.
     195
     196OPTIMIZE_OUTPUT_JAVA   = NO
     197
     198# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to
     199# include (a tag file for) the STL sources as input, then you should
     200# set this tag to YES in order to let doxygen match functions declarations and
     201# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
     202# func(std::string) {}). This also make the inheritance and collaboration
     203# diagrams that involve STL classes more complete and accurate.
     204
     205BUILTIN_STL_SUPPORT    = NO
     206
     207# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
     208# tag is set to YES, then doxygen will reuse the documentation of the first
     209# member in the group (if any) for the other members of the group. By default
     210# all members of a group must be documented explicitly.
     211
     212DISTRIBUTE_GROUP_DOC   = NO
     213
     214# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
     215# the same type (for instance a group of public functions) to be put as a
     216# subgroup of that type (e.g. under the Public Functions section). Set it to
     217# NO to prevent subgrouping. Alternatively, this can be done per class using
     218# the \nosubgrouping command.
     219
     220SUBGROUPING            = YES
     221
     222#---------------------------------------------------------------------------
     223# Build related configuration options
     224#---------------------------------------------------------------------------
     225
     226# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
     227# documentation are documented, even if no documentation was available.
     228# Private class members and static file members will be hidden unless
     229# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
     230
     231EXTRACT_ALL            = NO
     232
     233# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
     234# will be included in the documentation.
     235
     236EXTRACT_PRIVATE        = NO
     237
     238# If the EXTRACT_STATIC tag is set to YES all static members of a file
     239# will be included in the documentation.
     240
     241EXTRACT_STATIC         = NO
     242
     243# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
     244# defined locally in source files will be included in the documentation.
     245# If set to NO only classes defined in header files are included.
     246
     247EXTRACT_LOCAL_CLASSES  = YES
     248
     249# This flag is only useful for Objective-C code. When set to YES local
     250# methods, which are defined in the implementation section but not in
     251# the interface are included in the documentation.
     252# If set to NO (the default) only methods in the interface are included.
     253
     254EXTRACT_LOCAL_METHODS  = NO
     255
     256# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
     257# undocumented members of documented classes, files or namespaces.
     258# If set to NO (the default) these members will be included in the
     259# various overviews, but no documentation section is generated.
     260# This option has no effect if EXTRACT_ALL is enabled.
     261
     262HIDE_UNDOC_MEMBERS     = NO
     263
     264# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
     265# undocumented classes that are normally visible in the class hierarchy.
     266# If set to NO (the default) these classes will be included in the various
     267# overviews. This option has no effect if EXTRACT_ALL is enabled.
     268
     269HIDE_UNDOC_CLASSES     = NO
     270
     271# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
     272# friend (class|struct|union) declarations.
     273# If set to NO (the default) these declarations will be included in the
     274# documentation.
     275
     276HIDE_FRIEND_COMPOUNDS  = NO
     277
     278# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
     279# documentation blocks found inside the body of a function.
     280# If set to NO (the default) these blocks will be appended to the
     281# function's detailed documentation block.
     282
     283HIDE_IN_BODY_DOCS      = NO
     284
     285# The INTERNAL_DOCS tag determines if documentation
     286# that is typed after a \internal command is included. If the tag is set
     287# to NO (the default) then the documentation will be excluded.
     288# Set it to YES to include the internal documentation.
     289
     290INTERNAL_DOCS          = NO
     291
     292# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
     293# file names in lower-case letters. If set to YES upper-case letters are also
     294# allowed. This is useful if you have classes or files whose names only differ
     295# in case and if your file system supports case sensitive file names. Windows
     296# and Mac users are advised to set this option to NO.
     297
     298CASE_SENSE_NAMES       = YES
     299
     300# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
     301# will show members with their full class and namespace scopes in the
     302# documentation. If set to YES the scope will be hidden.
     303
     304HIDE_SCOPE_NAMES       = NO
     305
     306# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
     307# will put a list of the files that are included by a file in the documentation
     308# of that file.
     309
     310SHOW_INCLUDE_FILES     = YES
     311
     312# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
     313# is inserted in the documentation for inline members.
     314
     315INLINE_INFO            = YES
     316
     317# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
     318# will sort the (detailed) documentation of file and class members
     319# alphabetically by member name. If set to NO the members will appear in
     320# declaration order.
     321
     322SORT_MEMBER_DOCS       = YES
     323
     324# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
     325# brief documentation of file, namespace and class members alphabetically
     326# by member name. If set to NO (the default) the members will appear in
     327# declaration order.
     328
     329SORT_BRIEF_DOCS        = NO
     330
     331# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
     332# sorted by fully-qualified names, including namespaces. If set to
     333# NO (the default), the class list will be sorted only by class name,
     334# not including the namespace part.
     335# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
     336# Note: This option applies only to the class list, not to the
     337# alphabetical list.
     338
     339SORT_BY_SCOPE_NAME     = NO
     340
     341# The GENERATE_TODOLIST tag can be used to enable (YES) or
     342# disable (NO) the todo list. This list is created by putting \todo
     343# commands in the documentation.
     344
     345GENERATE_TODOLIST      = YES
     346
     347# The GENERATE_TESTLIST tag can be used to enable (YES) or
     348# disable (NO) the test list. This list is created by putting \test
     349# commands in the documentation.
     350
     351GENERATE_TESTLIST      = YES
     352
     353# The GENERATE_BUGLIST tag can be used to enable (YES) or
     354# disable (NO) the bug list. This list is created by putting \bug
     355# commands in the documentation.
     356
     357GENERATE_BUGLIST       = YES
     358
     359# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
     360# disable (NO) the deprecated list. This list is created by putting
     361# \deprecated commands in the documentation.
     362
     363GENERATE_DEPRECATEDLIST= YES
     364
     365# The ENABLED_SECTIONS tag can be used to enable conditional
     366# documentation sections, marked by \if sectionname ... \endif.
     367
     368ENABLED_SECTIONS       =
     369
     370# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
     371# the initial value of a variable or define consists of for it to appear in
     372# the documentation. If the initializer consists of more lines than specified
     373# here it will be hidden. Use a value of 0 to hide initializers completely.
     374# The appearance of the initializer of individual variables and defines in the
     375# documentation can be controlled using \showinitializer or \hideinitializer
     376# command in the documentation regardless of this setting.
     377
     378MAX_INITIALIZER_LINES  = 30
     379
     380# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
     381# at the bottom of the documentation of classes and structs. If set to YES the
     382# list will mention the files that were used to generate the documentation.
     383
     384SHOW_USED_FILES        = YES
     385
     386# If the sources in your project are distributed over multiple directories
     387# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
     388# in the documentation. The default is NO.
     389
     390SHOW_DIRECTORIES       = NO
     391
     392# The FILE_VERSION_FILTER tag can be used to specify a program or script that
     393# doxygen should invoke to get the current version for each file (typically from the
     394# version control system). Doxygen will invoke the program by executing (via
     395# popen()) the command <command> <input-file>, where <command> is the value of
     396# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
     397# provided by doxygen. Whatever the program writes to standard output
     398# is used as the file version. See the manual for examples.
     399
     400FILE_VERSION_FILTER    =
     401
     402#---------------------------------------------------------------------------
     403# configuration options related to warning and progress messages
     404#---------------------------------------------------------------------------
     405
     406# The QUIET tag can be used to turn on/off the messages that are generated
     407# by doxygen. Possible values are YES and NO. If left blank NO is used.
     408
     409QUIET                  = YES
     410
     411# The WARNINGS tag can be used to turn on/off the warning messages that are
     412# generated by doxygen. Possible values are YES and NO. If left blank
     413# NO is used.
     414
     415WARNINGS               = YES
     416
     417# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
     418# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
     419# automatically be disabled.
     420
     421WARN_IF_UNDOCUMENTED   = YES
     422
     423# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
     424# potential errors in the documentation, such as not documenting some
     425# parameters in a documented function, or documenting parameters that
     426# don't exist or using markup commands wrongly.
     427
     428WARN_IF_DOC_ERROR      = YES
     429
     430# This WARN_NO_PARAMDOC option can be abled to get warnings for
     431# functions that are documented, but have no documentation for their parameters
     432# or return value. If set to NO (the default) doxygen will only warn about
     433# wrong or incomplete parameter documentation, but not about the absence of
     434# documentation.
     435
     436WARN_NO_PARAMDOC       = NO
     437
     438# The WARN_FORMAT tag determines the format of the warning messages that
     439# doxygen can produce. The string should contain the $file, $line, and $text
     440# tags, which will be replaced by the file and line number from which the
     441# warning originated and the warning text. Optionally the format may contain
     442# $version, which will be replaced by the version of the file (if it could
     443# be obtained via FILE_VERSION_FILTER)
     444
     445WARN_FORMAT            = "$file:$line: $text"
     446
     447# The WARN_LOGFILE tag can be used to specify a file to which warning
     448# and error messages should be written. If left blank the output is written
     449# to stderr.
     450
     451WARN_LOGFILE           =
     452
     453#---------------------------------------------------------------------------
     454# configuration options related to the input files
     455#---------------------------------------------------------------------------
     456
     457# The INPUT tag can be used to specify the files and/or directories that contain
     458# documented source files. You may enter file names like "myfile.cpp" or
     459# directories like "/usr/src/myproject". Separate the files or directories
     460# with spaces.
     461
     462INPUT                  = ../src
     463
     464# If the value of the INPUT tag contains directories, you can use the
     465# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
     466# and *.h) to filter out the source-files in the directories. If left
     467# blank the following patterns are tested:
     468# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
     469# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py
     470
     471FILE_PATTERNS          =
     472
     473# The RECURSIVE tag can be used to turn specify whether or not subdirectories
     474# should be searched for input files as well. Possible values are YES and NO.
     475# If left blank NO is used.
     476
     477RECURSIVE              = NO
     478
     479# The EXCLUDE tag can be used to specify files and/or directories that should
     480# excluded from the INPUT source files. This way you can easily exclude a
     481# subdirectory from a directory tree whose root is specified with the INPUT tag.
     482
     483EXCLUDE                =
     484
     485# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
     486# directories that are symbolic links (a Unix filesystem feature) are excluded
     487# from the input.
     488
     489EXCLUDE_SYMLINKS       = NO
     490
     491# If the value of the INPUT tag contains directories, you can use the
     492# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
     493# certain files from those directories. Note that the wildcards are matched
     494# against the file with absolute path, so to exclude all test directories
     495# for example use the pattern */test/*
     496
     497EXCLUDE_PATTERNS       =
     498
     499# The EXAMPLE_PATH tag can be used to specify one or more files or
     500# directories that contain example code fragments that are included (see
     501# the \include command).
     502
     503EXAMPLE_PATH           = ../examples ../
     504
     505# If the value of the EXAMPLE_PATH tag contains directories, you can use the
     506# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
     507# and *.h) to filter out the source-files in the directories. If left
     508# blank all files are included.
     509
     510EXAMPLE_PATTERNS       =
     511
     512# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
     513# searched for input files to be used with the \include or \dontinclude
     514# commands irrespective of the value of the RECURSIVE tag.
     515# Possible values are YES and NO. If left blank NO is used.
     516
     517EXAMPLE_RECURSIVE      = NO
     518
     519# The IMAGE_PATH tag can be used to specify one or more files or
     520# directories that contain image that are included in the documentation (see
     521# the \image command).
     522
     523IMAGE_PATH             =
     524
     525# The INPUT_FILTER tag can be used to specify a program that doxygen should
     526# invoke to filter for each input file. Doxygen will invoke the filter program
     527# by executing (via popen()) the command <filter> <input-file>, where <filter>
     528# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
     529# input file. Doxygen will then use the output that the filter program writes
     530# to standard output.  If FILTER_PATTERNS is specified, this tag will be
     531# ignored.
     532
     533INPUT_FILTER           =
     534
     535# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
     536# basis.  Doxygen will compare the file name with each pattern and apply the
     537# filter if there is a match.  The filters are a list of the form:
     538# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
     539# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
     540# is applied to all files.
     541
     542FILTER_PATTERNS        =
     543
     544# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
     545# INPUT_FILTER) will be used to filter the input files when producing source
     546# files to browse (i.e. when SOURCE_BROWSER is set to YES).
     547
     548FILTER_SOURCE_FILES    = NO
     549
     550#---------------------------------------------------------------------------
     551# configuration options related to source browsing
     552#---------------------------------------------------------------------------
     553
     554# If the SOURCE_BROWSER tag is set to YES then a list of source files will
     555# be generated. Documented entities will be cross-referenced with these sources.
     556# Note: To get rid of all source code in the generated output, make sure also
     557# VERBATIM_HEADERS is set to NO.
     558
     559SOURCE_BROWSER         = NO
     560
     561# Setting the INLINE_SOURCES tag to YES will include the body
     562# of functions and classes directly in the documentation.
     563
     564INLINE_SOURCES         = NO
     565
     566# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
     567# doxygen to hide any special comment blocks from generated source code
     568# fragments. Normal C and C++ comments will always remain visible.
     569
     570STRIP_CODE_COMMENTS    = YES
     571
     572# If the REFERENCED_BY_RELATION tag is set to YES (the default)
     573# then for each documented function all documented
     574# functions referencing it will be listed.
     575
     576REFERENCED_BY_RELATION = YES
     577
     578# If the REFERENCES_RELATION tag is set to YES (the default)
     579# then for each documented function all documented entities
     580# called/used by that function will be listed.
     581
     582REFERENCES_RELATION    = YES
     583
     584# If the USE_HTAGS tag is set to YES then the references to source code
     585# will point to the HTML generated by the htags(1) tool instead of doxygen
     586# built-in source browser. The htags tool is part of GNU's global source
     587# tagging system (see http://www.gnu.org/software/global/global.html). You
     588# will need version 4.8.6 or higher.
     589
     590USE_HTAGS              = NO
     591
     592# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
     593# will generate a verbatim copy of the header file for each class for
     594# which an include is specified. Set to NO to disable this.
     595
     596VERBATIM_HEADERS       = YES
     597
     598#---------------------------------------------------------------------------
     599# configuration options related to the alphabetical class index
     600#---------------------------------------------------------------------------
     601
     602# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
     603# of all compounds will be generated. Enable this if the project
     604# contains a lot of classes, structs, unions or interfaces.
     605
     606ALPHABETICAL_INDEX     = NO
     607
     608# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
     609# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
     610# in which this list will be split (can be a number in the range [1..20])
     611
     612COLS_IN_ALPHA_INDEX    = 5
     613
     614# In case all classes in a project start with a common prefix, all
     615# classes will be put under the same header in the alphabetical index.
     616# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
     617# should be ignored while generating the index headers.
     618
     619IGNORE_PREFIX          =
     620
     621#---------------------------------------------------------------------------
     622# configuration options related to the HTML output
     623#---------------------------------------------------------------------------
     624
     625# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
     626# generate HTML output.
     627
     628GENERATE_HTML          = YES
     629
     630# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
     631# If a relative path is entered the value of OUTPUT_DIRECTORY will be
     632# put in front of it. If left blank `html' will be used as the default path.
     633
     634HTML_OUTPUT            = html
     635
     636# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
     637# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
     638# doxygen will generate files with .html extension.
     639
     640HTML_FILE_EXTENSION    = .html
     641
     642# The HTML_HEADER tag can be used to specify a personal HTML header for
     643# each generated HTML page. If it is left blank doxygen will generate a
     644# standard header.
     645
     646HTML_HEADER            =
     647
     648# The HTML_FOOTER tag can be used to specify a personal HTML footer for
     649# each generated HTML page. If it is left blank doxygen will generate a
     650# standard footer.
     651
     652HTML_FOOTER            =
     653
     654# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
     655# style sheet that is used by each HTML page. It can be used to
     656# fine-tune the look of the HTML output. If the tag is left blank doxygen
     657# will generate a default style sheet. Note that doxygen will try to copy
     658# the style sheet file to the HTML output directory, so don't put your own
     659# stylesheet in the HTML output directory as well, or it will be erased!
     660
     661HTML_STYLESHEET        = aubio.css
     662
     663# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
     664# files or namespaces will be aligned in HTML using tables. If set to
     665# NO a bullet list will be used.
     666
     667HTML_ALIGN_MEMBERS     = YES
     668
     669# If the GENERATE_HTMLHELP tag is set to YES, additional index files
     670# will be generated that can be used as input for tools like the
     671# Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
     672# of the generated HTML documentation.
     673
     674GENERATE_HTMLHELP      = NO
     675
     676# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
     677# be used to specify the file name of the resulting .chm file. You
     678# can add a path in front of the file if the result should not be
     679# written to the html output directory.
     680
     681CHM_FILE               =
     682
     683# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
     684# be used to specify the location (absolute path including file name) of
     685# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
     686# the HTML help compiler on the generated index.hhp.
     687
     688HHC_LOCATION           =
     689
     690# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
     691# controls if a separate .chi index file is generated (YES) or that
     692# it should be included in the master .chm file (NO).
     693
     694GENERATE_CHI           = NO
     695
     696# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
     697# controls whether a binary table of contents is generated (YES) or a
     698# normal table of contents (NO) in the .chm file.
     699
     700BINARY_TOC             = NO
     701
     702# The TOC_EXPAND flag can be set to YES to add extra items for group members
     703# to the contents of the HTML help documentation and to the tree view.
     704
     705TOC_EXPAND             = NO
     706
     707# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
     708# top of each HTML page. The value NO (the default) enables the index and
     709# the value YES disables it.
     710
     711DISABLE_INDEX          = NO
     712
     713# This tag can be used to set the number of enum values (range [1..20])
     714# that doxygen will group on one line in the generated HTML documentation.
     715
     716ENUM_VALUES_PER_LINE   = 4
     717
     718# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
     719# generated containing a tree-like index structure (just like the one that
     720# is generated for HTML Help). For this to work a browser that supports
     721# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
     722# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
     723# probably better off using the HTML help feature.
     724
     725GENERATE_TREEVIEW      = NO
     726
     727# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
     728# used to set the initial width (in pixels) of the frame in which the tree
     729# is shown.
     730
     731TREEVIEW_WIDTH         = 250
     732
     733#---------------------------------------------------------------------------
     734# configuration options related to the LaTeX output
     735#---------------------------------------------------------------------------
     736
     737# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
     738# generate Latex output.
     739
     740GENERATE_LATEX         = NO
     741
     742# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
     743# If a relative path is entered the value of OUTPUT_DIRECTORY will be
     744# put in front of it. If left blank `latex' will be used as the default path.
     745
     746LATEX_OUTPUT           = latex
     747
     748# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
     749# invoked. If left blank `latex' will be used as the default command name.
     750
     751LATEX_CMD_NAME         = latex
     752
     753# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
     754# generate index for LaTeX. If left blank `makeindex' will be used as the
     755# default command name.
     756
     757MAKEINDEX_CMD_NAME     = makeindex
     758
     759# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
     760# LaTeX documents. This may be useful for small projects and may help to
     761# save some trees in general.
     762
     763COMPACT_LATEX          = NO
     764
     765# The PAPER_TYPE tag can be used to set the paper type that is used
     766# by the printer. Possible values are: a4, a4wide, letter, legal and
     767# executive. If left blank a4wide will be used.
     768
     769PAPER_TYPE             = a4wide
     770
     771# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
     772# packages that should be included in the LaTeX output.
     773
     774EXTRA_PACKAGES         =
     775
     776# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
     777# the generated latex document. The header should contain everything until
     778# the first chapter. If it is left blank doxygen will generate a
     779# standard header. Notice: only use this tag if you know what you are doing!
     780
     781LATEX_HEADER           =
     782
     783# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
     784# is prepared for conversion to pdf (using ps2pdf). The pdf file will
     785# contain links (just like the HTML output) instead of page references
     786# This makes the output suitable for online browsing using a pdf viewer.
     787
     788PDF_HYPERLINKS         = NO
     789
     790# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
     791# plain latex in the generated Makefile. Set this option to YES to get a
     792# higher quality PDF documentation.
     793
     794USE_PDFLATEX           = NO
     795
     796# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
     797# command to the generated LaTeX files. This will instruct LaTeX to keep
     798# running if errors occur, instead of asking the user for help.
     799# This option is also used when generating formulas in HTML.
     800
     801LATEX_BATCHMODE        = NO
     802
     803# If LATEX_HIDE_INDICES is set to YES then doxygen will not
     804# include the index chapters (such as File Index, Compound Index, etc.)
     805# in the output.
     806
     807LATEX_HIDE_INDICES     = NO
     808
     809#---------------------------------------------------------------------------
     810# configuration options related to the RTF output
     811#---------------------------------------------------------------------------
     812
     813# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
     814# The RTF output is optimized for Word 97 and may not look very pretty with
     815# other RTF readers or editors.
     816
     817GENERATE_RTF           = NO
     818
     819# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
     820# If a relative path is entered the value of OUTPUT_DIRECTORY will be
     821# put in front of it. If left blank `rtf' will be used as the default path.
     822
     823RTF_OUTPUT             = rtf
     824
     825# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
     826# RTF documents. This may be useful for small projects and may help to
     827# save some trees in general.
     828
     829COMPACT_RTF            = NO
     830
     831# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
     832# will contain hyperlink fields. The RTF file will
     833# contain links (just like the HTML output) instead of page references.
     834# This makes the output suitable for online browsing using WORD or other
     835# programs which support those fields.
     836# Note: wordpad (write) and others do not support links.
     837
     838RTF_HYPERLINKS         = NO
     839
     840# Load stylesheet definitions from file. Syntax is similar to doxygen's
     841# config file, i.e. a series of assignments. You only have to provide
     842# replacements, missing definitions are set to their default value.
     843
     844RTF_STYLESHEET_FILE    =
     845
     846# Set optional variables used in the generation of an rtf document.
     847# Syntax is similar to doxygen's config file.
     848
     849RTF_EXTENSIONS_FILE    =
     850
     851#---------------------------------------------------------------------------
     852# configuration options related to the man page output
     853#---------------------------------------------------------------------------
     854
     855# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
     856# generate man pages
     857
     858GENERATE_MAN           = NO
     859
     860# The MAN_OUTPUT tag is used to specify where the man pages will be put.
     861# If a relative path is entered the value of OUTPUT_DIRECTORY will be
     862# put in front of it. If left blank `man' will be used as the default path.
     863
     864MAN_OUTPUT             = man
     865
     866# The MAN_EXTENSION tag determines the extension that is added to
     867# the generated man pages (default is the subroutine's section .3)
     868
     869MAN_EXTENSION          = .3
     870
     871# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
     872# then it will generate one additional man file for each entity
     873# documented in the real man page(s). These additional files
     874# only source the real man page, but without them the man command
     875# would be unable to find the correct page. The default is NO.
     876
     877MAN_LINKS              = NO
     878
     879#---------------------------------------------------------------------------
     880# configuration options related to the XML output
     881#---------------------------------------------------------------------------
     882
     883# If the GENERATE_XML tag is set to YES Doxygen will
     884# generate an XML file that captures the structure of
     885# the code including all documentation.
     886
     887GENERATE_XML           = NO
     888
     889# The XML_OUTPUT tag is used to specify where the XML pages will be put.
     890# If a relative path is entered the value of OUTPUT_DIRECTORY will be
     891# put in front of it. If left blank `xml' will be used as the default path.
     892
     893XML_OUTPUT             = xml
     894
     895# The XML_SCHEMA tag can be used to specify an XML schema,
     896# which can be used by a validating XML parser to check the
     897# syntax of the XML files.
     898
     899XML_SCHEMA             =
     900
     901# The XML_DTD tag can be used to specify an XML DTD,
     902# which can be used by a validating XML parser to check the
     903# syntax of the XML files.
     904
     905XML_DTD                =
     906
     907# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
     908# dump the program listings (including syntax highlighting
     909# and cross-referencing information) to the XML output. Note that
     910# enabling this will significantly increase the size of the XML output.
     911
     912XML_PROGRAMLISTING     = YES
     913
     914#---------------------------------------------------------------------------
     915# configuration options for the AutoGen Definitions output
     916#---------------------------------------------------------------------------
     917
     918# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
     919# generate an AutoGen Definitions (see autogen.sf.net) file
     920# that captures the structure of the code including all
     921# documentation. Note that this feature is still experimental
     922# and incomplete at the moment.
     923
     924GENERATE_AUTOGEN_DEF   = NO
     925
     926#---------------------------------------------------------------------------
     927# configuration options related to the Perl module output
     928#---------------------------------------------------------------------------
     929
     930# If the GENERATE_PERLMOD tag is set to YES Doxygen will
     931# generate a Perl module file that captures the structure of
     932# the code including all documentation. Note that this
     933# feature is still experimental and incomplete at the
     934# moment.
     935
     936GENERATE_PERLMOD       = NO
     937
     938# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
     939# the necessary Makefile rules, Perl scripts and LaTeX code to be able
     940# to generate PDF and DVI output from the Perl module output.
     941
     942PERLMOD_LATEX          = NO
     943
     944# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
     945# nicely formatted so it can be parsed by a human reader.  This is useful
     946# if you want to understand what is going on.  On the other hand, if this
     947# tag is set to NO the size of the Perl module output will be much smaller
     948# and Perl will parse it just the same.
     949
     950PERLMOD_PRETTY         = YES
     951
     952# The names of the make variables in the generated doxyrules.make file
     953# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
     954# This is useful so different doxyrules.make files included by the same
     955# Makefile don't overwrite each other's variables.
     956
     957PERLMOD_MAKEVAR_PREFIX =
     958
     959#---------------------------------------------------------------------------
     960# Configuration options related to the preprocessor   
     961#---------------------------------------------------------------------------
     962
     963# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
     964# evaluate all C-preprocessor directives found in the sources and include
     965# files.
     966
     967ENABLE_PREPROCESSING   = YES
     968
     969# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
     970# names in the source code. If set to NO (the default) only conditional
     971# compilation will be performed. Macro expansion can be done in a controlled
     972# way by setting EXPAND_ONLY_PREDEF to YES.
     973
     974MACRO_EXPANSION        = NO
     975
     976# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
     977# then the macro expansion is limited to the macros specified with the
     978# PREDEFINED and EXPAND_AS_DEFINED tags.
     979
     980EXPAND_ONLY_PREDEF     = NO
     981
     982# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
     983# in the INCLUDE_PATH (see below) will be search if a #include is found.
     984
     985SEARCH_INCLUDES        = YES
     986
     987# The INCLUDE_PATH tag can be used to specify one or more directories that
     988# contain include files that are not input files but should be processed by
     989# the preprocessor.
     990
     991INCLUDE_PATH           =
     992
     993# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
     994# patterns (like *.h and *.hpp) to filter out the header-files in the
     995# directories. If left blank, the patterns specified with FILE_PATTERNS will
     996# be used.
     997
     998INCLUDE_FILE_PATTERNS  =
     999
     1000# The PREDEFINED tag can be used to specify one or more macro names that
     1001# are defined before the preprocessor is started (similar to the -D option of
     1002# gcc). The argument of the tag is a list of macros of the form: name
     1003# or name=definition (no spaces). If the definition and the = are
     1004# omitted =1 is assumed. To prevent a macro definition from being
     1005# undefined via #undef or recursively expanded use the := operator
     1006# instead of the = operator.
     1007
     1008PREDEFINED             =
     1009
     1010# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
     1011# this tag can be used to specify a list of macro names that should be expanded.
     1012# The macro definition that is found in the sources will be used.
     1013# Use the PREDEFINED tag if you want to use a different macro definition.
     1014
     1015EXPAND_AS_DEFINED      =
     1016
     1017# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
     1018# doxygen's preprocessor will remove all function-like macros that are alone
     1019# on a line, have an all uppercase name, and do not end with a semicolon. Such
     1020# function macros are typically used for boiler-plate code, and will confuse
     1021# the parser if not removed.
     1022
     1023SKIP_FUNCTION_MACROS   = YES
     1024
     1025#---------------------------------------------------------------------------
     1026# Configuration::additions related to external references   
     1027#---------------------------------------------------------------------------
     1028
     1029# The TAGFILES option can be used to specify one or more tagfiles.
     1030# Optionally an initial location of the external documentation
     1031# can be added for each tagfile. The format of a tag file without
     1032# this location is as follows:
     1033#   TAGFILES = file1 file2 ...
     1034# Adding location for the tag files is done as follows:
     1035#   TAGFILES = file1=loc1 "file2 = loc2" ...
     1036# where "loc1" and "loc2" can be relative or absolute paths or
     1037# URLs. If a location is present for each tag, the installdox tool
     1038# does not have to be run to correct the links.
     1039# Note that each tag file must have a unique name
     1040# (where the name does NOT include the path)
     1041# If a tag file is not located in the directory in which doxygen
     1042# is run, you must also specify the path to the tagfile here.
     1043
     1044TAGFILES               =
     1045
     1046# When a file name is specified after GENERATE_TAGFILE, doxygen will create
     1047# a tag file that is based on the input files it reads.
     1048
     1049GENERATE_TAGFILE       =
     1050
     1051# If the ALLEXTERNALS tag is set to YES all external classes will be listed
     1052# in the class index. If set to NO only the inherited external classes
     1053# will be listed.
     1054
     1055ALLEXTERNALS           = NO
     1056
     1057# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
     1058# in the modules index. If set to NO, only the current project's groups will
     1059# be listed.
     1060
     1061EXTERNAL_GROUPS        = YES
     1062
     1063# The PERL_PATH should be the absolute path and name of the perl script
     1064# interpreter (i.e. the result of `which perl').
     1065
     1066PERL_PATH              = /usr/bin/perl
     1067
     1068#---------------------------------------------------------------------------
     1069# Configuration options related to the dot tool   
     1070#---------------------------------------------------------------------------
     1071
     1072# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
     1073# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
     1074# or super classes. Setting the tag to NO turns the diagrams off. Note that
     1075# this option is superseded by the HAVE_DOT option below. This is only a
     1076# fallback. It is recommended to install and use dot, since it yields more
     1077# powerful graphs.
     1078
     1079CLASS_DIAGRAMS         = YES
     1080
     1081# If set to YES, the inheritance and collaboration graphs will hide
     1082# inheritance and usage relations if the target is undocumented
     1083# or is not a class.
     1084
     1085HIDE_UNDOC_RELATIONS   = YES
     1086
     1087# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
     1088# available from the path. This tool is part of Graphviz, a graph visualization
     1089# toolkit from AT&T and Lucent Bell Labs. The other options in this section
     1090# have no effect if this option is set to NO (the default)
     1091
     1092HAVE_DOT               = YES
     1093
     1094# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
     1095# will generate a graph for each documented class showing the direct and
     1096# indirect inheritance relations. Setting this tag to YES will force the
     1097# the CLASS_DIAGRAMS tag to NO.
     1098
     1099CLASS_GRAPH            = YES
     1100
     1101# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
     1102# will generate a graph for each documented class showing the direct and
     1103# indirect implementation dependencies (inheritance, containment, and
     1104# class references variables) of the class with other documented classes.
     1105
     1106COLLABORATION_GRAPH    = YES
     1107
     1108# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
     1109# will generate a graph for groups, showing the direct groups dependencies
     1110
     1111GROUP_GRAPHS           = YES
     1112
     1113# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
     1114# collaboration diagrams in a style similar to the OMG's Unified Modeling
     1115# Language.
     1116
     1117UML_LOOK               = NO
     1118
     1119# If set to YES, the inheritance and collaboration graphs will show the
     1120# relations between templates and their instances.
     1121
     1122TEMPLATE_RELATIONS     = NO
     1123
     1124# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
     1125# tags are set to YES then doxygen will generate a graph for each documented
     1126# file showing the direct and indirect include dependencies of the file with
     1127# other documented files.
     1128
     1129INCLUDE_GRAPH          = YES
     1130
     1131# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
     1132# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
     1133# documented header file showing the documented files that directly or
     1134# indirectly include this file.
     1135
     1136INCLUDED_BY_GRAPH      = YES
     1137
     1138# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
     1139# generate a call dependency graph for every global function or class method.
     1140# Note that enabling this option will significantly increase the time of a run.
     1141# So in most cases it will be better to enable call graphs for selected
     1142# functions only using the \callgraph command.
     1143
     1144CALL_GRAPH             = NO
     1145
     1146# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
     1147# will graphical hierarchy of all classes instead of a textual one.
     1148
     1149GRAPHICAL_HIERARCHY    = YES
     1150
     1151# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
     1152# then doxygen will show the dependencies a directory has on other directories
     1153# in a graphical way. The dependency relations are determined by the #include
     1154# relations between the files in the directories.
     1155
     1156DIRECTORY_GRAPH        = YES
     1157
     1158# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
     1159# generated by dot. Possible values are png, jpg, or gif
     1160# If left blank png will be used.
     1161
     1162DOT_IMAGE_FORMAT       = png
     1163
     1164# The tag DOT_PATH can be used to specify the path where the dot tool can be
     1165# found. If left blank, it is assumed the dot tool can be found in the path.
     1166
     1167DOT_PATH               =
     1168
     1169# The DOTFILE_DIRS tag can be used to specify one or more directories that
     1170# contain dot files that are included in the documentation (see the
     1171# \dotfile command).
     1172
     1173DOTFILE_DIRS           =
     1174
     1175# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
     1176# (in pixels) of the graphs generated by dot. If a graph becomes larger than
     1177# this value, doxygen will try to truncate the graph, so that it fits within
     1178# the specified constraint. Beware that most browsers cannot cope with very
     1179# large images.
     1180
     1181MAX_DOT_GRAPH_WIDTH    = 1024
     1182
     1183# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
     1184# (in pixels) of the graphs generated by dot. If a graph becomes larger than
     1185# this value, doxygen will try to truncate the graph, so that it fits within
     1186# the specified constraint. Beware that most browsers cannot cope with very
     1187# large images.
     1188
     1189MAX_DOT_GRAPH_HEIGHT   = 1024
     1190
     1191# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
     1192# graphs generated by dot. A depth value of 3 means that only nodes reachable
     1193# from the root by following a path via at most 3 edges will be shown. Nodes
     1194# that lay further from the root node will be omitted. Note that setting this
     1195# option to 1 or 2 may greatly reduce the computation time needed for large
     1196# code bases. Also note that a graph may be further truncated if the graph's
     1197# image dimensions are not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH
     1198# and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the depth value (the default),
     1199# the graph is not depth-constrained.
     1200
     1201MAX_DOT_GRAPH_DEPTH    = 0
     1202
     1203# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
     1204# background. This is disabled by default, which results in a white background.
     1205# Warning: Depending on the platform used, enabling this option may lead to
     1206# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
     1207# read).
     1208
     1209DOT_TRANSPARENT        = NO
     1210
     1211# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
     1212# files in one run (i.e. multiple -o and -T options on the command line). This
     1213# makes dot run faster, but since only newer versions of dot (>1.8.10)
     1214# support this, this feature is disabled by default.
     1215
     1216DOT_MULTI_TARGETS      = NO
     1217
     1218# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
     1219# generate a legend page explaining the meaning of the various boxes and
     1220# arrows in the dot generated graphs.
     1221
     1222GENERATE_LEGEND        = YES
     1223
     1224# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
     1225# remove the intermediate dot files that are used to generate
     1226# the various graphs.
     1227
     1228DOT_CLEANUP            = YES
     1229
     1230#---------------------------------------------------------------------------
     1231# Configuration::additions related to the search engine   
     1232#---------------------------------------------------------------------------
     1233
     1234# The SEARCHENGINE tag specifies whether or not a search engine should be
     1235# used. If set to NO the values of all tags below this one will be ignored.
     1236
     1237SEARCHENGINE           = YES
Note: See TracChangeset for help on using the changeset viewer.