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