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