Chris@253: # Doxyfile 1.4.4
Chris@253: 
Chris@253: # This file describes the settings to be used by the documentation system
Chris@253: # doxygen (www.doxygen.org) for a project
Chris@253: #
Chris@253: # All text after a hash (#) is considered a comment and will be ignored
Chris@253: # The format is:
Chris@253: #       TAG = value [value, ...]
Chris@253: # For lists items can also be appended using:
Chris@253: #       TAG += value [value, ...]
Chris@253: # Values that contain spaces should be placed between quotes (" ")
Chris@253: 
Chris@253: #---------------------------------------------------------------------------
Chris@253: # Project related configuration options
Chris@253: #---------------------------------------------------------------------------
Chris@253: 
Chris@253: # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
Chris@253: # by quotes) that should identify the project.
Chris@253: 
Chris@253: PROJECT_NAME           = svapp
Chris@253: 
Chris@253: # The PROJECT_NUMBER tag can be used to enter a project or revision number.
Chris@253: # This could be handy for archiving the generated documentation or
Chris@253: # if some version control system is used.
Chris@253: 
Chris@253: PROJECT_NUMBER         = 1.9
Chris@253: 
Chris@253: # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
Chris@253: # base path where the generated documentation will be put.
Chris@253: # If a relative path is entered, it will be relative to the location
Chris@253: # where doxygen was started. If left blank the current directory will be used.
Chris@253: 
Chris@253: OUTPUT_DIRECTORY       = doc
Chris@253: 
Chris@253: # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
Chris@253: # 4096 sub-directories (in 2 levels) under the output directory of each output
Chris@253: # format and will distribute the generated files over these directories.
Chris@253: # Enabling this option can be useful when feeding doxygen a huge amount of
Chris@253: # source files, where putting all generated files in the same directory would
Chris@253: # otherwise cause performance problems for the file system.
Chris@253: 
Chris@253: CREATE_SUBDIRS         = NO
Chris@253: 
Chris@253: # The OUTPUT_LANGUAGE tag is used to specify the language in which all
Chris@253: # documentation generated by doxygen is written. Doxygen will use this
Chris@253: # information to generate all constant output in the proper language.
Chris@253: # The default language is English, other supported languages are:
Chris@253: # Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish,
Chris@253: # Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese,
Chris@253: # Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian,
Chris@253: # Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish,
Chris@253: # Swedish, and Ukrainian.
Chris@253: 
Chris@253: OUTPUT_LANGUAGE        = English
Chris@253: 
Chris@253: # This tag can be used to specify the encoding used in the generated output.
Chris@253: # The encoding is not always determined by the language that is chosen,
Chris@253: # but also whether or not the output is meant for Windows or non-Windows users.
Chris@253: # In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES
Chris@253: # forces the Windows encoding (this is the default for the Windows binary),
Chris@253: # whereas setting the tag to NO uses a Unix-style encoding (the default for
Chris@253: # all platforms other than Windows).
Chris@253: 
Chris@253: USE_WINDOWS_ENCODING   = NO
Chris@253: 
Chris@253: # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
Chris@253: # include brief member descriptions after the members that are listed in
Chris@253: # the file and class documentation (similar to JavaDoc).
Chris@253: # Set to NO to disable this.
Chris@253: 
Chris@253: BRIEF_MEMBER_DESC      = YES
Chris@253: 
Chris@253: # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
Chris@253: # the brief description of a member or function before the detailed description.
Chris@253: # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
Chris@253: # brief descriptions will be completely suppressed.
Chris@253: 
Chris@253: REPEAT_BRIEF           = YES
Chris@253: 
Chris@253: # This tag implements a quasi-intelligent brief description abbreviator
Chris@253: # that is used to form the text in various listings. Each string
Chris@253: # in this list, if found as the leading text of the brief description, will be
Chris@253: # stripped from the text and the result after processing the whole list, is
Chris@253: # used as the annotated text. Otherwise, the brief description is used as-is.
Chris@253: # If left blank, the following values are used ("$name" is automatically
Chris@253: # replaced with the name of the entity): "The $name class" "The $name widget"
Chris@253: # "The $name file" "is" "provides" "specifies" "contains"
Chris@253: # "represents" "a" "an" "the"
Chris@253: 
Chris@253: ABBREVIATE_BRIEF       =
Chris@253: 
Chris@253: # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
Chris@253: # Doxygen will generate a detailed section even if there is only a brief
Chris@253: # description.
Chris@253: 
Chris@253: ALWAYS_DETAILED_SEC    = NO
Chris@253: 
Chris@253: # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
Chris@253: # inherited members of a class in the documentation of that class as if those
Chris@253: # members were ordinary class members. Constructors, destructors and assignment
Chris@253: # operators of the base classes will not be shown.
Chris@253: 
Chris@253: INLINE_INHERITED_MEMB  = YES
Chris@253: 
Chris@253: # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
Chris@253: # path before files name in the file list and in the header files. If set
Chris@253: # to NO the shortest path that makes the file name unique will be used
Chris@253: 
Chris@253: FULL_PATH_NAMES        = NO
Chris@253: 
Chris@253: # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
Chris@253: # can be used to strip a user-defined part of the path. Stripping is
Chris@253: # only done if one of the specified strings matches the left-hand part of
Chris@253: # the path. The tag can be used to show relative paths in the file list.
Chris@253: # If left blank the directory from which doxygen is run is used as the
Chris@253: # path to strip.
Chris@253: 
Chris@253: STRIP_FROM_PATH        =
Chris@253: 
Chris@253: # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
Chris@253: # the path mentioned in the documentation of a class, which tells
Chris@253: # the reader which header file to include in order to use a class.
Chris@253: # If left blank only the name of the header file containing the class
Chris@253: # definition is used. Otherwise one should specify the include paths that
Chris@253: # are normally passed to the compiler using the -I flag.
Chris@253: 
Chris@253: STRIP_FROM_INC_PATH    =
Chris@253: 
Chris@253: # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
Chris@253: # (but less readable) file names. This can be useful is your file systems
Chris@253: # doesn't support long names like on DOS, Mac, or CD-ROM.
Chris@253: 
Chris@253: SHORT_NAMES            = NO
Chris@253: 
Chris@253: # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
Chris@253: # will interpret the first line (until the first dot) of a JavaDoc-style
Chris@253: # comment as the brief description. If set to NO, the JavaDoc
Chris@253: # comments will behave just like the Qt-style comments (thus requiring an
Chris@253: # explicit @brief command for a brief description.
Chris@253: 
Chris@253: JAVADOC_AUTOBRIEF      = YES
Chris@253: 
Chris@253: # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
Chris@253: # treat a multi-line C++ special comment block (i.e. a block of //! or ///
Chris@253: # comments) as a brief description. This used to be the default behaviour.
Chris@253: # The new default is to treat a multi-line C++ comment block as a detailed
Chris@253: # description. Set this tag to YES if you prefer the old behaviour instead.
Chris@253: 
Chris@253: MULTILINE_CPP_IS_BRIEF = NO
Chris@253: 
Chris@253: # If the DETAILS_AT_TOP tag is set to YES then Doxygen
Chris@253: # will output the detailed description near the top, like JavaDoc.
Chris@253: # If set to NO, the detailed description appears after the member
Chris@253: # documentation.
Chris@253: 
Chris@253: DETAILS_AT_TOP         = YES
Chris@253: 
Chris@253: # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
Chris@253: # member inherits the documentation from any documented member that it
Chris@253: # re-implements.
Chris@253: 
Chris@253: INHERIT_DOCS           = YES
Chris@253: 
Chris@253: # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
Chris@253: # tag is set to YES, then doxygen will reuse the documentation of the first
Chris@253: # member in the group (if any) for the other members of the group. By default
Chris@253: # all members of a group must be documented explicitly.
Chris@253: 
Chris@253: DISTRIBUTE_GROUP_DOC   = NO
Chris@253: 
Chris@253: # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
Chris@253: # a new page for each member. If set to NO, the documentation of a member will
Chris@253: # be part of the file/class/namespace that contains it.
Chris@253: 
Chris@253: SEPARATE_MEMBER_PAGES  = NO
Chris@253: 
Chris@253: # The TAB_SIZE tag can be used to set the number of spaces in a tab.
Chris@253: # Doxygen uses this value to replace tabs by spaces in code fragments.
Chris@253: 
Chris@253: TAB_SIZE               = 8
Chris@253: 
Chris@253: # This tag can be used to specify a number of aliases that acts
Chris@253: # as commands in the documentation. An alias has the form "name=value".
Chris@253: # For example adding "sideeffect=\par Side Effects:\n" will allow you to
Chris@253: # put the command \sideeffect (or @sideeffect) in the documentation, which
Chris@253: # will result in a user-defined paragraph with heading "Side Effects:".
Chris@253: # You can put \n's in the value part of an alias to insert newlines.
Chris@253: 
Chris@253: ALIASES                =
Chris@253: 
Chris@253: # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
Chris@253: # sources only. Doxygen will then generate output that is more tailored for C.
Chris@253: # For instance, some of the names that are used will be different. The list
Chris@253: # of all members will be omitted, etc.
Chris@253: 
Chris@253: OPTIMIZE_OUTPUT_FOR_C  = NO
Chris@253: 
Chris@253: # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
Chris@253: # only. Doxygen will then generate output that is more tailored for Java.
Chris@253: # For instance, namespaces will be presented as packages, qualified scopes
Chris@253: # will look different, etc.
Chris@253: 
Chris@253: OPTIMIZE_OUTPUT_JAVA   = NO
Chris@253: 
Chris@253: # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
Chris@253: # the same type (for instance a group of public functions) to be put as a
Chris@253: # subgroup of that type (e.g. under the Public Functions section). Set it to
Chris@253: # NO to prevent subgrouping. Alternatively, this can be done per class using
Chris@253: # the \nosubgrouping command.
Chris@253: 
Chris@253: SUBGROUPING            = YES
Chris@253: 
Chris@253: #---------------------------------------------------------------------------
Chris@253: # Build related configuration options
Chris@253: #---------------------------------------------------------------------------
Chris@253: 
Chris@253: # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
Chris@253: # documentation are documented, even if no documentation was available.
Chris@253: # Private class members and static file members will be hidden unless
Chris@253: # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
Chris@253: 
Chris@253: EXTRACT_ALL            = YES
Chris@253: 
Chris@253: # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
Chris@253: # will be included in the documentation.
Chris@253: 
Chris@253: EXTRACT_PRIVATE        = YES
Chris@253: 
Chris@253: # If the EXTRACT_STATIC tag is set to YES all static members of a file
Chris@253: # will be included in the documentation.
Chris@253: 
Chris@253: EXTRACT_STATIC         = YES
Chris@253: 
Chris@253: # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
Chris@253: # defined locally in source files will be included in the documentation.
Chris@253: # If set to NO only classes defined in header files are included.
Chris@253: 
Chris@253: EXTRACT_LOCAL_CLASSES  = YES
Chris@253: 
Chris@253: # This flag is only useful for Objective-C code. When set to YES local
Chris@253: # methods, which are defined in the implementation section but not in
Chris@253: # the interface are included in the documentation.
Chris@253: # If set to NO (the default) only methods in the interface are included.
Chris@253: 
Chris@253: EXTRACT_LOCAL_METHODS  = NO
Chris@253: 
Chris@253: # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
Chris@253: # undocumented members of documented classes, files or namespaces.
Chris@253: # If set to NO (the default) these members will be included in the
Chris@253: # various overviews, but no documentation section is generated.
Chris@253: # This option has no effect if EXTRACT_ALL is enabled.
Chris@253: 
Chris@253: HIDE_UNDOC_MEMBERS     = NO
Chris@253: 
Chris@253: # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
Chris@253: # undocumented classes that are normally visible in the class hierarchy.
Chris@253: # If set to NO (the default) these classes will be included in the various
Chris@253: # overviews. This option has no effect if EXTRACT_ALL is enabled.
Chris@253: 
Chris@253: HIDE_UNDOC_CLASSES     = NO
Chris@253: 
Chris@253: # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
Chris@253: # friend (class|struct|union) declarations.
Chris@253: # If set to NO (the default) these declarations will be included in the
Chris@253: # documentation.
Chris@253: 
Chris@253: HIDE_FRIEND_COMPOUNDS  = NO
Chris@253: 
Chris@253: # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
Chris@253: # documentation blocks found inside the body of a function.
Chris@253: # If set to NO (the default) these blocks will be appended to the
Chris@253: # function's detailed documentation block.
Chris@253: 
Chris@253: HIDE_IN_BODY_DOCS      = NO
Chris@253: 
Chris@253: # The INTERNAL_DOCS tag determines if documentation
Chris@253: # that is typed after a \internal command is included. If the tag is set
Chris@253: # to NO (the default) then the documentation will be excluded.
Chris@253: # Set it to YES to include the internal documentation.
Chris@253: 
Chris@253: INTERNAL_DOCS          = NO
Chris@253: 
Chris@253: # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
Chris@253: # file names in lower-case letters. If set to YES upper-case letters are also
Chris@253: # allowed. This is useful if you have classes or files whose names only differ
Chris@253: # in case and if your file system supports case sensitive file names. Windows
Chris@253: # and Mac users are advised to set this option to NO.
Chris@253: 
Chris@253: CASE_SENSE_NAMES       = YES
Chris@253: 
Chris@253: # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
Chris@253: # will show members with their full class and namespace scopes in the
Chris@253: # documentation. If set to YES the scope will be hidden.
Chris@253: 
Chris@253: HIDE_SCOPE_NAMES       = NO
Chris@253: 
Chris@253: # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
Chris@253: # will put a list of the files that are included by a file in the documentation
Chris@253: # of that file.
Chris@253: 
Chris@253: SHOW_INCLUDE_FILES     = YES
Chris@253: 
Chris@253: # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
Chris@253: # is inserted in the documentation for inline members.
Chris@253: 
Chris@253: INLINE_INFO            = YES
Chris@253: 
Chris@253: # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
Chris@253: # will sort the (detailed) documentation of file and class members
Chris@253: # alphabetically by member name. If set to NO the members will appear in
Chris@253: # declaration order.
Chris@253: 
Chris@253: SORT_MEMBER_DOCS       = NO
Chris@253: 
Chris@253: # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
Chris@253: # brief documentation of file, namespace and class members alphabetically
Chris@253: # by member name. If set to NO (the default) the members will appear in
Chris@253: # declaration order.
Chris@253: 
Chris@253: SORT_BRIEF_DOCS        = NO
Chris@253: 
Chris@253: # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
Chris@253: # sorted by fully-qualified names, including namespaces. If set to
Chris@253: # NO (the default), the class list will be sorted only by class name,
Chris@253: # not including the namespace part.
Chris@253: # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
Chris@253: # Note: This option applies only to the class list, not to the
Chris@253: # alphabetical list.
Chris@253: 
Chris@253: SORT_BY_SCOPE_NAME     = NO
Chris@253: 
Chris@253: # The GENERATE_TODOLIST tag can be used to enable (YES) or
Chris@253: # disable (NO) the todo list. This list is created by putting \todo
Chris@253: # commands in the documentation.
Chris@253: 
Chris@253: GENERATE_TODOLIST      = YES
Chris@253: 
Chris@253: # The GENERATE_TESTLIST tag can be used to enable (YES) or
Chris@253: # disable (NO) the test list. This list is created by putting \test
Chris@253: # commands in the documentation.
Chris@253: 
Chris@253: GENERATE_TESTLIST      = YES
Chris@253: 
Chris@253: # The GENERATE_BUGLIST tag can be used to enable (YES) or
Chris@253: # disable (NO) the bug list. This list is created by putting \bug
Chris@253: # commands in the documentation.
Chris@253: 
Chris@253: GENERATE_BUGLIST       = YES
Chris@253: 
Chris@253: # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
Chris@253: # disable (NO) the deprecated list. This list is created by putting
Chris@253: # \deprecated commands in the documentation.
Chris@253: 
Chris@253: GENERATE_DEPRECATEDLIST= YES
Chris@253: 
Chris@253: # The ENABLED_SECTIONS tag can be used to enable conditional
Chris@253: # documentation sections, marked by \if sectionname ... \endif.
Chris@253: 
Chris@253: ENABLED_SECTIONS       =
Chris@253: 
Chris@253: # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
Chris@253: # the initial value of a variable or define consists of for it to appear in
Chris@253: # the documentation. If the initializer consists of more lines than specified
Chris@253: # here it will be hidden. Use a value of 0 to hide initializers completely.
Chris@253: # The appearance of the initializer of individual variables and defines in the
Chris@253: # documentation can be controlled using \showinitializer or \hideinitializer
Chris@253: # command in the documentation regardless of this setting.
Chris@253: 
Chris@253: MAX_INITIALIZER_LINES  = 30
Chris@253: 
Chris@253: # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
Chris@253: # at the bottom of the documentation of classes and structs. If set to YES the
Chris@253: # list will mention the files that were used to generate the documentation.
Chris@253: 
Chris@253: SHOW_USED_FILES        = YES
Chris@253: 
Chris@253: # If the sources in your project are distributed over multiple directories
Chris@253: # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
Chris@253: # in the documentation. The default is YES.
Chris@253: 
Chris@253: SHOW_DIRECTORIES       = YES
Chris@253: 
Chris@253: # The FILE_VERSION_FILTER tag can be used to specify a program or script that
Chris@253: # doxygen should invoke to get the current version for each file (typically from the
Chris@253: # version control system). Doxygen will invoke the program by executing (via
Chris@253: # popen()) the command <command> <input-file>, where <command> is the value of
Chris@253: # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
Chris@253: # provided by doxygen. Whatever the progam writes to standard output
Chris@253: # is used as the file version. See the manual for examples.
Chris@253: 
Chris@253: FILE_VERSION_FILTER    =
Chris@253: 
Chris@253: #---------------------------------------------------------------------------
Chris@253: # configuration options related to warning and progress messages
Chris@253: #---------------------------------------------------------------------------
Chris@253: 
Chris@253: # The QUIET tag can be used to turn on/off the messages that are generated
Chris@253: # by doxygen. Possible values are YES and NO. If left blank NO is used.
Chris@253: 
Chris@253: QUIET                  = NO
Chris@253: 
Chris@253: # The WARNINGS tag can be used to turn on/off the warning messages that are
Chris@253: # generated by doxygen. Possible values are YES and NO. If left blank
Chris@253: # NO is used.
Chris@253: 
Chris@253: WARNINGS               = YES
Chris@253: 
Chris@253: # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
Chris@253: # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
Chris@253: # automatically be disabled.
Chris@253: 
Chris@253: WARN_IF_UNDOCUMENTED   = YES
Chris@253: 
Chris@253: # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
Chris@253: # potential errors in the documentation, such as not documenting some
Chris@253: # parameters in a documented function, or documenting parameters that
Chris@253: # don't exist or using markup commands wrongly.
Chris@253: 
Chris@253: WARN_IF_DOC_ERROR      = YES
Chris@253: 
Chris@253: # This WARN_NO_PARAMDOC option can be abled to get warnings for
Chris@253: # functions that are documented, but have no documentation for their parameters
Chris@253: # or return value. If set to NO (the default) doxygen will only warn about
Chris@253: # wrong or incomplete parameter documentation, but not about the absence of
Chris@253: # documentation.
Chris@253: 
Chris@253: WARN_NO_PARAMDOC       = YES
Chris@253: 
Chris@253: # The WARN_FORMAT tag determines the format of the warning messages that
Chris@253: # doxygen can produce. The string should contain the $file, $line, and $text
Chris@253: # tags, which will be replaced by the file and line number from which the
Chris@253: # warning originated and the warning text. Optionally the format may contain
Chris@253: # $version, which will be replaced by the version of the file (if it could
Chris@253: # be obtained via FILE_VERSION_FILTER)
Chris@253: 
Chris@253: WARN_FORMAT            = "$file:$line: $text"
Chris@253: 
Chris@253: # The WARN_LOGFILE tag can be used to specify a file to which warning
Chris@253: # and error messages should be written. If left blank the output is written
Chris@253: # to stderr.
Chris@253: 
Chris@253: WARN_LOGFILE           = docs/doxygen/warning.log
Chris@253: 
Chris@253: #---------------------------------------------------------------------------
Chris@253: # configuration options related to the input files
Chris@253: #---------------------------------------------------------------------------
Chris@253: 
Chris@253: # The INPUT tag can be used to specify the files and/or directories that contain
Chris@253: # documented source files. You may enter file names like "myfile.cpp" or
Chris@253: # directories like "/usr/src/myproject". Separate the files or directories
Chris@253: # with spaces.
Chris@253: 
Chris@253: INPUT                  = audioio framework 
Chris@253: 
Chris@253: # If the value of the INPUT tag contains directories, you can use the
Chris@253: # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
Chris@253: # and *.h) to filter out the source-files in the directories. If left
Chris@253: # blank the following patterns are tested:
Chris@253: # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
Chris@253: # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm
Chris@253: 
Chris@253: FILE_PATTERNS          = *.h \
Chris@253:                          *.C \
Chris@253:                          *.cpp \
Chris@253:                          *.cc
Chris@253: 
Chris@253: # The RECURSIVE tag can be used to turn specify whether or not subdirectories
Chris@253: # should be searched for input files as well. Possible values are YES and NO.
Chris@253: # If left blank NO is used.
Chris@253: 
Chris@253: RECURSIVE              = NO
Chris@253: 
Chris@253: # The EXCLUDE tag can be used to specify files and/or directories that should
Chris@253: # excluded from the INPUT source files. This way you can easily exclude a
Chris@253: # subdirectory from a directory tree whose root is specified with the INPUT tag.
Chris@253: 
Chris@253: EXCLUDE                =
Chris@253: 
Chris@253: # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
Chris@253: # directories that are symbolic links (a Unix filesystem feature) are excluded
Chris@253: # from the input.
Chris@253: 
Chris@253: EXCLUDE_SYMLINKS       = NO
Chris@253: 
Chris@253: # If the value of the INPUT tag contains directories, you can use the
Chris@253: # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
Chris@253: # certain files from those directories. Note that the wildcards are matched
Chris@253: # against the file with absolute path, so to exclude all test directories
Chris@253: # for example use the pattern */test/*
Chris@253: 
Chris@253: EXCLUDE_PATTERNS       = qrc_*.cpp \
Chris@253:                          moc_*.cpp \
Chris@253:                          *.moc.cpp \
Chris@253:                          *_skel.cpp
Chris@253: 
Chris@253: # The EXAMPLE_PATH tag can be used to specify one or more files or
Chris@253: # directories that contain example code fragments that are included (see
Chris@253: # the \include command).
Chris@253: 
Chris@253: EXAMPLE_PATH           =
Chris@253: 
Chris@253: # If the value of the EXAMPLE_PATH tag contains directories, you can use the
Chris@253: # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
Chris@253: # and *.h) to filter out the source-files in the directories. If left
Chris@253: # blank all files are included.
Chris@253: 
Chris@253: EXAMPLE_PATTERNS       =
Chris@253: 
Chris@253: # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
Chris@253: # searched for input files to be used with the \include or \dontinclude
Chris@253: # commands irrespective of the value of the RECURSIVE tag.
Chris@253: # Possible values are YES and NO. If left blank NO is used.
Chris@253: 
Chris@253: EXAMPLE_RECURSIVE      = NO
Chris@253: 
Chris@253: # The IMAGE_PATH tag can be used to specify one or more files or
Chris@253: # directories that contain image that are included in the documentation (see
Chris@253: # the \image command).
Chris@253: 
Chris@253: IMAGE_PATH             =
Chris@253: 
Chris@253: # The INPUT_FILTER tag can be used to specify a program that doxygen should
Chris@253: # invoke to filter for each input file. Doxygen will invoke the filter program
Chris@253: # by executing (via popen()) the command <filter> <input-file>, where <filter>
Chris@253: # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
Chris@253: # input file. Doxygen will then use the output that the filter program writes
Chris@253: # to standard output.  If FILTER_PATTERNS is specified, this tag will be
Chris@253: # ignored.
Chris@253: 
Chris@253: INPUT_FILTER           =
Chris@253: 
Chris@253: # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
Chris@253: # basis.  Doxygen will compare the file name with each pattern and apply the
Chris@253: # filter if there is a match.  The filters are a list of the form:
Chris@253: # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
Chris@253: # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
Chris@253: # is applied to all files.
Chris@253: 
Chris@253: FILTER_PATTERNS        =
Chris@253: 
Chris@253: # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
Chris@253: # INPUT_FILTER) will be used to filter the input files when producing source
Chris@253: # files to browse (i.e. when SOURCE_BROWSER is set to YES).
Chris@253: 
Chris@253: FILTER_SOURCE_FILES    = NO
Chris@253: 
Chris@253: #---------------------------------------------------------------------------
Chris@253: # configuration options related to source browsing
Chris@253: #---------------------------------------------------------------------------
Chris@253: 
Chris@253: # If the SOURCE_BROWSER tag is set to YES then a list of source files will
Chris@253: # be generated. Documented entities will be cross-referenced with these sources.
Chris@253: # Note: To get rid of all source code in the generated output, make sure also
Chris@253: # VERBATIM_HEADERS is set to NO.
Chris@253: 
Chris@253: SOURCE_BROWSER         = YES
Chris@253: 
Chris@253: # Setting the INLINE_SOURCES tag to YES will include the body
Chris@253: # of functions and classes directly in the documentation.
Chris@253: 
Chris@253: INLINE_SOURCES         = NO
Chris@253: 
Chris@253: # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
Chris@253: # doxygen to hide any special comment blocks from generated source code
Chris@253: # fragments. Normal C and C++ comments will always remain visible.
Chris@253: 
Chris@253: STRIP_CODE_COMMENTS    = YES
Chris@253: 
Chris@253: # If the REFERENCED_BY_RELATION tag is set to YES (the default)
Chris@253: # then for each documented function all documented
Chris@253: # functions referencing it will be listed.
Chris@253: 
Chris@253: REFERENCED_BY_RELATION = YES
Chris@253: 
Chris@253: # If the REFERENCES_RELATION tag is set to YES (the default)
Chris@253: # then for each documented function all documented entities
Chris@253: # called/used by that function will be listed.
Chris@253: 
Chris@253: REFERENCES_RELATION    = YES
Chris@253: 
Chris@253: # If the USE_HTAGS tag is set to YES then the references to source code
Chris@253: # will point to the HTML generated by the htags(1) tool instead of doxygen
Chris@253: # built-in source browser. The htags tool is part of GNU's global source
Chris@253: # tagging system (see http://www.gnu.org/software/global/global.html). You
Chris@253: # will need version 4.8.6 or higher.
Chris@253: 
Chris@253: #USE_HTAGS              = NO
Chris@253: 
Chris@253: # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
Chris@253: # will generate a verbatim copy of the header file for each class for
Chris@253: # which an include is specified. Set to NO to disable this.
Chris@253: 
Chris@253: VERBATIM_HEADERS       = YES
Chris@253: 
Chris@253: #---------------------------------------------------------------------------
Chris@253: # configuration options related to the alphabetical class index
Chris@253: #---------------------------------------------------------------------------
Chris@253: 
Chris@253: # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
Chris@253: # of all compounds will be generated. Enable this if the project
Chris@253: # contains a lot of classes, structs, unions or interfaces.
Chris@253: 
Chris@253: ALPHABETICAL_INDEX     = YES
Chris@253: 
Chris@253: # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
Chris@253: # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
Chris@253: # in which this list will be split (can be a number in the range [1..20])
Chris@253: 
Chris@253: COLS_IN_ALPHA_INDEX    = 3
Chris@253: 
Chris@253: # In case all classes in a project start with a common prefix, all
Chris@253: # classes will be put under the same header in the alphabetical index.
Chris@253: # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
Chris@253: # should be ignored while generating the index headers.
Chris@253: 
Chris@253: IGNORE_PREFIX          =
Chris@253: 
Chris@253: #---------------------------------------------------------------------------
Chris@253: # configuration options related to the HTML output
Chris@253: #---------------------------------------------------------------------------
Chris@253: 
Chris@253: # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
Chris@253: # generate HTML output.
Chris@253: 
Chris@253: GENERATE_HTML          = YES
Chris@253: 
Chris@253: # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
Chris@253: # If a relative path is entered the value of OUTPUT_DIRECTORY will be
Chris@253: # put in front of it. If left blank `html' will be used as the default path.
Chris@253: 
Chris@253: HTML_OUTPUT            = html
Chris@253: 
Chris@253: # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
Chris@253: # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
Chris@253: # doxygen will generate files with .html extension.
Chris@253: 
Chris@253: HTML_FILE_EXTENSION    = .html
Chris@253: 
Chris@253: # The HTML_HEADER tag can be used to specify a personal HTML header for
Chris@253: # each generated HTML page. If it is left blank doxygen will generate a
Chris@253: # standard header.
Chris@253: 
Chris@253: HTML_HEADER            =
Chris@253: 
Chris@253: # The HTML_FOOTER tag can be used to specify a personal HTML footer for
Chris@253: # each generated HTML page. If it is left blank doxygen will generate a
Chris@253: # standard footer.
Chris@253: 
Chris@253: HTML_FOOTER            =
Chris@253: 
Chris@253: # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
Chris@253: # style sheet that is used by each HTML page. It can be used to
Chris@253: # fine-tune the look of the HTML output. If the tag is left blank doxygen
Chris@253: # will generate a default style sheet. Note that doxygen will try to copy
Chris@253: # the style sheet file to the HTML output directory, so don't put your own
Chris@253: # stylesheet in the HTML output directory as well, or it will be erased!
Chris@253: 
Chris@253: HTML_STYLESHEET        =
Chris@253: 
Chris@253: # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
Chris@253: # files or namespaces will be aligned in HTML using tables. If set to
Chris@253: # NO a bullet list will be used.
Chris@253: 
Chris@253: HTML_ALIGN_MEMBERS     = YES
Chris@253: 
Chris@253: # If the GENERATE_HTMLHELP tag is set to YES, additional index files
Chris@253: # will be generated that can be used as input for tools like the
Chris@253: # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
Chris@253: # of the generated HTML documentation.
Chris@253: 
Chris@253: GENERATE_HTMLHELP      = NO
Chris@253: 
Chris@253: # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
Chris@253: # be used to specify the file name of the resulting .chm file. You
Chris@253: # can add a path in front of the file if the result should not be
Chris@253: # written to the html output directory.
Chris@253: 
Chris@253: CHM_FILE               =
Chris@253: 
Chris@253: # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
Chris@253: # be used to specify the location (absolute path including file name) of
Chris@253: # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
Chris@253: # the HTML help compiler on the generated index.hhp.
Chris@253: 
Chris@253: HHC_LOCATION           =
Chris@253: 
Chris@253: # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
Chris@253: # controls if a separate .chi index file is generated (YES) or that
Chris@253: # it should be included in the master .chm file (NO).
Chris@253: 
Chris@253: GENERATE_CHI           = NO
Chris@253: 
Chris@253: # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
Chris@253: # controls whether a binary table of contents is generated (YES) or a
Chris@253: # normal table of contents (NO) in the .chm file.
Chris@253: 
Chris@253: BINARY_TOC             = NO
Chris@253: 
Chris@253: # The TOC_EXPAND flag can be set to YES to add extra items for group members
Chris@253: # to the contents of the HTML help documentation and to the tree view.
Chris@253: 
Chris@253: TOC_EXPAND             = NO
Chris@253: 
Chris@253: # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
Chris@253: # top of each HTML page. The value NO (the default) enables the index and
Chris@253: # the value YES disables it.
Chris@253: 
Chris@253: DISABLE_INDEX          = NO
Chris@253: 
Chris@253: # This tag can be used to set the number of enum values (range [1..20])
Chris@253: # that doxygen will group on one line in the generated HTML documentation.
Chris@253: 
Chris@253: ENUM_VALUES_PER_LINE   = 4
Chris@253: 
Chris@253: # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
Chris@253: # generated containing a tree-like index structure (just like the one that
Chris@253: # is generated for HTML Help). For this to work a browser that supports
Chris@253: # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
Chris@253: # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
Chris@253: # probably better off using the HTML help feature.
Chris@253: 
Chris@253: GENERATE_TREEVIEW      = YES
Chris@253: 
Chris@253: # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
Chris@253: # used to set the initial width (in pixels) of the frame in which the tree
Chris@253: # is shown.
Chris@253: 
Chris@253: TREEVIEW_WIDTH         = 250
Chris@253: 
Chris@253: #---------------------------------------------------------------------------
Chris@253: # configuration options related to the LaTeX output
Chris@253: #---------------------------------------------------------------------------
Chris@253: 
Chris@253: # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
Chris@253: # generate Latex output.
Chris@253: 
Chris@253: GENERATE_LATEX         = NO
Chris@253: 
Chris@253: # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
Chris@253: # If a relative path is entered the value of OUTPUT_DIRECTORY will be
Chris@253: # put in front of it. If left blank `latex' will be used as the default path.
Chris@253: 
Chris@253: LATEX_OUTPUT           = latex
Chris@253: 
Chris@253: # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
Chris@253: # invoked. If left blank `latex' will be used as the default command name.
Chris@253: 
Chris@253: LATEX_CMD_NAME         = latex
Chris@253: 
Chris@253: # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
Chris@253: # generate index for LaTeX. If left blank `makeindex' will be used as the
Chris@253: # default command name.
Chris@253: 
Chris@253: MAKEINDEX_CMD_NAME     = makeindex
Chris@253: 
Chris@253: # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
Chris@253: # LaTeX documents. This may be useful for small projects and may help to
Chris@253: # save some trees in general.
Chris@253: 
Chris@253: COMPACT_LATEX          = NO
Chris@253: 
Chris@253: # The PAPER_TYPE tag can be used to set the paper type that is used
Chris@253: # by the printer. Possible values are: a4, a4wide, letter, legal and
Chris@253: # executive. If left blank a4wide will be used.
Chris@253: 
Chris@253: PAPER_TYPE             = a4wide
Chris@253: 
Chris@253: # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
Chris@253: # packages that should be included in the LaTeX output.
Chris@253: 
Chris@253: EXTRA_PACKAGES         =
Chris@253: 
Chris@253: # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
Chris@253: # the generated latex document. The header should contain everything until
Chris@253: # the first chapter. If it is left blank doxygen will generate a
Chris@253: # standard header. Notice: only use this tag if you know what you are doing!
Chris@253: 
Chris@253: LATEX_HEADER           =
Chris@253: 
Chris@253: # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
Chris@253: # is prepared for conversion to pdf (using ps2pdf). The pdf file will
Chris@253: # contain links (just like the HTML output) instead of page references
Chris@253: # This makes the output suitable for online browsing using a pdf viewer.
Chris@253: 
Chris@253: PDF_HYPERLINKS         = NO
Chris@253: 
Chris@253: # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
Chris@253: # plain latex in the generated Makefile. Set this option to YES to get a
Chris@253: # higher quality PDF documentation.
Chris@253: 
Chris@253: USE_PDFLATEX           = NO
Chris@253: 
Chris@253: # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
Chris@253: # command to the generated LaTeX files. This will instruct LaTeX to keep
Chris@253: # running if errors occur, instead of asking the user for help.
Chris@253: # This option is also used when generating formulas in HTML.
Chris@253: 
Chris@253: LATEX_BATCHMODE        = NO
Chris@253: 
Chris@253: # If LATEX_HIDE_INDICES is set to YES then doxygen will not
Chris@253: # include the index chapters (such as File Index, Compound Index, etc.)
Chris@253: # in the output.
Chris@253: 
Chris@253: LATEX_HIDE_INDICES     = NO
Chris@253: 
Chris@253: #---------------------------------------------------------------------------
Chris@253: # configuration options related to the RTF output
Chris@253: #---------------------------------------------------------------------------
Chris@253: 
Chris@253: # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
Chris@253: # The RTF output is optimized for Word 97 and may not look very pretty with
Chris@253: # other RTF readers or editors.
Chris@253: 
Chris@253: GENERATE_RTF           = NO
Chris@253: 
Chris@253: # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
Chris@253: # If a relative path is entered the value of OUTPUT_DIRECTORY will be
Chris@253: # put in front of it. If left blank `rtf' will be used as the default path.
Chris@253: 
Chris@253: RTF_OUTPUT             = rtf
Chris@253: 
Chris@253: # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
Chris@253: # RTF documents. This may be useful for small projects and may help to
Chris@253: # save some trees in general.
Chris@253: 
Chris@253: COMPACT_RTF            = NO
Chris@253: 
Chris@253: # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
Chris@253: # will contain hyperlink fields. The RTF file will
Chris@253: # contain links (just like the HTML output) instead of page references.
Chris@253: # This makes the output suitable for online browsing using WORD or other
Chris@253: # programs which support those fields.
Chris@253: # Note: wordpad (write) and others do not support links.
Chris@253: 
Chris@253: RTF_HYPERLINKS         = NO
Chris@253: 
Chris@253: # Load stylesheet definitions from file. Syntax is similar to doxygen's
Chris@253: # config file, i.e. a series of assignments. You only have to provide
Chris@253: # replacements, missing definitions are set to their default value.
Chris@253: 
Chris@253: RTF_STYLESHEET_FILE    =
Chris@253: 
Chris@253: # Set optional variables used in the generation of an rtf document.
Chris@253: # Syntax is similar to doxygen's config file.
Chris@253: 
Chris@253: RTF_EXTENSIONS_FILE    =
Chris@253: 
Chris@253: #---------------------------------------------------------------------------
Chris@253: # configuration options related to the man page output
Chris@253: #---------------------------------------------------------------------------
Chris@253: 
Chris@253: # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
Chris@253: # generate man pages
Chris@253: 
Chris@253: GENERATE_MAN           = NO
Chris@253: 
Chris@253: # The MAN_OUTPUT tag is used to specify where the man pages will be put.
Chris@253: # If a relative path is entered the value of OUTPUT_DIRECTORY will be
Chris@253: # put in front of it. If left blank `man' will be used as the default path.
Chris@253: 
Chris@253: MAN_OUTPUT             = man
Chris@253: 
Chris@253: # The MAN_EXTENSION tag determines the extension that is added to
Chris@253: # the generated man pages (default is the subroutine's section .3)
Chris@253: 
Chris@253: MAN_EXTENSION          = .3
Chris@253: 
Chris@253: # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
Chris@253: # then it will generate one additional man file for each entity
Chris@253: # documented in the real man page(s). These additional files
Chris@253: # only source the real man page, but without them the man command
Chris@253: # would be unable to find the correct page. The default is NO.
Chris@253: 
Chris@253: MAN_LINKS              = NO
Chris@253: 
Chris@253: #---------------------------------------------------------------------------
Chris@253: # configuration options related to the XML output
Chris@253: #---------------------------------------------------------------------------
Chris@253: 
Chris@253: # If the GENERATE_XML tag is set to YES Doxygen will
Chris@253: # generate an XML file that captures the structure of
Chris@253: # the code including all documentation.
Chris@253: 
Chris@253: GENERATE_XML           = NO
Chris@253: 
Chris@253: # The XML_OUTPUT tag is used to specify where the XML pages will be put.
Chris@253: # If a relative path is entered the value of OUTPUT_DIRECTORY will be
Chris@253: # put in front of it. If left blank `xml' will be used as the default path.
Chris@253: 
Chris@253: XML_OUTPUT             = xml
Chris@253: 
Chris@253: # The XML_SCHEMA tag can be used to specify an XML schema,
Chris@253: # which can be used by a validating XML parser to check the
Chris@253: # syntax of the XML files.
Chris@253: 
Chris@253: XML_SCHEMA             =
Chris@253: 
Chris@253: # The XML_DTD tag can be used to specify an XML DTD,
Chris@253: # which can be used by a validating XML parser to check the
Chris@253: # syntax of the XML files.
Chris@253: 
Chris@253: XML_DTD                =
Chris@253: 
Chris@253: # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
Chris@253: # dump the program listings (including syntax highlighting
Chris@253: # and cross-referencing information) to the XML output. Note that
Chris@253: # enabling this will significantly increase the size of the XML output.
Chris@253: 
Chris@253: XML_PROGRAMLISTING     = YES
Chris@253: 
Chris@253: #---------------------------------------------------------------------------
Chris@253: # configuration options for the AutoGen Definitions output
Chris@253: #---------------------------------------------------------------------------
Chris@253: 
Chris@253: # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
Chris@253: # generate an AutoGen Definitions (see autogen.sf.net) file
Chris@253: # that captures the structure of the code including all
Chris@253: # documentation. Note that this feature is still experimental
Chris@253: # and incomplete at the moment.
Chris@253: 
Chris@253: GENERATE_AUTOGEN_DEF   = NO
Chris@253: 
Chris@253: #---------------------------------------------------------------------------
Chris@253: # configuration options related to the Perl module output
Chris@253: #---------------------------------------------------------------------------
Chris@253: 
Chris@253: # If the GENERATE_PERLMOD tag is set to YES Doxygen will
Chris@253: # generate a Perl module file that captures the structure of
Chris@253: # the code including all documentation. Note that this
Chris@253: # feature is still experimental and incomplete at the
Chris@253: # moment.
Chris@253: 
Chris@253: GENERATE_PERLMOD       = NO
Chris@253: 
Chris@253: # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
Chris@253: # the necessary Makefile rules, Perl scripts and LaTeX code to be able
Chris@253: # to generate PDF and DVI output from the Perl module output.
Chris@253: 
Chris@253: PERLMOD_LATEX          = NO
Chris@253: 
Chris@253: # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
Chris@253: # nicely formatted so it can be parsed by a human reader.  This is useful
Chris@253: # if you want to understand what is going on.  On the other hand, if this
Chris@253: # tag is set to NO the size of the Perl module output will be much smaller
Chris@253: # and Perl will parse it just the same.
Chris@253: 
Chris@253: PERLMOD_PRETTY         = YES
Chris@253: 
Chris@253: # The names of the make variables in the generated doxyrules.make file
Chris@253: # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
Chris@253: # This is useful so different doxyrules.make files included by the same
Chris@253: # Makefile don't overwrite each other's variables.
Chris@253: 
Chris@253: PERLMOD_MAKEVAR_PREFIX =
Chris@253: 
Chris@253: #---------------------------------------------------------------------------
Chris@253: # Configuration options related to the preprocessor
Chris@253: #---------------------------------------------------------------------------
Chris@253: 
Chris@253: # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
Chris@253: # evaluate all C-preprocessor directives found in the sources and include
Chris@253: # files.
Chris@253: 
Chris@253: ENABLE_PREPROCESSING   = YES
Chris@253: 
Chris@253: # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
Chris@253: # names in the source code. If set to NO (the default) only conditional
Chris@253: # compilation will be performed. Macro expansion can be done in a controlled
Chris@253: # way by setting EXPAND_ONLY_PREDEF to YES.
Chris@253: 
Chris@253: MACRO_EXPANSION        = NO
Chris@253: 
Chris@253: # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
Chris@253: # then the macro expansion is limited to the macros specified with the
Chris@253: # PREDEFINED and EXPAND_AS_PREDEFINED tags.
Chris@253: 
Chris@253: EXPAND_ONLY_PREDEF     = NO
Chris@253: 
Chris@253: # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
Chris@253: # in the INCLUDE_PATH (see below) will be search if a #include is found.
Chris@253: 
Chris@253: SEARCH_INCLUDES        = YES
Chris@253: 
Chris@253: # The INCLUDE_PATH tag can be used to specify one or more directories that
Chris@253: # contain include files that are not input files but should be processed by
Chris@253: # the preprocessor.
Chris@253: 
Chris@254: INCLUDE_PATH           = 
Chris@253: 
Chris@253: # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
Chris@253: # patterns (like *.h and *.hpp) to filter out the header-files in the
Chris@253: # directories. If left blank, the patterns specified with FILE_PATTERNS will
Chris@253: # be used.
Chris@253: 
Chris@253: INCLUDE_FILE_PATTERNS  = Q* *.h
Chris@253: 
Chris@253: # The PREDEFINED tag can be used to specify one or more macro names that
Chris@253: # are defined before the preprocessor is started (similar to the -D option of
Chris@253: # gcc). The argument of the tag is a list of macros of the form: name
Chris@253: # or name=definition (no spaces). If the definition and the = are
Chris@253: # omitted =1 is assumed. To prevent a macro definition from being
Chris@253: # undefined via #undef or recursively expanded use the := operator
Chris@253: # instead of the = operator.
Chris@253: 
Chris@253: PREDEFINED             = HAVE_FFTW3F HAVE_FISHSOUND HAVE_JACK HAVE_LIBLO HAVE_LRDF HAVE_MAD HAVE_OGGZ HAVE_PORTAUDIO HAVE_SAMPLERATE HAVE_SNDFILE HAVE_VAMP
Chris@253: 
Chris@253: # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
Chris@253: # this tag can be used to specify a list of macro names that should be expanded.
Chris@253: # The macro definition that is found in the sources will be used.
Chris@253: # Use the PREDEFINED tag if you want to use a different macro definition.
Chris@253: 
Chris@253: EXPAND_AS_DEFINED      =
Chris@253: 
Chris@253: # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
Chris@253: # doxygen's preprocessor will remove all function-like macros that are alone
Chris@253: # on a line, have an all uppercase name, and do not end with a semicolon. Such
Chris@253: # function macros are typically used for boiler-plate code, and will confuse
Chris@253: # the parser if not removed.
Chris@253: 
Chris@253: SKIP_FUNCTION_MACROS   = YES
Chris@253: 
Chris@253: #---------------------------------------------------------------------------
Chris@253: # Configuration::additions related to external references
Chris@253: #---------------------------------------------------------------------------
Chris@253: 
Chris@253: # The TAGFILES option can be used to specify one or more tagfiles.
Chris@253: # Optionally an initial location of the external documentation
Chris@253: # can be added for each tagfile. The format of a tag file without
Chris@253: # this location is as follows:
Chris@253: #   TAGFILES = file1 file2 ...
Chris@253: # Adding location for the tag files is done as follows:
Chris@253: #   TAGFILES = file1=loc1 "file2 = loc2" ...
Chris@253: # where "loc1" and "loc2" can be relative or absolute paths or
Chris@253: # URLs. If a location is present for each tag, the installdox tool
Chris@253: # does not have to be run to correct the links.
Chris@253: # Note that each tag file must have a unique name
Chris@253: # (where the name does NOT include the path)
Chris@253: # If a tag file is not located in the directory in which doxygen
Chris@253: # is run, you must also specify the path to the tagfile here.
Chris@253: 
Chris@253: TAGFILES               =
Chris@253: 
Chris@253: # When a file name is specified after GENERATE_TAGFILE, doxygen will create
Chris@253: # a tag file that is based on the input files it reads.
Chris@253: 
Chris@253: GENERATE_TAGFILE       =
Chris@253: 
Chris@253: # If the ALLEXTERNALS tag is set to YES all external classes will be listed
Chris@253: # in the class index. If set to NO only the inherited external classes
Chris@253: # will be listed.
Chris@253: 
Chris@253: ALLEXTERNALS           = NO
Chris@253: 
Chris@253: # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
Chris@253: # in the modules index. If set to NO, only the current project's groups will
Chris@253: # be listed.
Chris@253: 
Chris@253: EXTERNAL_GROUPS        = YES
Chris@253: 
Chris@253: # The PERL_PATH should be the absolute path and name of the perl script
Chris@253: # interpreter (i.e. the result of `which perl').
Chris@253: 
Chris@253: PERL_PATH              = /usr/bin/perl
Chris@253: 
Chris@253: #---------------------------------------------------------------------------
Chris@253: # Configuration options related to the dot tool
Chris@253: #---------------------------------------------------------------------------
Chris@253: 
Chris@253: # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
Chris@253: # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
Chris@253: # or super classes. Setting the tag to NO turns the diagrams off. Note that
Chris@253: # this option is superseded by the HAVE_DOT option below. This is only a
Chris@253: # fallback. It is recommended to install and use dot, since it yields more
Chris@253: # powerful graphs.
Chris@253: 
Chris@253: CLASS_DIAGRAMS         = NO
Chris@253: 
Chris@253: # If set to YES, the inheritance and collaboration graphs will hide
Chris@253: # inheritance and usage relations if the target is undocumented
Chris@253: # or is not a class.
Chris@253: 
Chris@253: HIDE_UNDOC_RELATIONS   = YES
Chris@253: 
Chris@253: # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
Chris@253: # available from the path. This tool is part of Graphviz, a graph visualization
Chris@253: # toolkit from AT&T and Lucent Bell Labs. The other options in this section
Chris@253: # have no effect if this option is set to NO (the default)
Chris@253: 
Chris@253: HAVE_DOT               = YES
Chris@253: 
Chris@253: # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
Chris@253: # will generate a graph for each documented class showing the direct and
Chris@253: # indirect inheritance relations. Setting this tag to YES will force the
Chris@253: # the CLASS_DIAGRAMS tag to NO.
Chris@253: 
Chris@253: CLASS_GRAPH            = YES
Chris@253: 
Chris@253: # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
Chris@253: # will generate a graph for each documented class showing the direct and
Chris@253: # indirect implementation dependencies (inheritance, containment, and
Chris@253: # class references variables) of the class with other documented classes.
Chris@253: 
Chris@253: COLLABORATION_GRAPH    = YES
Chris@253: 
Chris@253: # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
Chris@253: # will generate a graph for groups, showing the direct groups dependencies
Chris@253: 
Chris@253: GROUP_GRAPHS           = YES
Chris@253: 
Chris@253: # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
Chris@253: # collaboration diagrams in a style similar to the OMG's Unified Modeling
Chris@253: # Language.
Chris@253: 
Chris@253: UML_LOOK               = NO
Chris@253: 
Chris@253: # If set to YES, the inheritance and collaboration graphs will show the
Chris@253: # relations between templates and their instances.
Chris@253: 
Chris@253: TEMPLATE_RELATIONS     = NO
Chris@253: 
Chris@253: # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
Chris@253: # tags are set to YES then doxygen will generate a graph for each documented
Chris@253: # file showing the direct and indirect include dependencies of the file with
Chris@253: # other documented files.
Chris@253: 
Chris@253: INCLUDE_GRAPH          = YES
Chris@253: 
Chris@253: # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
Chris@253: # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
Chris@253: # documented header file showing the documented files that directly or
Chris@253: # indirectly include this file.
Chris@253: 
Chris@253: INCLUDED_BY_GRAPH      = YES
Chris@253: 
Chris@253: # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
Chris@253: # generate a call dependency graph for every global function or class method.
Chris@253: # Note that enabling this option will significantly increase the time of a run.
Chris@253: # So in most cases it will be better to enable call graphs for selected
Chris@253: # functions only using the \callgraph command.
Chris@253: 
Chris@253: CALL_GRAPH             = NO
Chris@253: 
Chris@253: # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
Chris@253: # will graphical hierarchy of all classes instead of a textual one.
Chris@253: 
Chris@253: GRAPHICAL_HIERARCHY    = YES
Chris@253: 
Chris@253: # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
Chris@253: # then doxygen will show the dependencies a directory has on other directories
Chris@253: # in a graphical way. The dependency relations are determined by the #include
Chris@253: # relations between the files in the directories.
Chris@253: 
Chris@253: DIRECTORY_GRAPH        = YES
Chris@253: 
Chris@253: # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
Chris@253: # generated by dot. Possible values are png, jpg, or gif
Chris@253: # If left blank png will be used.
Chris@253: 
Chris@253: DOT_IMAGE_FORMAT       = png
Chris@253: 
Chris@253: # The tag DOT_PATH can be used to specify the path where the dot tool can be
Chris@253: # found. If left blank, it is assumed the dot tool can be found in the path.
Chris@253: 
Chris@253: DOT_PATH               =
Chris@253: 
Chris@253: # The DOTFILE_DIRS tag can be used to specify one or more directories that
Chris@253: # contain dot files that are included in the documentation (see the
Chris@253: # \dotfile command).
Chris@253: 
Chris@253: DOTFILE_DIRS           =
Chris@253: 
Chris@253: # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
Chris@253: # (in pixels) of the graphs generated by dot. If a graph becomes larger than
Chris@253: # this value, doxygen will try to truncate the graph, so that it fits within
Chris@253: # the specified constraint. Beware that most browsers cannot cope with very
Chris@253: # large images.
Chris@253: 
Chris@253: MAX_DOT_GRAPH_WIDTH    = 1024
Chris@253: 
Chris@253: # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
Chris@253: # (in pixels) of the graphs generated by dot. If a graph becomes larger than
Chris@253: # this value, doxygen will try to truncate the graph, so that it fits within
Chris@253: # the specified constraint. Beware that most browsers cannot cope with very
Chris@253: # large images.
Chris@253: 
Chris@253: MAX_DOT_GRAPH_HEIGHT   = 1024
Chris@253: 
Chris@253: # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
Chris@253: # graphs generated by dot. A depth value of 3 means that only nodes reachable
Chris@253: # from the root by following a path via at most 3 edges will be shown. Nodes
Chris@253: # that lay further from the root node will be omitted. Note that setting this
Chris@253: # option to 1 or 2 may greatly reduce the computation time needed for large
Chris@253: # code bases. Also note that a graph may be further truncated if the graph's
Chris@253: # image dimensions are not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH
Chris@253: # and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the depth value (the default),
Chris@253: # the graph is not depth-constrained.
Chris@253: 
Chris@253: MAX_DOT_GRAPH_DEPTH    = 0
Chris@253: 
Chris@253: # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
Chris@253: # background. This is disabled by default, which results in a white background.
Chris@253: # Warning: Depending on the platform used, enabling this option may lead to
Chris@253: # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
Chris@253: # read).
Chris@253: 
Chris@253: DOT_TRANSPARENT        = NO
Chris@253: 
Chris@253: # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
Chris@253: # files in one run (i.e. multiple -o and -T options on the command line). This
Chris@253: # makes dot run faster, but since only newer versions of dot (>1.8.10)
Chris@253: # support this, this feature is disabled by default.
Chris@253: 
Chris@253: DOT_MULTI_TARGETS      = YES
Chris@253: 
Chris@253: # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
Chris@253: # generate a legend page explaining the meaning of the various boxes and
Chris@253: # arrows in the dot generated graphs.
Chris@253: 
Chris@253: GENERATE_LEGEND        = YES
Chris@253: 
Chris@253: # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
Chris@253: # remove the intermediate dot files that are used to generate
Chris@253: # the various graphs.
Chris@253: 
Chris@253: DOT_CLEANUP            = YES
Chris@253: 
Chris@253: #---------------------------------------------------------------------------
Chris@253: # Configuration::additions related to the search engine
Chris@253: #---------------------------------------------------------------------------
Chris@253: 
Chris@253: # The SEARCHENGINE tag specifies whether or not a search engine should be
Chris@253: # used. If set to NO the values of all tags below this one will be ignored.
Chris@253: 
Chris@253: SEARCHENGINE           = NO