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