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