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