Changeset dba677f for doc/web.cfg
- Timestamp:
- Dec 7, 2013, 8:30:10 PM (10 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:
- 916f0929
- Parents:
- 251da3b
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
doc/web.cfg
r251da3b rdba677f 1 # Doxyfile 1.8. 3.11 # Doxyfile 1.8.5 2 2 3 3 # This file describes the settings to be used by the documentation system 4 4 # doxygen (www.doxygen.org) for a project. 5 5 # 6 # All text after a hash (#) is considered a comment and will be ignored. 6 # All text after a double hash (##) is considered a comment and is placed in 7 # front of the TAG it is preceding. 8 # 9 # All text after a single hash (#) is considered a comment and will be ignored. 7 10 # The format is: 8 # 9 # For lists items can also be appended using:10 # 11 # Values that contain spaces should be placed between quotes ( "").11 # TAG = value [value, ...] 12 # For lists, items can also be appended using: 13 # TAG += value [value, ...] 14 # Values that contain spaces should be placed between quotes (\" \"). 12 15 13 16 #--------------------------------------------------------------------------- … … 16 19 17 20 # 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. 21 # that follow. The default is UTF-8 which is also the encoding used for all text 22 # before the first occurrence of this tag. Doxygen uses libiconv (or the iconv 23 # built into libc) for the transcoding. See http://www.gnu.org/software/libiconv 24 # for the list of possible encodings. 25 # The default value is: UTF-8. 22 26 23 27 DOXYFILE_ENCODING = UTF-8 24 28 25 # The PROJECT_NAME tag is a single word (or sequence of words) that should 26 # identify the project. Note that if you do not use Doxywizard you need 27 # to put quotes around the project name if it contains spaces. 29 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by 30 # double-quotes, unless you are using Doxywizard) that should identify the 31 # project for which the documentation is generated. This name is used in the 32 # title of most generated pages and in a few other places. 33 # The default value is: My Project. 28 34 29 35 PROJECT_NAME = aubio 30 36 31 # The PROJECT_NUMBER tag can be used to enter a project or revision number. 32 # This could be handy for archiving the generated documentation or33 # if some versioncontrol system is used.37 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This 38 # could be handy for archiving the generated documentation or if some version 39 # control system is used. 34 40 35 41 PROJECT_NUMBER = "0.4.0alpha" 36 42 37 43 # Using the PROJECT_BRIEF tag one can provide an optional one line description 38 # for a project that appears at the top of each page and should give viewer 39 # aquick idea about the purpose of the project. Keep the description short.44 # for a project that appears at the top of each page and should give viewer a 45 # quick idea about the purpose of the project. Keep the description short. 40 46 41 47 PROJECT_BRIEF = 42 48 43 # With the PROJECT_LOGO tag one can specify an logo or icon that is 44 # included in the documentation. The maximum height of the logo should not45 # exceed 55 pixels and the maximum width should not exceed 200 pixels.46 # Doxygen will copy the logoto the output directory.49 # With the PROJECT_LOGO tag one can specify an logo or icon that is included in 50 # the documentation. The maximum height of the logo should not exceed 55 pixels 51 # and the maximum width should not exceed 200 pixels. Doxygen will copy the logo 52 # to the output directory. 47 53 48 54 PROJECT_LOGO = 49 55 50 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 51 # base path where the generated documentation will be put.52 # If a relative path is entered, it will be relative to the location53 # where doxygen was started. Ifleft blank the current directory will be used.56 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path 57 # into which the generated documentation will be written. If a relative path is 58 # entered, it will be relative to the location where doxygen was started. If 59 # left blank the current directory will be used. 54 60 55 61 OUTPUT_DIRECTORY = web 56 62 57 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 58 # 4096 sub-directories (in 2 levels) under the output directory of each output 59 # format and will distribute the generated files over these directories. 60 # Enabling this option can be useful when feeding doxygen a huge amount of 61 # source files, where putting all generated files in the same directory would 62 # otherwise cause performance problems for the file system. 63 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub- 64 # directories (in 2 levels) under the output directory of each output format and 65 # will distribute the generated files over these directories. Enabling this 66 # option can be useful when feeding doxygen a huge amount of source files, where 67 # putting all generated files in the same directory would otherwise causes 68 # performance problems for the file system. 69 # The default value is: NO. 63 70 64 71 CREATE_SUBDIRS = NO … … 67 74 # documentation generated by doxygen is written. Doxygen will use this 68 75 # information to generate all constant output in the proper language. 69 # The default language is English, other supported languages are:70 # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,71 # Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,72 # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English73 # messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,74 # Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak,75 # Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.76 # Possible values are: Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese- 77 # Traditional, Croatian, Czech, Danish, Dutch, English, Esperanto, Farsi, 78 # Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en, 79 # Korean, Korean-en, Latvian, Norwegian, Macedonian, Persian, Polish, 80 # Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, 81 # Turkish, Ukrainian and Vietnamese. 82 # The default value is: English. 76 83 77 84 OUTPUT_LANGUAGE = English 78 85 79 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will80 # include brief member descriptions after the members that are listed in81 # the file and class documentation (similar to JavaDoc).82 # Set to NO to disable this.86 # If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member 87 # descriptions after the members that are listed in the file and class 88 # documentation (similar to Javadoc). Set to NO to disable this. 89 # The default value is: YES. 83 90 84 91 BRIEF_MEMBER_DESC = YES 85 92 86 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 87 # the brief description of a member or function before the detailed description. 88 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 93 # If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief 94 # description of a member or function before the detailed description 95 # 96 # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 89 97 # brief descriptions will be completely suppressed. 98 # The default value is: YES. 90 99 91 100 REPEAT_BRIEF = YES 92 101 93 # This tag implements a quasi-intelligent brief description abbreviator 94 # that is used to form the text in various listings. Each string 95 # in this list, if found as the leading text of the brief description, will be 96 # stripped from the text and the result after processing the whole list, is 97 # used as the annotated text. Otherwise, the brief description is used as-is. 98 # If left blank, the following values are used ("$name" is automatically 99 # replaced with the name of the entity): "The $name class" "The $name widget" 100 # "The $name file" "is" "provides" "specifies" "contains" 101 # "represents" "a" "an" "the" 102 # This tag implements a quasi-intelligent brief description abbreviator that is 103 # used to form the text in various listings. Each string in this list, if found 104 # as the leading text of the brief description, will be stripped from the text 105 # and the result, after processing the whole list, is used as the annotated 106 # text. Otherwise, the brief description is used as-is. If left blank, the 107 # following values are used ($name is automatically replaced with the name of 108 # the entity):The $name class, The $name widget, The $name file, is, provides, 109 # specifies, contains, represents, a, an and the. 102 110 103 111 ABBREVIATE_BRIEF = 104 112 105 113 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 106 # Doxygen will generate a detailed section even if there is only a brief114 # doxygen will generate a detailed section even if there is only a brief 107 115 # description. 116 # The default value is: NO. 108 117 109 118 ALWAYS_DETAILED_SEC = NO … … 113 122 # members were ordinary class members. Constructors, destructors and assignment 114 123 # operators of the base classes will not be shown. 124 # The default value is: NO. 115 125 116 126 INLINE_INHERITED_MEMB = NO 117 127 118 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 119 # path before files name in the file list and in the header files. If set 120 # to NO the shortest path that makes the file name unique will be used. 128 # If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path 129 # before files name in the file list and in the header files. If set to NO the 130 # shortest path that makes the file name unique will be used 131 # The default value is: YES. 121 132 122 133 FULL_PATH_NAMES = YES 123 134 124 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 125 # can be used to strip a user-defined part of the path. Stripping is 126 # only done if one of the specified strings matches the left-hand part of 127 # the path. The tag can be used to show relative paths in the file list. 128 # If left blank the directory from which doxygen is run is used as the 129 # path to strip. Note that you specify absolute paths here, but also 130 # relative paths, which will be relative from the directory where doxygen is 131 # started. 135 # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. 136 # Stripping is only done if one of the specified strings matches the left-hand 137 # part of the path. The tag can be used to show relative paths in the file list. 138 # If left blank the directory from which doxygen is run is used as the path to 139 # strip. 140 # 141 # Note that you can specify absolute paths here, but also relative paths, which 142 # will be relative from the directory where doxygen is started. 143 # This tag requires that the tag FULL_PATH_NAMES is set to YES. 132 144 133 145 STRIP_FROM_PATH = ../src 134 146 135 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 136 # the path mentioned in the documentation of a class, which tells137 # the reader which header file to include in order to use a class.138 # If left blank only the name of the header file containing the class139 # definition is used. Otherwise one should specify the include paths that140 # are normally passed to the compilerusing the -I flag.147 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the 148 # path mentioned in the documentation of a class, which tells the reader which 149 # header file to include in order to use a class. If left blank only the name of 150 # the header file containing the class definition is used. Otherwise one should 151 # specify the list of include paths that are normally passed to the compiler 152 # using the -I flag. 141 153 142 154 STRIP_FROM_INC_PATH = 143 155 144 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 145 # (but less readable) file names. This can be useful if your file system 146 # doesn't support long names like on DOS, Mac, or CD-ROM. 156 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but 157 # less readable) file names. This can be useful is your file systems doesn't 158 # support long names like on DOS, Mac, or CD-ROM. 159 # The default value is: NO. 147 160 148 161 SHORT_NAMES = NO 149 162 150 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 151 # will interpret the first line (until the first dot) of a JavaDoc-style 152 # comment as the brief description. If set to NO, the JavaDoc 153 # comments will behave just like regular Qt-style comments 154 # (thus requiring an explicit @brief command for a brief description.) 163 # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the 164 # first line (until the first dot) of a Javadoc-style comment as the brief 165 # description. If set to NO, the Javadoc-style will behave just like regular Qt- 166 # style comments (thus requiring an explicit @brief command for a brief 167 # description.) 168 # The default value is: NO. 155 169 156 170 JAVADOC_AUTOBRIEF = YES 157 171 158 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will159 # interpret the first line (until the first dot) of a Qt-style160 # comment as the brief description. If set to NO, the comments161 # will behave just like regular Qt-style comments (thus requiring162 # an explicit \brief command for a brief description.)172 # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first 173 # line (until the first dot) of a Qt-style comment as the brief description. If 174 # set to NO, the Qt-style will behave just like regular Qt-style comments (thus 175 # requiring an explicit \brief command for a brief description.) 176 # The default value is: NO. 163 177 164 178 QT_AUTOBRIEF = NO 165 179 166 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 167 # treat a multi-line C++ special comment block (i.e. a block of //! or /// 168 # comments) as a brief description. This used to be the default behaviour. 169 # The new default is to treat a multi-line C++ comment block as a detailed 170 # description. Set this tag to YES if you prefer the old behaviour instead. 180 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a 181 # multi-line C++ special comment block (i.e. a block of //! or /// comments) as 182 # a brief description. This used to be the default behavior. The new default is 183 # to treat a multi-line C++ comment block as a detailed description. Set this 184 # tag to YES if you prefer the old behavior instead. 185 # 186 # Note that setting this tag to YES also means that rational rose comments are 187 # not recognized any more. 188 # The default value is: NO. 171 189 172 190 MULTILINE_CPP_IS_BRIEF = NO 173 191 174 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented175 # member inherits the documentation from any documented member that it176 # re-implements.192 # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the 193 # documentation from any documented member that it re-implements. 194 # The default value is: YES. 177 195 178 196 INHERIT_DOCS = YES 179 197 180 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce 181 # a new page for each member. If set to NO, the documentation of a member will 182 # be part of the file/class/namespace that contains it. 198 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a 199 # new page for each member. If set to NO, the documentation of a member will be 200 # part of the file/class/namespace that contains it. 201 # The default value is: NO. 183 202 184 203 SEPARATE_MEMBER_PAGES = NO 185 204 186 # The TAB_SIZE tag can be used to set the number of spaces in a tab. 187 # Doxygen uses this value to replace tabs by spaces in code fragments. 205 # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen 206 # uses this value to replace tabs by spaces in code fragments. 207 # Minimum value: 1, maximum value: 16, default value: 4. 188 208 189 209 TAB_SIZE = 4 190 210 191 # This tag can be used to specify a number of aliases that acts 192 # as commands in the documentation. An alias has the form "name=value". 193 # For example adding "sideeffect=\par Side Effects:\n" will allow you to 194 # put the command \sideeffect (or @sideeffect) in the documentation, which 195 # will result in a user-defined paragraph with heading "Side Effects:". 196 # You can put \n's in the value part of an alias to insert newlines. 211 # This tag can be used to specify a number of aliases that act as commands in 212 # the documentation. An alias has the form: 213 # name=value 214 # For example adding 215 # "sideeffect=@par Side Effects:\n" 216 # will allow you to put the command \sideeffect (or @sideeffect) in the 217 # documentation, which will result in a user-defined paragraph with heading 218 # "Side Effects:". You can put \n's in the value part of an alias to insert 219 # newlines. 197 220 198 221 ALIASES = 199 222 200 223 # This tag can be used to specify a number of word-keyword mappings (TCL only). 201 # A mapping has the form "name=value". For example adding 202 # "class=itcl::class" will allow you to use the command class in the 203 # itcl::class meaning. 224 # A mapping has the form "name=value". For example adding "class=itcl::class" 225 # will allow you to use the command class in the itcl::class meaning. 204 226 205 227 TCL_SUBST = 206 228 207 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 208 # sources only. Doxygen will then generate output that is more tailored for C. 209 # For instance, some of the names that are used will be different. The list 210 # of all members will be omitted, etc. 229 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources 230 # only. Doxygen will then generate output that is more tailored for C. For 231 # instance, some of the names that are used will be different. The list of all 232 # members will be omitted, etc. 233 # The default value is: NO. 211 234 212 235 OPTIMIZE_OUTPUT_FOR_C = YES 213 236 214 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java 215 # sources only. Doxygen will then generate output that is more tailored for 216 # Java. For instance, namespaces will be presented as packages, qualified 217 # scopes will look different, etc. 237 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or 238 # Python sources only. Doxygen will then generate output that is more tailored 239 # for that language. For instance, namespaces will be presented as packages, 240 # qualified scopes will look different, etc. 241 # The default value is: NO. 218 242 219 243 OPTIMIZE_OUTPUT_JAVA = NO 220 244 221 245 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 222 # sources only. Doxygen will then generate output that is more tailored for223 # Fortran.246 # sources. Doxygen will then generate output that is tailored for Fortran. 247 # The default value is: NO. 224 248 225 249 OPTIMIZE_FOR_FORTRAN = NO 226 250 227 251 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 228 # sources. Doxygen will then generate output that is tailored for 229 # VHDL.252 # sources. Doxygen will then generate output that is tailored for VHDL. 253 # The default value is: NO. 230 254 231 255 OPTIMIZE_OUTPUT_VHDL = NO … … 234 258 # parses. With this tag you can assign which parser to use for a given 235 259 # extension. Doxygen has a built-in mapping, but you can override or extend it 236 # using this tag. The format is ext=language, where ext is a file extension, 237 # and language is one of the parsers supported by doxygen: IDL, Java, 238 # Javascript, CSharp, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, 239 # C++. For instance to make doxygen treat .inc files as Fortran files (default 240 # is PHP), and .f files as C (default is Fortran), use: inc=Fortran f=C. Note 241 # that for custom extensions you also need to set FILE_PATTERNS otherwise the 242 # files are not read by doxygen. 260 # using this tag. The format is ext=language, where ext is a file extension, and 261 # language is one of the parsers supported by doxygen: IDL, Java, Javascript, 262 # C#, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL. For instance to make 263 # doxygen treat .inc files as Fortran files (default is PHP), and .f files as C 264 # (default is Fortran), use: inc=Fortran f=C. 265 # 266 # Note For files without extension you can use no_extension as a placeholder. 267 # 268 # Note that for custom extensions you also need to set FILE_PATTERNS otherwise 269 # the files are not read by doxygen. 243 270 244 271 EXTENSION_MAPPING = 245 272 246 # If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all247 # commentsaccording to the Markdown format, which allows for more readable273 # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments 274 # according to the Markdown format, which allows for more readable 248 275 # documentation. See http://daringfireball.net/projects/markdown/ for details. 249 # The output of markdown processing is further processed by doxygen, so you 250 # can mix doxygen, HTML, and XML commands with Markdown formatting. 251 # Disable only in case of backward compatibilities issues. 276 # The output of markdown processing is further processed by doxygen, so you can 277 # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in 278 # case of backward compatibilities issues. 279 # The default value is: YES. 252 280 253 281 MARKDOWN_SUPPORT = YES 254 282 255 # When enabled doxygen tries to link words that correspond to documented classes, 256 # or namespaces to their corresponding documentation. Such a link can be 257 # prevented in individual cases by by putting a % sign in front of the word or 258 # globally by setting AUTOLINK_SUPPORT to NO. 283 # When enabled doxygen tries to link words that correspond to documented 284 # classes, or namespaces to their corresponding documentation. Such a link can 285 # be prevented in individual cases by by putting a % sign in front of the word 286 # or globally by setting AUTOLINK_SUPPORT to NO. 287 # The default value is: YES. 259 288 260 289 AUTOLINK_SUPPORT = YES 261 290 262 291 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 263 # to include (a tag file for) the STL sources as input, then you should 264 # set thistag to YES in order to let doxygen match functions declarations and265 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.266 # func(std::string) {}). This also makesthe inheritance and collaboration292 # to include (a tag file for) the STL sources as input, then you should set this 293 # tag to YES in order to let doxygen match functions declarations and 294 # definitions whose arguments contain STL classes (e.g. func(std::string); 295 # versus func(std::string) {}). This also make the inheritance and collaboration 267 296 # diagrams that involve STL classes more complete and accurate. 297 # The default value is: NO. 268 298 269 299 BUILTIN_STL_SUPPORT = NO … … 271 301 # If you use Microsoft's C++/CLI language, you should set this option to YES to 272 302 # enable parsing support. 303 # The default value is: NO. 273 304 274 305 CPP_CLI_SUPPORT = NO 275 306 276 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. 277 # Doxygen will parse them like normal C++ but will assume all classes use public 278 # instead of private inheritance when no explicit protection keyword is present. 307 # Set the SIP_SUPPORT tag to YES if your project consists of sip (see: 308 # http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen 309 # will parse them like normal C++ but will assume all classes use public instead 310 # of private inheritance when no explicit protection keyword is present. 311 # The default value is: NO. 279 312 280 313 SIP_SUPPORT = NO 281 314 282 315 # For Microsoft's IDL there are propget and propput attributes to indicate 283 # getter and setter methods for a property. Setting this option to YES (the 284 # default) will make doxygen replace the get and set methods by a property in 285 # the documentation. This will only work if the methods are indeed getting or 286 # setting a simple type. If this is not the case, or you want to show the 287 # methods anyway, you should set this option to NO. 316 # getter and setter methods for a property. Setting this option to YES will make 317 # doxygen to replace the get and set methods by a property in the documentation. 318 # This will only work if the methods are indeed getting or setting a simple 319 # type. If this is not the case, or you want to show the methods anyway, you 320 # should set this option to NO. 321 # The default value is: YES. 288 322 289 323 IDL_PROPERTY_SUPPORT = YES … … 293 327 # member in the group (if any) for the other members of the group. By default 294 328 # all members of a group must be documented explicitly. 329 # The default value is: NO. 295 330 296 331 DISTRIBUTE_GROUP_DOC = NO 297 332 298 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of 299 # the same type (for instance a group of public functions) to be put as a 300 # subgroup of that type (e.g. under the Public Functions section). Set it to 301 # NO to prevent subgrouping. Alternatively, this can be done per class using 302 # the \nosubgrouping command. 333 # Set the SUBGROUPING tag to YES to allow class member groups of the same type 334 # (for instance a group of public functions) to be put as a subgroup of that 335 # type (e.g. under the Public Functions section). Set it to NO to prevent 336 # subgrouping. Alternatively, this can be done per class using the 337 # \nosubgrouping command. 338 # The default value is: YES. 303 339 304 340 SUBGROUPING = YES 305 341 306 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and 307 # unions are shown inside the group in which they are included (e.g. using 308 # @ingroup) instead of on a separate page (for HTML and Man pages) or 309 # section (for LaTeX and RTF). 342 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions 343 # are shown inside the group in which they are included (e.g. using \ingroup) 344 # instead of on a separate page (for HTML and Man pages) or section (for LaTeX 345 # and RTF). 346 # 347 # Note that this feature does not work in combination with 348 # SEPARATE_MEMBER_PAGES. 349 # The default value is: NO. 310 350 311 351 INLINE_GROUPED_CLASSES = NO 312 352 313 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and 314 # unions with only public data fields will be shown inline in the documentation 315 # of the scope in which they are defined (i.e. file, namespace, or group 316 # documentation), provided this scope is documented. If set to NO (the default), 317 # structs, classes, and unions are shown on a separate page (for HTML and Man 318 # pages) or section (for LaTeX and RTF). 353 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions 354 # with only public data fields or simple typedef fields will be shown inline in 355 # the documentation of the scope in which they are defined (i.e. file, 356 # namespace, or group documentation), provided this scope is documented. If set 357 # to NO, structs, classes, and unions are shown on a separate page (for HTML and 358 # Man pages) or section (for LaTeX and RTF). 359 # The default value is: NO. 319 360 320 361 INLINE_SIMPLE_STRUCTS = NO 321 362 322 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum323 # is documented as struct, union, or enum with the name of the typedef. So363 # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or 364 # enum is documented as struct, union, or enum with the name of the typedef. So 324 365 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct 325 366 # with name TypeT. When disabled the typedef will appear as a member of a file, 326 # namespace, or class. And the struct will be named TypeS. This can typically 327 # beuseful for C code in case the coding convention dictates that all compound367 # namespace, or class. And the struct will be named TypeS. This can typically be 368 # useful for C code in case the coding convention dictates that all compound 328 369 # types are typedef'ed and only the typedef is referenced, never the tag name. 370 # The default value is: NO. 329 371 330 372 TYPEDEF_HIDES_STRUCT = NO 331 373 332 # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to 333 # determine which symbols to keep in memory and which to flush to disk. 334 # When the cache is full, less often used symbols will be written to disk. 335 # For small to medium size projects (<1000 input files) the default value is 336 # probably good enough. For larger projects a too small cache size can cause 337 # doxygen to be busy swapping symbols to and from disk most of the time 338 # causing a significant performance penalty. 339 # If the system has enough physical memory increasing the cache will improve the 340 # performance by keeping more symbols in memory. Note that the value works on 341 # a logarithmic scale so increasing the size by one will roughly double the 342 # memory usage. The cache size is given by this formula: 343 # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, 344 # corresponding to a cache size of 2^16 = 65536 symbols. 345 346 SYMBOL_CACHE_SIZE = 0 347 348 # Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be 349 # set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given 350 # their name and scope. Since this can be an expensive process and often the 351 # same symbol appear multiple times in the code, doxygen keeps a cache of 352 # pre-resolved symbols. If the cache is too small doxygen will become slower. 353 # If the cache is too large, memory is wasted. The cache size is given by this 354 # formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0, 355 # corresponding to a cache size of 2^16 = 65536 symbols. 374 # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This 375 # cache is used to resolve symbols given their name and scope. Since this can be 376 # an expensive process and often the same symbol appears multiple times in the 377 # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small 378 # doxygen will become slower. If the cache is too large, memory is wasted. The 379 # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range 380 # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 381 # symbols. At the end of a run doxygen will report the cache usage and suggest 382 # the optimal cache size from a speed point of view. 383 # Minimum value: 0, maximum value: 9, default value: 0. 356 384 357 385 LOOKUP_CACHE_SIZE = 0 … … 362 390 363 391 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 364 # documentation are documented, even if no documentation was available. 365 # Private class members and static file members will be hidden unless 366 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES 392 # documentation are documented, even if no documentation was available. Private 393 # class members and static file members will be hidden unless the 394 # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. 395 # Note: This will also disable the warnings about undocumented members that are 396 # normally produced when WARNINGS is set to YES. 397 # The default value is: NO. 367 398 368 399 EXTRACT_ALL = NO 369 400 370 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class 371 # will be included in the documentation. 401 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class will 402 # be included in the documentation. 403 # The default value is: NO. 372 404 373 405 EXTRACT_PRIVATE = NO … … 375 407 # If the EXTRACT_PACKAGE tag is set to YES all members with package or internal 376 408 # scope will be included in the documentation. 409 # The default value is: NO. 377 410 378 411 EXTRACT_PACKAGE = NO 379 412 380 # If the EXTRACT_STATIC tag is set to YES all static members of a file 381 # will be included in the documentation. 413 # If the EXTRACT_STATIC tag is set to YES all static members of a file will be 414 # included in the documentation. 415 # The default value is: NO. 382 416 383 417 EXTRACT_STATIC = NO 384 418 385 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 386 # defined locally in source files will be included in the documentation. 387 # If set to NO only classes defined in header files are included. 419 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined 420 # locally in source files will be included in the documentation. If set to NO 421 # only classes defined in header files are included. Does not have any effect 422 # for Java sources. 423 # The default value is: YES. 388 424 389 425 EXTRACT_LOCAL_CLASSES = YES 390 426 391 # This flag is only useful for Objective-C code. When set to YES local 392 # methods, which are defined in the implementation section but not in 393 # the interface are included in the documentation. 394 # If set to NO (the default) only methods in the interface are included. 427 # This flag is only useful for Objective-C code. When set to YES local methods, 428 # which are defined in the implementation section but not in the interface are 429 # included in the documentation. If set to NO only methods in the interface are 430 # included. 431 # The default value is: NO. 395 432 396 433 EXTRACT_LOCAL_METHODS = NO … … 398 435 # If this flag is set to YES, the members of anonymous namespaces will be 399 436 # extracted and appear in the documentation as a namespace called 400 # 'anonymous_namespace{file}', where file will be replaced with the base 401 # name of the file that contains the anonymous namespace. By default 402 # anonymous namespaces are hidden. 437 # 'anonymous_namespace{file}', where file will be replaced with the base name of 438 # the file that contains the anonymous namespace. By default anonymous namespace 439 # are hidden. 440 # The default value is: NO. 403 441 404 442 EXTRACT_ANON_NSPACES = NO 405 443 406 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all407 # undocumented members of documented classes, files or namespaces.408 # If set to NO (the default) these members will be included in the409 # various overviews, but no documentation section is generated.410 # Th is option has no effect if EXTRACT_ALL is enabled.444 # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all 445 # undocumented members inside documented classes or files. If set to NO these 446 # members will be included in the various overviews, but no documentation 447 # section is generated. This option has no effect if EXTRACT_ALL is enabled. 448 # The default value is: NO. 411 449 412 450 HIDE_UNDOC_MEMBERS = NO 413 451 414 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 415 # undocumented classes that are normally visible in the class hierarchy. 416 # If set to NO (the default) these classes will be included in the various 417 # overviews. This option has no effect if EXTRACT_ALL is enabled. 452 # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all 453 # undocumented classes that are normally visible in the class hierarchy. If set 454 # to NO these classes will be included in the various overviews. This option has 455 # no effect if EXTRACT_ALL is enabled. 456 # The default value is: NO. 418 457 419 458 HIDE_UNDOC_CLASSES = NO 420 459 421 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all422 # friend (class|struct|union) declarations.423 # If set to NO (the default) these declarations will be included in the424 # documentation.460 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend 461 # (class|struct|union) declarations. If set to NO these declarations will be 462 # included in the documentation. 463 # The default value is: NO. 425 464 426 465 HIDE_FRIEND_COMPOUNDS = NO 427 466 428 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any429 # documentation blocks found inside the body of a function. 430 # If set to NO (the default) these blocks will be appended to the431 # function's detailed documentation block.467 # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any 468 # documentation blocks found inside the body of a function. If set to NO these 469 # blocks will be appended to the function's detailed documentation block. 470 # The default value is: NO. 432 471 433 472 HIDE_IN_BODY_DOCS = NO 434 473 435 # The INTERNAL_DOCS tag determines if documentation 436 # that is typed after a \internal command is included. If the tag is set437 # to NO (the default) then the documentation will be excluded.438 # Set it to YES to include the internal documentation.474 # The INTERNAL_DOCS tag determines if documentation that is typed after a 475 # \internal command is included. If the tag is set to NO then the documentation 476 # will be excluded. Set it to YES to include the internal documentation. 477 # The default value is: NO. 439 478 440 479 INTERNAL_DOCS = NO 441 480 442 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate443 # filenames in lower-case letters. If set to YES upper-case letters are also481 # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file 482 # names in lower-case letters. If set to YES upper-case letters are also 444 483 # allowed. This is useful if you have classes or files whose names only differ 445 484 # in case and if your file system supports case sensitive file names. Windows 446 485 # and Mac users are advised to set this option to NO. 486 # The default value is: system dependent. 447 487 448 488 CASE_SENSE_NAMES = NO 449 489 450 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 451 # will show members with their full class and namespace scopes in the 452 # documentation. If set to YES the scope will be hidden. 490 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with 491 # their full class and namespace scopes in the documentation. If set to YES the 492 # scope will be hidden. 493 # The default value is: NO. 453 494 454 495 HIDE_SCOPE_NAMES = NO 455 496 456 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen457 # will put a list of the files that are included by a file in the documentation458 # of that file.497 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of 498 # the files that are included by a file in the documentation of that file. 499 # The default value is: YES. 459 500 460 501 SHOW_INCLUDE_FILES = YES 461 502 462 # If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen463 # will list include files with double quotes in the documentation464 # rather than with sharp brackets.503 # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include 504 # files with double quotes in the documentation rather than with sharp brackets. 505 # The default value is: NO. 465 506 466 507 FORCE_LOCAL_INCLUDES = NO 467 508 468 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 469 # is inserted in the documentation for inline members. 509 # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the 510 # documentation for inline members. 511 # The default value is: YES. 470 512 471 513 INLINE_INFO = YES 472 514 473 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen474 # will sort the (detailed) documentation of file and class members475 # alphabetically by member name. If set to NO the members will appear in476 # declaration order.515 # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the 516 # (detailed) documentation of file and class members alphabetically by member 517 # name. If set to NO the members will appear in declaration order. 518 # The default value is: YES. 477 519 478 520 SORT_MEMBER_DOCS = YES 479 521 480 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 481 # brief documentation of file, namespace and class members alphabetically482 # by member name. If set to NO (the default) the members will appear in483 # declaration order.522 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief 523 # descriptions of file, namespace and class members alphabetically by member 524 # name. If set to NO the members will appear in declaration order. 525 # The default value is: NO. 484 526 485 527 SORT_BRIEF_DOCS = NO 486 528 487 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen 488 # will sort the (brief and detailed) documentation of class members so that 489 # constructors and destructors are listed first. If set to NO (the default) 490 # the constructors will appear in the respective orders defined by 491 # SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. 492 # This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO 493 # and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. 529 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the 530 # (brief and detailed) documentation of class members so that constructors and 531 # destructors are listed first. If set to NO the constructors will appear in the 532 # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. 533 # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief 534 # member documentation. 535 # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting 536 # detailed member documentation. 537 # The default value is: NO. 494 538 495 539 SORT_MEMBERS_CTORS_1ST = NO 496 540 497 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the 498 # hierarchy of group names into alphabetical order. If set to NO (the default) 499 # the group names will appear in their defined order. 541 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy 542 # of group names into alphabetical order. If set to NO the group names will 543 # appear in their defined order. 544 # The default value is: NO. 500 545 501 546 SORT_GROUP_NAMES = NO 502 547 503 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 504 # sorted by fully-qualified names, including namespaces. If set to 505 # NO (the default), the class list will be sorted only by class name, 506 # not including the namespace part. 548 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by 549 # fully-qualified names, including namespaces. If set to NO, the class list will 550 # be sorted only by class name, not including the namespace part. 507 551 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 508 # Note: This option applies only to the class list, not to the 509 # alphabetical list. 552 # Note: This option applies only to the class list, not to the alphabetical 553 # list. 554 # The default value is: NO. 510 555 511 556 SORT_BY_SCOPE_NAME = NO 512 557 513 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to 514 # do proper type resolution of all parameters of a function it will reject a 515 # match between the prototype and the implementation of a member function even 516 # if there is only one candidate or it is obvious which candidate to choose 517 # by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen 518 # will still accept a match between prototype and implementation in such cases. 558 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper 559 # type resolution of all parameters of a function it will reject a match between 560 # the prototype and the implementation of a member function even if there is 561 # only one candidate or it is obvious which candidate to choose by doing a 562 # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still 563 # accept a match between prototype and implementation in such cases. 564 # The default value is: NO. 519 565 520 566 STRICT_PROTO_MATCHING = NO 521 567 522 # The GENERATE_TODOLIST tag can be used to enable (YES) or 523 # disable (NO) the todo list. This list is created by putting \todo 524 # commands in the documentation. 568 # The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the 569 # todo list. This list is created by putting \todo commands in the 570 # documentation. 571 # The default value is: YES. 525 572 526 573 GENERATE_TODOLIST = YES 527 574 528 # The GENERATE_TESTLIST tag can be used to enable (YES) or 529 # disable (NO) the test list. This list is created by putting \test 530 # commands in the documentation. 575 # The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the 576 # test list. This list is created by putting \test commands in the 577 # documentation. 578 # The default value is: YES. 531 579 532 580 GENERATE_TESTLIST = YES 533 581 534 # The GENERATE_BUGLIST tag can be used to enable ( YES) or535 # disable (NO) the bug list. This list is created by putting \bug536 # commands in the documentation.582 # The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug 583 # list. This list is created by putting \bug commands in the documentation. 584 # The default value is: YES. 537 585 538 586 GENERATE_BUGLIST = YES 539 587 540 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 541 # disable (NO) the deprecated list. This list is created by putting 542 # \deprecated commands in the documentation. 588 # The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO) 589 # the deprecated list. This list is created by putting \deprecated commands in 590 # the documentation. 591 # The default value is: YES. 543 592 544 593 GENERATE_DEPRECATEDLIST= YES 545 594 546 # The ENABLED_SECTIONS tag can be used to enable conditional 547 # documentation sections, marked by \if section-label ... \endif548 # and \cond section-label... \endcond blocks.595 # The ENABLED_SECTIONS tag can be used to enable conditional documentation 596 # sections, marked by \if <section_label> ... \endif and \cond <section_label> 597 # ... \endcond blocks. 549 598 550 599 ENABLED_SECTIONS = 551 600 552 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines 553 # the initial value of a variable or macro consists of for it to appear in 554 # the documentation. If the initializer consists of more lines than specified 555 # here it will be hidden. Use a value of 0 to hide initializers completely. 556 # The appearance of the initializer of individual variables and macros in the 557 # documentation can be controlled using \showinitializer or \hideinitializer 558 # command in the documentation regardless of this setting. 601 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the 602 # initial value of a variable or macro / define can have for it to appear in the 603 # documentation. If the initializer consists of more lines than specified here 604 # it will be hidden. Use a value of 0 to hide initializers completely. The 605 # appearance of the value of individual variables and macros / defines can be 606 # controlled using \showinitializer or \hideinitializer command in the 607 # documentation regardless of this setting. 608 # Minimum value: 0, maximum value: 10000, default value: 30. 559 609 560 610 MAX_INITIALIZER_LINES = 30 561 611 562 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated 563 # at the bottom of the documentation of classes and structs. If set to YES the 564 # list will mention the files that were used to generate the documentation. 612 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at 613 # the bottom of the documentation of classes and structs. If set to YES the list 614 # will mention the files that were used to generate the documentation. 615 # The default value is: YES. 565 616 566 617 SHOW_USED_FILES = YES 567 618 568 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. 569 # This will remove the Files entry from the Quick Index and from the 570 # Folder Tree View (if specified). The default is YES. 619 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This 620 # will remove the Files entry from the Quick Index and from the Folder Tree View 621 # (if specified). 622 # The default value is: YES. 571 623 572 624 SHOW_FILES = YES 573 625 574 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the 575 # Namespaces page.576 # This will remove the Namespaces entry from the Quick Index577 # and from the Folder Tree View (if specified). The default isYES.626 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces 627 # page. This will remove the Namespaces entry from the Quick Index and from the 628 # Folder Tree View (if specified). 629 # The default value is: YES. 578 630 579 631 SHOW_NAMESPACES = YES … … 582 634 # doxygen should invoke to get the current version for each file (typically from 583 635 # the version control system). Doxygen will invoke the program by executing (via 584 # popen()) the command <command> <input-file>, where <command> is the value of585 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file586 # provided by doxygen. Whatever the program writes to standard output587 # is used as the file version. See the manual for examples.636 # popen()) the command command input-file, where command is the value of the 637 # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided 638 # by doxygen. Whatever the program writes to standard output is used as the file 639 # version. For an example see the documentation. 588 640 589 641 FILE_VERSION_FILTER = … … 592 644 # by doxygen. The layout file controls the global structure of the generated 593 645 # output files in an output format independent way. To create the layout file 594 # that represents doxygen's defaults, run doxygen with the -l option. 595 # You can optionally specify a file name after the option, if omitted 596 # DoxygenLayout.xml will be used as the name of the layout file. 646 # that represents doxygen's defaults, run doxygen with the -l option. You can 647 # optionally specify a file name after the option, if omitted DoxygenLayout.xml 648 # will be used as the name of the layout file. 649 # 650 # Note that if you run doxygen from a directory containing a file called 651 # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE 652 # tag is left empty. 597 653 598 654 LAYOUT_FILE = 599 655 600 # The CITE_BIB_FILES tag can be used to specify one or more bib files 601 # containing the references data. This must be a list of .bib files. The602 # .bib extension is automatically appended if omitted. Using this command603 # requires the bibtex tool to be installed. See also604 # http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style605 # of the bibliography can be controlled using LATEX_BIB_STYLE. To use this606 # feature you need bibtex and perl available in the search path. Do not use607 # file names with spaces, bibtex cannot handle them.656 # The CITE_BIB_FILES tag can be used to specify one or more bib files containing 657 # the reference definitions. This must be a list of .bib files. The .bib 658 # extension is automatically appended if omitted. This requires the bibtex tool 659 # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. 660 # For LaTeX the style of the bibliography can be controlled using 661 # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the 662 # search path. Do not use file names with spaces, bibtex cannot handle them. See 663 # also \cite for info how to create references. 608 664 609 665 CITE_BIB_FILES = 610 666 611 667 #--------------------------------------------------------------------------- 612 # configuration options related to warning and progress messages 613 #--------------------------------------------------------------------------- 614 615 # The QUIET tag can be used to turn on/off the messages that are generated 616 # by doxygen. Possible values are YES and NO. If left blank NO is used. 668 # Configuration options related to warning and progress messages 669 #--------------------------------------------------------------------------- 670 671 # The QUIET tag can be used to turn on/off the messages that are generated to 672 # standard output by doxygen. If QUIET is set to YES this implies that the 673 # messages are off. 674 # The default value is: NO. 617 675 618 676 QUIET = NO 619 677 620 678 # The WARNINGS tag can be used to turn on/off the warning messages that are 621 # generated by doxygen. Possible values are YES and NO. If left blank 622 # NO is used. 679 # generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES 680 # this implies that the warnings are on. 681 # 682 # Tip: Turn warnings on while writing the documentation. 683 # The default value is: YES. 623 684 624 685 WARNINGS = YES 625 686 626 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 627 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will 628 # automatically be disabled. 687 # If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate 688 # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag 689 # will automatically be disabled. 690 # The default value is: YES. 629 691 630 692 WARN_IF_UNDOCUMENTED = YES 631 693 632 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 633 # potential errors in the documentation, such as not documenting some 634 # parameters in a documented function, or documenting parameters that 635 # don't exist or using markup commands wrongly. 694 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for 695 # potential errors in the documentation, such as not documenting some parameters 696 # in a documented function, or documenting parameters that don't exist or using 697 # markup commands wrongly. 698 # The default value is: YES. 636 699 637 700 WARN_IF_DOC_ERROR = YES 638 701 639 # Th e WARN_NO_PARAMDOC option can be enabled to get warnings for640 # functions that are documented, but have no documentation for their parameters641 # or return value. If set to NO (the default) doxygen will only warn about642 # wrong or incomplete parameter documentation, but not about the absence of643 # documentation.702 # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that 703 # are documented, but have no documentation for their parameters or return 704 # value. If set to NO doxygen will only warn about wrong or incomplete parameter 705 # documentation, but not about the absence of documentation. 706 # The default value is: NO. 644 707 645 708 WARN_NO_PARAMDOC = NO 646 709 647 # The WARN_FORMAT tag determines the format of the warning messages that 648 # doxygen can produce. The string should contain the $file, $line, and $text 649 # tags, which will be replaced by the file and line number from which the 650 # warning originated and the warning text. Optionally the format may contain 651 # $version, which will be replaced by the version of the file (if it could 652 # be obtained via FILE_VERSION_FILTER) 710 # The WARN_FORMAT tag determines the format of the warning messages that doxygen 711 # can produce. The string should contain the $file, $line, and $text tags, which 712 # will be replaced by the file and line number from which the warning originated 713 # and the warning text. Optionally the format may contain $version, which will 714 # be replaced by the version of the file (if it could be obtained via 715 # FILE_VERSION_FILTER) 716 # The default value is: $file:$line: $text. 653 717 654 718 WARN_FORMAT = "$file:$line: $text" 655 719 656 # The WARN_LOGFILE tag can be used to specify a file to which warning 657 # and error messages should be written. If left blank the output is written658 # to stderr.720 # The WARN_LOGFILE tag can be used to specify a file to which warning and error 721 # messages should be written. If left blank the output is written to standard 722 # error (stderr). 659 723 660 724 WARN_LOGFILE = 661 725 662 726 #--------------------------------------------------------------------------- 663 # configuration options related to the input files 664 #--------------------------------------------------------------------------- 665 666 # The INPUT tag can be used to specify the files and/or directories that contain 667 # documented source files. You may enter file names like "myfile.cpp" or 668 # directories like "/usr/src/myproject". Separate the files or directories 669 # with spaces. 727 # Configuration options related to the input files 728 #--------------------------------------------------------------------------- 729 730 # The INPUT tag is used to specify the files and/or directories that contain 731 # documented source files. You may enter file names like myfile.cpp or 732 # directories like /usr/src/myproject. Separate the files or directories with 733 # spaces. 734 # Note: If this tag is empty the current directory is searched. 670 735 671 736 INPUT = ../src 672 737 673 738 # This tag can be used to specify the character encoding of the source files 674 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is 675 # also the default input encoding. Doxygen uses libiconv (or the iconv built 676 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for 677 # the list of possible encodings. 739 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses 740 # libiconv (or the iconv built into libc) for the transcoding. See the libiconv 741 # documentation (see: http://www.gnu.org/software/libiconv) for the list of 742 # possible encodings. 743 # The default value is: UTF-8. 678 744 679 745 INPUT_ENCODING = UTF-8 680 746 681 747 # If the value of the INPUT tag contains directories, you can use the 682 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 683 # and *.h) to filter out the source-files in the directories. If left 684 # blank the following patterns are tested: 685 # *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh 686 # *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py 687 # *.f90 *.f *.for *.vhd *.vhdl 748 # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and 749 # *.h) to filter out the source-files in the directories. If left blank the 750 # following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii, 751 # *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, 752 # *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, 753 # *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, 754 # *.qsf, *.as and *.js. 688 755 689 756 FILE_PATTERNS = *.h 690 757 691 # The RECURSIVE tag can be used to turn specify whether or not subdirectories692 # should be searched for input files as well. Possible values are YES and NO.693 # If left blank NO is used.758 # The RECURSIVE tag can be used to specify whether or not subdirectories should 759 # be searched for input files as well. 760 # The default value is: NO. 694 761 695 762 RECURSIVE = YES … … 698 765 # excluded from the INPUT source files. This way you can easily exclude a 699 766 # subdirectory from a directory tree whose root is specified with the INPUT tag. 767 # 700 768 # Note that relative paths are relative to the directory from which doxygen is 701 769 # run. 702 770 703 771 EXCLUDE = ../src/aubio_priv.h \ 704 ../src/mathutils .h \ 772 ../src/mathutils \ 773 .h \ 705 774 ../src/io/audio_unit.h \ 706 775 ../src/io/source_sndfile.h \ … … 725 794 # directories that are symbolic links (a Unix file system feature) are excluded 726 795 # from the input. 796 # The default value is: NO. 727 797 728 798 EXCLUDE_SYMLINKS = NO … … 730 800 # If the value of the INPUT tag contains directories, you can use the 731 801 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 732 # certain files from those directories. Note that the wildcards are matched 733 # against the file with absolute path, so to exclude all test directories 734 # for example use the pattern */test/* 802 # certain files from those directories. 803 # 804 # Note that the wildcards are matched against the file with absolute path, so to 805 # exclude all test directories for example use the pattern */test/* 735 806 736 807 EXCLUDE_PATTERNS = … … 741 812 # wildcard * is used, a substring. Examples: ANamespace, AClass, 742 813 # AClass::ANamespace, ANamespace::*Test 814 # 815 # Note that the wildcards are matched against the file with absolute path, so to 816 # exclude all test directories use the pattern */test/* 743 817 744 818 EXCLUDE_SYMBOLS = 745 819 746 # The EXAMPLE_PATH tag can be used to specify one or more files or 747 # directories that contain example code fragments that are included (see 748 # the \include command). 749 750 EXAMPLE_PATH = ../examples ../tests/src 820 # The EXAMPLE_PATH tag can be used to specify one or more files or directories 821 # that contain example code fragments that are included (see the \include 822 # command). 823 824 EXAMPLE_PATH = ../examples \ 825 ../tests/src 751 826 752 827 # If the value of the EXAMPLE_PATH tag contains directories, you can use the 753 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 754 # and *.h) to filter out the source-files in the directories. If left755 # blank allfiles are included.828 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and 829 # *.h) to filter out the source-files in the directories. If left blank all 830 # files are included. 756 831 757 832 EXAMPLE_PATTERNS = 758 833 759 834 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 760 # searched for input files to be used with the \include or \dontinclude 761 # commandsirrespective of the value of the RECURSIVE tag.762 # Possible values are YES and NO. If left blank NO is used.835 # searched for input files to be used with the \include or \dontinclude commands 836 # irrespective of the value of the RECURSIVE tag. 837 # The default value is: NO. 763 838 764 839 EXAMPLE_RECURSIVE = NO 765 840 766 # The IMAGE_PATH tag can be used to specify one or more files or 767 # directories that contain image that are included in the documentation (see768 # the\image command).841 # The IMAGE_PATH tag can be used to specify one or more files or directories 842 # that contain images that are to be included in the documentation (see the 843 # \image command). 769 844 770 845 IMAGE_PATH = … … 772 847 # The INPUT_FILTER tag can be used to specify a program that doxygen should 773 848 # invoke to filter for each input file. Doxygen will invoke the filter program 774 # by executing (via popen()) the command <filter> <input-file>, where <filter> 775 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an 776 # input file. Doxygen will then use the output that the filter program writes 777 # to standard output. 778 # If FILTER_PATTERNS is specified, this tag will be 779 # ignored. 849 # by executing (via popen()) the command: 850 # 851 # <filter> <input-file> 852 # 853 # where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the 854 # name of an input file. Doxygen will then use the output that the filter 855 # program writes to standard output. If FILTER_PATTERNS is specified, this tag 856 # will be ignored. 857 # 858 # Note that the filter must not add or remove lines; it is applied before the 859 # code is scanned, but not when the output code is generated. If lines are added 860 # or removed, the anchors will not be placed correctly. 780 861 781 862 INPUT_FILTER = 782 863 783 864 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 784 # basis. 785 # Doxygen will compare the file name with each pattern and apply the 786 # filter if there is a match. 787 # The filters are a list of the form: 788 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 789 # info on how filters are used. If FILTER_PATTERNS is empty or if 790 # non of the patterns match the file name, INPUT_FILTER is applied. 865 # basis. Doxygen will compare the file name with each pattern and apply the 866 # filter if there is a match. The filters are a list of the form: pattern=filter 867 # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how 868 # filters are used. If the FILTER_PATTERNS tag is empty or if none of the 869 # patterns match the file name, INPUT_FILTER is applied. 791 870 792 871 FILTER_PATTERNS = 793 872 794 873 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 795 # INPUT_FILTER) will be used to filter the input files when producing source 796 # files to browse (i.e. when SOURCE_BROWSER is set to YES). 874 # INPUT_FILTER ) will also be used to filter the input files that are used for 875 # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). 876 # The default value is: NO. 797 877 798 878 FILTER_SOURCE_FILES = NO 799 879 800 880 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file 801 # pattern. A pattern will override the setting for FILTER_PATTERN (if any) 802 # and it is also possible to disable source filtering for a specific pattern803 # using *.ext= (so without naming a filter). This option only has effect when804 # FILTER_SOURCE_FILES is enabled.881 # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and 882 # it is also possible to disable source filtering for a specific pattern using 883 # *.ext= (so without naming a filter). 884 # This tag requires that the tag FILTER_SOURCE_FILES is set to YES. 805 885 806 886 FILTER_SOURCE_PATTERNS = 807 887 808 # If the USE_MD _FILE_AS_MAINPAGE tag refers to the name of a markdown file that809 # is part of the input, its contents will be placed on the main page (index.html).810 # This can be useful if you have a project on for instance GitHub and want reuse811 # the introduction page also for the doxygen output.888 # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that 889 # is part of the input, its contents will be placed on the main page 890 # (index.html). This can be useful if you have a project on for instance GitHub 891 # and want to reuse the introduction page also for the doxygen output. 812 892 813 893 USE_MDFILE_AS_MAINPAGE = 814 894 815 895 #--------------------------------------------------------------------------- 816 # configuration options related to source browsing 817 #--------------------------------------------------------------------------- 818 819 # If the SOURCE_BROWSER tag is set to YES then a list of source files will 820 # be generated. Documented entities will be cross-referenced with these sources. 821 # Note: To get rid of all source code in the generated output, make sure also 822 # VERBATIM_HEADERS is set to NO. 896 # Configuration options related to source browsing 897 #--------------------------------------------------------------------------- 898 899 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be 900 # generated. Documented entities will be cross-referenced with these sources. 901 # 902 # Note: To get rid of all source code in the generated output, make sure that 903 # also VERBATIM_HEADERS is set to NO. 904 # The default value is: NO. 823 905 824 906 SOURCE_BROWSER = YES 825 907 826 # Setting the INLINE_SOURCES tag to YES will include the body 827 # of functions and classes directly in the documentation. 908 # Setting the INLINE_SOURCES tag to YES will include the body of functions, 909 # classes and enums directly into the documentation. 910 # The default value is: NO. 828 911 829 912 INLINE_SOURCES = NO 830 913 831 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 832 # doxygen to hide any special comment blocks from generated source code 833 # fragments. Normal C, C++ and Fortran comments will always remain visible. 914 # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any 915 # special comment blocks from generated source code fragments. Normal C, C++ and 916 # Fortran comments will always remain visible. 917 # The default value is: YES. 834 918 835 919 STRIP_CODE_COMMENTS = NO 836 920 837 # If the REFERENCED_BY_RELATION tag is set to YES 838 # then for each documented function all documented839 # functions referencing it will be listed.921 # If the REFERENCED_BY_RELATION tag is set to YES then for each documented 922 # function all documented functions referencing it will be listed. 923 # The default value is: NO. 840 924 841 925 REFERENCED_BY_RELATION = YES 842 926 843 # If the REFERENCES_RELATION tag is set to YES 844 # then for each documented function all documented entities845 # called/used by that function will be listed.927 # If the REFERENCES_RELATION tag is set to YES then for each documented function 928 # all documented entities called/used by that function will be listed. 929 # The default value is: NO. 846 930 847 931 REFERENCES_RELATION = YES 848 932 849 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)850 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from851 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION listswill852 # link to the source code.853 # Otherwise they will link to the documentation.933 # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set 934 # to YES, then the hyperlinks from functions in REFERENCES_RELATION and 935 # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will 936 # link to the documentation. 937 # The default value is: YES. 854 938 855 939 REFERENCES_LINK_SOURCE = YES 856 940 857 # If the USE_HTAGS tag is set to YES then the references to source code 858 # will point to the HTML generated by the htags(1) tool instead of doxygen 859 # built-in source browser. The htags tool is part of GNU's global source 860 # tagging system (see http://www.gnu.org/software/global/global.html). You 861 # will need version 4.8.6 or higher. 941 # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the 942 # source code will show a tooltip with additional information such as prototype, 943 # brief description and links to the definition and documentation. Since this 944 # will make the HTML file larger and loading of large files a bit slower, you 945 # can opt to disable this feature. 946 # The default value is: YES. 947 # This tag requires that the tag SOURCE_BROWSER is set to YES. 948 949 SOURCE_TOOLTIPS = YES 950 951 # If the USE_HTAGS tag is set to YES then the references to source code will 952 # point to the HTML generated by the htags(1) tool instead of doxygen built-in 953 # source browser. The htags tool is part of GNU's global source tagging system 954 # (see http://www.gnu.org/software/global/global.html). You will need version 955 # 4.8.6 or higher. 956 # 957 # To use it do the following: 958 # - Install the latest version of global 959 # - Enable SOURCE_BROWSER and USE_HTAGS in the config file 960 # - Make sure the INPUT points to the root of the source tree 961 # - Run doxygen as normal 962 # 963 # Doxygen will invoke htags (and that will in turn invoke gtags), so these 964 # tools must be available from the command line (i.e. in the search path). 965 # 966 # The result: instead of the source browser generated by doxygen, the links to 967 # source code will now point to the output of htags. 968 # The default value is: NO. 969 # This tag requires that the tag SOURCE_BROWSER is set to YES. 862 970 863 971 USE_HTAGS = NO 864 972 865 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 866 # will generate a verbatim copy of the header file for each class for 867 # which an include is specified. Set to NO to disable this. 973 # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a 974 # verbatim copy of the header file for each class for which an include is 975 # specified. Set to NO to disable this. 976 # See also: Section \class. 977 # The default value is: YES. 868 978 869 979 VERBATIM_HEADERS = YES 870 980 871 981 #--------------------------------------------------------------------------- 872 # configuration options related to the alphabetical class index 873 #--------------------------------------------------------------------------- 874 875 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 876 # of all compounds will be generated. Enable this if the project 877 # contains a lot of classes, structs, unions or interfaces. 982 # Configuration options related to the alphabetical class index 983 #--------------------------------------------------------------------------- 984 985 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all 986 # compounds will be generated. Enable this if the project contains a lot of 987 # classes, structs, unions or interfaces. 988 # The default value is: YES. 878 989 879 990 ALPHABETICAL_INDEX = NO 880 991 881 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 882 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 883 # in which this list will be split (can be a number in the range [1..20]) 992 # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in 993 # which the alphabetical index list will be split. 994 # Minimum value: 1, maximum value: 20, default value: 5. 995 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 884 996 885 997 COLS_IN_ALPHA_INDEX = 5 886 998 887 # In case all classes in a project start with a common prefix, all 888 # classes will be put under the same header in the alphabetical index. 889 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that 890 # should be ignored while generating the index headers. 999 # In case all classes in a project start with a common prefix, all classes will 1000 # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag 1001 # can be used to specify a prefix (or a list of prefixes) that should be ignored 1002 # while generating the index headers. 1003 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 891 1004 892 1005 IGNORE_PREFIX = 893 1006 894 1007 #--------------------------------------------------------------------------- 895 # configuration options related to the HTML output896 #--------------------------------------------------------------------------- 897 898 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will899 # generate HTML output.1008 # Configuration options related to the HTML output 1009 #--------------------------------------------------------------------------- 1010 1011 # If the GENERATE_HTML tag is set to YES doxygen will generate HTML output 1012 # The default value is: YES. 900 1013 901 1014 GENERATE_HTML = YES 902 1015 903 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 904 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 905 # put in front of it. If left blank `html' will be used as the default path. 1016 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a 1017 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1018 # it. 1019 # The default directory is: html. 1020 # This tag requires that the tag GENERATE_HTML is set to YES. 906 1021 907 1022 HTML_OUTPUT = html 908 1023 909 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for 910 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank 911 # doxygen will generate files with .html extension. 1024 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each 1025 # generated HTML page (for example: .htm, .php, .asp). 1026 # The default value is: .html. 1027 # This tag requires that the tag GENERATE_HTML is set to YES. 912 1028 913 1029 HTML_FILE_EXTENSION = .html 914 1030 915 # The HTML_HEADER tag can be used to specify a personal HTML header for 916 # each generated HTML page. If it is left blank doxygen will generate a 917 # standard header. Note that when using a custom header you are responsible 918 # for the proper inclusion of any scripts and style sheets that doxygen 919 # needs, which is dependent on the configuration options used. 920 # It is advised to generate a default header using "doxygen -w html 921 # header.html footer.html stylesheet.css YourConfigFile" and then modify 922 # that header. Note that the header is subject to change so you typically 923 # have to redo this when upgrading to a newer version of doxygen or when 924 # changing the value of configuration settings such as GENERATE_TREEVIEW! 1031 # The HTML_HEADER tag can be used to specify a user-defined HTML header file for 1032 # each generated HTML page. If the tag is left blank doxygen will generate a 1033 # standard header. 1034 # 1035 # To get valid HTML the header file that includes any scripts and style sheets 1036 # that doxygen needs, which is dependent on the configuration options used (e.g. 1037 # the setting GENERATE_TREEVIEW). It is highly recommended to start with a 1038 # default header using 1039 # doxygen -w html new_header.html new_footer.html new_stylesheet.css 1040 # YourConfigFile 1041 # and then modify the file new_header.html. See also section "Doxygen usage" 1042 # for information on how to generate the default header that doxygen normally 1043 # uses. 1044 # Note: The header is subject to change so you typically have to regenerate the 1045 # default header when upgrading to a newer version of doxygen. For a description 1046 # of the possible markers and block names see the documentation. 1047 # This tag requires that the tag GENERATE_HTML is set to YES. 925 1048 926 1049 HTML_HEADER = 927 1050 928 # The HTML_FOOTER tag can be used to specify a personal HTML footer for 929 # each generated HTML page. If it is left blank doxygen will generate a 930 # standard footer. 1051 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each 1052 # generated HTML page. If the tag is left blank doxygen will generate a standard 1053 # footer. See HTML_HEADER for more information on how to generate a default 1054 # footer and what special commands can be used inside the footer. See also 1055 # section "Doxygen usage" for information on how to generate the default footer 1056 # that doxygen normally uses. 1057 # This tag requires that the tag GENERATE_HTML is set to YES. 931 1058 932 1059 HTML_FOOTER = 933 1060 934 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading 935 # style sheet that is used by each HTML page. It can be used to 936 # fine-tune the look of the HTML output. If left blank doxygen will 937 # generate a default style sheet. Note that it is recommended to use 938 # HTML_EXTRA_STYLESHEET instead of this one, as it is more robust and this 939 # tag will in the future become obsolete. 1061 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style 1062 # sheet that is used by each HTML page. It can be used to fine-tune the look of 1063 # the HTML output. If left blank doxygen will generate a default style sheet. 1064 # See also section "Doxygen usage" for information on how to generate the style 1065 # sheet that doxygen normally uses. 1066 # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as 1067 # it is more robust and this tag (HTML_STYLESHEET) will in the future become 1068 # obsolete. 1069 # This tag requires that the tag GENERATE_HTML is set to YES. 940 1070 941 1071 HTML_STYLESHEET = 942 1072 943 # The HTML_EXTRA_STYLESHEET tag can be used to specify an additional 944 # user-defined cascading style sheet that is included after the standard 945 # style sheets created by doxygen. Using this option one can overrule 946 # certain style aspects. This is preferred over using HTML_STYLESHEET 947 # since it does not replace the standard style sheet and is therefor more 948 # robust against future updates. Doxygen will copy the style sheet file to 949 # the output directory. 1073 # The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user- 1074 # defined cascading style sheet that is included after the standard style sheets 1075 # created by doxygen. Using this option one can overrule certain style aspects. 1076 # This is preferred over using HTML_STYLESHEET since it does not replace the 1077 # standard style sheet and is therefor more robust against future updates. 1078 # Doxygen will copy the style sheet file to the output directory. For an example 1079 # see the documentation. 1080 # This tag requires that the tag GENERATE_HTML is set to YES. 950 1081 951 1082 HTML_EXTRA_STYLESHEET = … … 954 1085 # other source files which should be copied to the HTML output directory. Note 955 1086 # that these files will be copied to the base HTML output directory. Use the 956 # $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these 957 # files. In the HTML_STYLESHEET file, use the file name only. Also note that 958 # the files will be copied as-is; there are no commands or markers available. 1087 # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these 1088 # files. In the HTML_STYLESHEET file, use the file name only. Also note that the 1089 # files will be copied as-is; there are no commands or markers available. 1090 # This tag requires that the tag GENERATE_HTML is set to YES. 959 1091 960 1092 HTML_EXTRA_FILES = 961 1093 962 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. 963 # Doxygen will adjust the colors in the style sheet and background images 964 # according to this color. Hue is specified as an angle on a colorwheel, 965 # see http://en.wikipedia.org/wiki/Hue for more information. 966 # For instance the value 0 represents red, 60 is yellow, 120 is green, 967 # 180 is cyan, 240 is blue, 300 purple, and 360 is red again. 968 # The allowed range is 0 to 359. 1094 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen 1095 # will adjust the colors in the stylesheet and background images according to 1096 # this color. Hue is specified as an angle on a colorwheel, see 1097 # http://en.wikipedia.org/wiki/Hue for more information. For instance the value 1098 # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 1099 # purple, and 360 is red again. 1100 # Minimum value: 0, maximum value: 359, default value: 220. 1101 # This tag requires that the tag GENERATE_HTML is set to YES. 969 1102 970 1103 HTML_COLORSTYLE_HUE = 220 971 1104 972 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of 973 # the colors in the HTML output. For a value of 0 the output will use 974 # grayscales only. A value of 255 will produce the most vivid colors. 1105 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors 1106 # in the HTML output. For a value of 0 the output will use grayscales only. A 1107 # value of 255 will produce the most vivid colors. 1108 # Minimum value: 0, maximum value: 255, default value: 100. 1109 # This tag requires that the tag GENERATE_HTML is set to YES. 975 1110 976 1111 HTML_COLORSTYLE_SAT = 100 977 1112 978 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to 979 # the luminance component of the colors in the HTML output. Values below 980 # 100 gradually make the output lighter, whereas values above 100 make 981 # the output darker. The value divided by 100 is the actual gamma applied, 982 # so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, 983 # and 100 does not change the gamma. 1113 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the 1114 # luminance component of the colors in the HTML output. Values below 100 1115 # gradually make the output lighter, whereas values above 100 make the output 1116 # darker. The value divided by 100 is the actual gamma applied, so 80 represents 1117 # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not 1118 # change the gamma. 1119 # Minimum value: 40, maximum value: 240, default value: 80. 1120 # This tag requires that the tag GENERATE_HTML is set to YES. 984 1121 985 1122 HTML_COLORSTYLE_GAMMA = 80 986 1123 987 1124 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML 988 # page will contain the date and time when the page was generated. Setting 989 # this to NO can help when comparing the output of multiple runs. 1125 # page will contain the date and time when the page was generated. Setting this 1126 # to NO can help when comparing the output of multiple runs. 1127 # The default value is: YES. 1128 # This tag requires that the tag GENERATE_HTML is set to YES. 990 1129 991 1130 HTML_TIMESTAMP = YES … … 994 1133 # documentation will contain sections that can be hidden and shown after the 995 1134 # page has loaded. 1135 # The default value is: NO. 1136 # This tag requires that the tag GENERATE_HTML is set to YES. 996 1137 997 1138 HTML_DYNAMIC_SECTIONS = NO 998 1139 999 # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of 1000 # entries shown in the various tree structured indices initially; the user 1001 # can expand and collapse entries dynamically later on. Doxygen will expand 1002 # the tree to such a level that at most the specified number of entries are 1003 # visible (unless a fully collapsed tree already exceeds this amount). 1004 # So setting the number of entries 1 will produce a full collapsed tree by 1005 # default. 0 is a special value representing an infinite number of entries 1006 # and will result in a full expanded tree by default. 1140 # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries 1141 # shown in the various tree structured indices initially; the user can expand 1142 # and collapse entries dynamically later on. Doxygen will expand the tree to 1143 # such a level that at most the specified number of entries are visible (unless 1144 # a fully collapsed tree already exceeds this amount). So setting the number of 1145 # entries 1 will produce a full collapsed tree by default. 0 is a special value 1146 # representing an infinite number of entries and will result in a full expanded 1147 # tree by default. 1148 # Minimum value: 0, maximum value: 9999, default value: 100. 1149 # This tag requires that the tag GENERATE_HTML is set to YES. 1007 1150 1008 1151 HTML_INDEX_NUM_ENTRIES = 100 1009 1152 1010 # If the GENERATE_DOCSET tag is set to YES, additional index files 1011 # will be generated that can be used as input for Apple's Xcode 3 1012 # integrated development environment, introduced with OSX 10.5 (Leopard). 1013 # To create a documentation set, doxygen will generate a Makefile in the 1014 # HTML output directory. Running make will produce the docset in that 1015 # directory and running "make install" will install the docset in 1016 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find 1017 # it at startup. 1018 # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html 1153 # If the GENERATE_DOCSET tag is set to YES, additional index files will be 1154 # generated that can be used as input for Apple's Xcode 3 integrated development 1155 # environment (see: http://developer.apple.com/tools/xcode/), introduced with 1156 # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a 1157 # Makefile in the HTML output directory. Running make will produce the docset in 1158 # that directory and running make install will install the docset in 1159 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at 1160 # startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html 1019 1161 # for more information. 1162 # The default value is: NO. 1163 # This tag requires that the tag GENERATE_HTML is set to YES. 1020 1164 1021 1165 GENERATE_DOCSET = NO 1022 1166 1023 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the 1024 # feed. A documentation feed provides an umbrella under which multiple 1025 # documentation sets from a single provider (such as a company or product suite) 1026 # can be grouped. 1167 # This tag determines the name of the docset feed. A documentation feed provides 1168 # an umbrella under which multiple documentation sets from a single provider 1169 # (such as a company or product suite) can be grouped. 1170 # The default value is: Doxygen generated docs. 1171 # This tag requires that the tag GENERATE_DOCSET is set to YES. 1027 1172 1028 1173 DOCSET_FEEDNAME = "Doxygen generated docs" 1029 1174 1030 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that 1031 # should uniquely identify the documentation set bundle. This should be a 1032 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen 1033 # will append .docset to the name. 1175 # This tag specifies a string that should uniquely identify the documentation 1176 # set bundle. This should be a reverse domain-name style string, e.g. 1177 # com.mycompany.MyDocSet. Doxygen will append .docset to the name. 1178 # The default value is: org.doxygen.Project. 1179 # This tag requires that the tag GENERATE_DOCSET is set to YES. 1034 1180 1035 1181 DOCSET_BUNDLE_ID = org.aubio.aubio 1036 1182 1037 # When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely 1038 # identify the documentation publisher. This should be a reverse domain-name 1039 # style string, e.g. com.mycompany.MyDocSet.documentation. 1183 # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify 1184 # the documentation publisher. This should be a reverse domain-name style 1185 # string, e.g. com.mycompany.MyDocSet.documentation. 1186 # The default value is: org.doxygen.Publisher. 1187 # This tag requires that the tag GENERATE_DOCSET is set to YES. 1040 1188 1041 1189 DOCSET_PUBLISHER_ID = org.aubio.aubio.Maintainer 1042 1190 1043 # The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. 1191 # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. 1192 # The default value is: Publisher. 1193 # This tag requires that the tag GENERATE_DOCSET is set to YES. 1044 1194 1045 1195 DOCSET_PUBLISHER_NAME = Publisher 1046 1196 1047 # If the GENERATE_HTMLHELP tag is set to YES, additional index files 1048 # will be generated that can be used as input for tools like the 1049 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm) 1050 # of the generated HTML documentation. 1197 # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three 1198 # additional HTML index files: index.hhp, index.hhc, and index.hhk. The 1199 # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop 1200 # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on 1201 # Windows. 1202 # 1203 # The HTML Help Workshop contains a compiler that can convert all HTML output 1204 # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML 1205 # files are now used as the Windows 98 help format, and will replace the old 1206 # Windows help format (.hlp) on all Windows platforms in the future. Compressed 1207 # HTML files also contain an index, a table of contents, and you can search for 1208 # words in the documentation. The HTML workshop also contains a viewer for 1209 # compressed HTML files. 1210 # The default value is: NO. 1211 # This tag requires that the tag GENERATE_HTML is set to YES. 1051 1212 1052 1213 GENERATE_HTMLHELP = NO 1053 1214 1054 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 1055 # be used to specify the file name of the resulting .chm file. You 1056 # can add a path in front of the file if the result should not be 1215 # The CHM_FILE tag can be used to specify the file name of the resulting .chm 1216 # file. You can add a path in front of the file if the result should not be 1057 1217 # written to the html output directory. 1218 # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1058 1219 1059 1220 CHM_FILE = 1060 1221 1061 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 1062 # be used to specify the location (absolute path including file name) of 1063 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 1064 # the HTML help compiler on the generated index.hhp. 1222 # The HHC_LOCATION tag can be used to specify the location (absolute path 1223 # including file name) of the HTML help compiler ( hhc.exe). If non-empty 1224 # doxygen will try to run the HTML help compiler on the generated index.hhp. 1225 # The file has to be specified with full path. 1226 # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1065 1227 1066 1228 HHC_LOCATION = 1067 1229 1068 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 1069 # controls if a separate .chi index file is generated (YES) or that 1070 # it should be included in the master .chm file (NO). 1230 # The GENERATE_CHI flag controls if a separate .chi index file is generated ( 1231 # YES) or that it should be included in the master .chm file ( NO). 1232 # The default value is: NO. 1233 # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1071 1234 1072 1235 GENERATE_CHI = NO 1073 1236 1074 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING1075 # is used to encode HtmlHelp index (hhk), content (hhc) and project file1076 # content.1237 # The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc) 1238 # and project file content. 1239 # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1077 1240 1078 1241 CHM_INDEX_ENCODING = 1079 1242 1080 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 1081 # controls whether a binary table of contents is generated (YES) or a 1082 # normal table of contents (NO) in the .chm file. 1243 # The BINARY_TOC flag controls whether a binary table of contents is generated ( 1244 # YES) or a normal table of contents ( NO) in the .chm file. 1245 # The default value is: NO. 1246 # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1083 1247 1084 1248 BINARY_TOC = NO 1085 1249 1086 # The TOC_EXPAND flag can be set to YES to add extra items for group members 1087 # to the contents of the HTML help documentation and to the tree view. 1250 # The TOC_EXPAND flag can be set to YES to add extra items for group members to 1251 # the table of contents of the HTML help documentation and to the tree view. 1252 # The default value is: NO. 1253 # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1088 1254 1089 1255 TOC_EXPAND = NO 1090 1256 1091 1257 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and 1092 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated 1093 # that can be used as input for Qt's qhelpgenerator to generate a 1094 # Qt Compressed Help (.qch) of the generated HTML documentation. 1258 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that 1259 # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help 1260 # (.qch) of the generated HTML documentation. 1261 # The default value is: NO. 1262 # This tag requires that the tag GENERATE_HTML is set to YES. 1095 1263 1096 1264 GENERATE_QHP = NO 1097 1265 1098 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can 1099 # be used to specify the file name of the resulting .qch file. 1100 # The path specified is relative to the HTML output folder. 1266 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify 1267 # the file name of the resulting .qch file. The path specified is relative to 1268 # the HTML output folder. 1269 # This tag requires that the tag GENERATE_QHP is set to YES. 1101 1270 1102 1271 QCH_FILE = 1103 1272 1104 # The QHP_NAMESPACE tag specifies the namespace to use when generating 1105 # Qt Help Project output. For more information please see 1106 # http://doc.trolltech.com/qthelpproject.html#namespace 1273 # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help 1274 # Project output. For more information please see Qt Help Project / Namespace 1275 # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). 1276 # The default value is: org.doxygen.Project. 1277 # This tag requires that the tag GENERATE_QHP is set to YES. 1107 1278 1108 1279 QHP_NAMESPACE = 1109 1280 1110 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating 1111 # Qt Help Project output. For more information please see 1112 # http://doc.trolltech.com/qthelpproject.html#virtual-folders 1281 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt 1282 # Help Project output. For more information please see Qt Help Project / Virtual 1283 # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- 1284 # folders). 1285 # The default value is: doc. 1286 # This tag requires that the tag GENERATE_QHP is set to YES. 1113 1287 1114 1288 QHP_VIRTUAL_FOLDER = doc 1115 1289 1116 # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to 1117 # add. For more information please see 1118 # http://doc.trolltech.com/qthelpproject.html#custom-filters 1290 # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom 1291 # filter to add. For more information please see Qt Help Project / Custom 1292 # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- 1293 # filters). 1294 # This tag requires that the tag GENERATE_QHP is set to YES. 1119 1295 1120 1296 QHP_CUST_FILTER_NAME = 1121 1297 1122 # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the 1123 # custom filter to add. For more information please see 1124 # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters"> 1125 # Qt Help Project / Custom Filters</a>. 1298 # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the 1299 # custom filter to add. For more information please see Qt Help Project / Custom 1300 # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- 1301 # filters). 1302 # This tag requires that the tag GENERATE_QHP is set to YES. 1126 1303 1127 1304 QHP_CUST_FILTER_ATTRS = 1128 1305 1129 1306 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this 1130 # project's 1131 # filter section matches. 1132 # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes"> 1133 # Qt Help Project / Filter Attributes</a>. 1307 # project's filter section matches. Qt Help Project / Filter Attributes (see: 1308 # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). 1309 # This tag requires that the tag GENERATE_QHP is set to YES. 1134 1310 1135 1311 QHP_SECT_FILTER_ATTRS = 1136 1312 1137 # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can1138 # be used to specify the location of Qt's qhelpgenerator.1139 # If non-empty doxygen will try to run qhelpgenerator on the generated1140 # .qhp file.1313 # The QHG_LOCATION tag can be used to specify the location of Qt's 1314 # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the 1315 # generated .qhp file. 1316 # This tag requires that the tag GENERATE_QHP is set to YES. 1141 1317 1142 1318 QHG_LOCATION = 1143 1319 1144 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files 1145 # will be generated, which together with the HTML files, form an Eclipse help 1146 # plugin. To install this plugin and make it available under the help contents 1147 # menu in Eclipse, the contents of the directory containing the HTML and XML 1148 # files needs to be copied into the plugins directory of eclipse. The name of 1149 # the directory within the plugins directory should be the same as 1150 # the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before 1151 # the help appears. 1320 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be 1321 # generated, together with the HTML files, they form an Eclipse help plugin. To 1322 # install this plugin and make it available under the help contents menu in 1323 # Eclipse, the contents of the directory containing the HTML and XML files needs 1324 # to be copied into the plugins directory of eclipse. The name of the directory 1325 # within the plugins directory should be the same as the ECLIPSE_DOC_ID value. 1326 # After copying Eclipse needs to be restarted before the help appears. 1327 # The default value is: NO. 1328 # This tag requires that the tag GENERATE_HTML is set to YES. 1152 1329 1153 1330 GENERATE_ECLIPSEHELP = NO 1154 1331 1155 # A unique identifier for the eclipse help plugin. When installing the plugin 1156 # the directory name containing the HTML and XML files should also have 1157 # this name. 1332 # A unique identifier for the Eclipse help plugin. When installing the plugin 1333 # the directory name containing the HTML and XML files should also have this 1334 # name. Each documentation set should have its own identifier. 1335 # The default value is: org.doxygen.Project. 1336 # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. 1158 1337 1159 1338 ECLIPSE_DOC_ID = org.aubio.aubio 1160 1339 1161 # The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) 1162 # at top of each HTML page. The value NO (the default) enables the index and 1163 # the value YES disables it. Since the tabs have the same information as the 1164 # navigation tree you can set this option to NO if you already set 1165 # GENERATE_TREEVIEW to YES. 1340 # If you want full control over the layout of the generated HTML pages it might 1341 # be necessary to disable the index and replace it with your own. The 1342 # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top 1343 # of each HTML page. A value of NO enables the index and the value YES disables 1344 # it. Since the tabs in the index contain the same information as the navigation 1345 # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. 1346 # The default value is: NO. 1347 # This tag requires that the tag GENERATE_HTML is set to YES. 1166 1348 1167 1349 DISABLE_INDEX = NO 1168 1350 1169 1351 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 1170 # structure should be generated to display hierarchical information. 1171 # If the tag value is set to YES, a side panel will be generated 1172 # containing a tree-like index structure (just like the one that 1173 # is generated for HTML Help). For this to work a browser that supports 1174 # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). 1175 # Windows users are probably better off using the HTML help feature. 1176 # Since the tree basically has the same information as the tab index you 1177 # could consider to set DISABLE_INDEX to NO when enabling this option. 1352 # structure should be generated to display hierarchical information. If the tag 1353 # value is set to YES, a side panel will be generated containing a tree-like 1354 # index structure (just like the one that is generated for HTML Help). For this 1355 # to work a browser that supports JavaScript, DHTML, CSS and frames is required 1356 # (i.e. any modern browser). Windows users are probably better off using the 1357 # HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can 1358 # further fine-tune the look of the index. As an example, the default style 1359 # sheet generated by doxygen has an example that shows how to put an image at 1360 # the root of the tree instead of the PROJECT_NAME. Since the tree basically has 1361 # the same information as the tab index, you could consider setting 1362 # DISABLE_INDEX to YES when enabling this option. 1363 # The default value is: NO. 1364 # This tag requires that the tag GENERATE_HTML is set to YES. 1178 1365 1179 1366 GENERATE_TREEVIEW = NO 1180 1367 1181 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values 1182 # (range [0,1..20]) that doxygen will group on one line in the generated HTML 1183 # documentation. Note that a value of 0 will completely suppress the enum 1184 # values from appearing in the overview section. 1368 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that 1369 # doxygen will group on one line in the generated HTML documentation. 1370 # 1371 # Note that a value of 0 will completely suppress the enum values from appearing 1372 # in the overview section. 1373 # Minimum value: 0, maximum value: 20, default value: 4. 1374 # This tag requires that the tag GENERATE_HTML is set to YES. 1185 1375 1186 1376 ENUM_VALUES_PER_LINE = 4 1187 1377 1188 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 1189 # used to set the initial width (in pixels) of the frame in which the tree 1190 # is shown. 1378 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used 1379 # to set the initial width (in pixels) of the frame in which the tree is shown. 1380 # Minimum value: 0, maximum value: 1500, default value: 250. 1381 # This tag requires that the tag GENERATE_HTML is set to YES. 1191 1382 1192 1383 TREEVIEW_WIDTH = 250 1193 1384 1194 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open 1195 # links to external symbols imported via tag files in a separate window. 1385 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to 1386 # external symbols imported via tag files in a separate window. 1387 # The default value is: NO. 1388 # This tag requires that the tag GENERATE_HTML is set to YES. 1196 1389 1197 1390 EXT_LINKS_IN_WINDOW = NO 1198 1391 1199 # Use this tag to change the font size of Latex formulas included 1200 # as images in the HTML documentation. The default is 10. Note that 1201 # when you change the font size after a successful doxygen run you need 1202 # to manually remove any form_*.png images from the HTML output directory 1203 # to force them to be regenerated. 1392 # Use this tag to change the font size of LaTeX formulas included as images in 1393 # the HTML documentation. When you change the font size after a successful 1394 # doxygen run you need to manually remove any form_*.png images from the HTML 1395 # output directory to force them to be regenerated. 1396 # Minimum value: 8, maximum value: 50, default value: 10. 1397 # This tag requires that the tag GENERATE_HTML is set to YES. 1204 1398 1205 1399 FORMULA_FONTSIZE = 10 1206 1400 1207 1401 # Use the FORMULA_TRANPARENT tag to determine whether or not the images 1208 # generated for formulas are transparent PNGs. Transparent PNGs are 1209 # not supported properly for IE 6.0, but are supported on all modern browsers. 1210 # Note that when changing this option you need to delete any form_*.png files 1211 # in the HTML output before the changes have effect. 1402 # generated for formulas are transparent PNGs. Transparent PNGs are not 1403 # supported properly for IE 6.0, but are supported on all modern browsers. 1404 # 1405 # Note that when changing this option you need to delete any form_*.png files in 1406 # the HTML output directory before the changes have effect. 1407 # The default value is: YES. 1408 # This tag requires that the tag GENERATE_HTML is set to YES. 1212 1409 1213 1410 FORMULA_TRANSPARENT = YES 1214 1411 1215 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax 1216 # (see http://www.mathjax.org) which uses client side Javascript for the 1217 # rendering instead of using prerendered bitmaps. Use this if you do not 1218 # have LaTeX installed or if you want to formulas look prettier in the HTML 1219 # output. When enabled you may also need to install MathJax separately and 1220 # configure the path to it using the MATHJAX_RELPATH option. 1412 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see 1413 # http://www.mathjax.org) which uses client side Javascript for the rendering 1414 # instead of using prerendered bitmaps. Use this if you do not have LaTeX 1415 # installed or if you want to formulas look prettier in the HTML output. When 1416 # enabled you may also need to install MathJax separately and configure the path 1417 # to it using the MATHJAX_RELPATH option. 1418 # The default value is: NO. 1419 # This tag requires that the tag GENERATE_HTML is set to YES. 1221 1420 1222 1421 USE_MATHJAX = YES 1223 1422 1224 1423 # When MathJax is enabled you can set the default output format to be used for 1225 # thA MathJax output. Supported types are HTML-CSS, NativeMML (i.e. MathML) and 1226 # SVG. The default value is HTML-CSS, which is slower, but has the best 1227 # compatibility. 1424 # the MathJax output. See the MathJax site (see: 1425 # http://docs.mathjax.org/en/latest/output.html) for more details. 1426 # Possible values are: HTML-CSS (which is slower, but has the best 1427 # compatibility), NativeMML (i.e. MathML) and SVG. 1428 # The default value is: HTML-CSS. 1429 # This tag requires that the tag USE_MATHJAX is set to YES. 1228 1430 1229 1431 MATHJAX_FORMAT = HTML-CSS 1230 1432 1231 # When MathJax is enabled you need to specify the location relative to the 1232 # HTML output directory using the MATHJAX_RELPATH option. The destination 1233 # directory should contain the MathJax.js script. For instance, if the mathjax 1234 # directory is located at the same level as the HTML output directory, then 1235 # MATHJAX_RELPATH should be ../mathjax. The default value points to 1236 # the MathJax Content Delivery Network so you can quickly see the result without 1237 # installing MathJax. 1238 # However, it is strongly recommended to install a local 1239 # copy of MathJax from http://www.mathjax.org before deployment. 1433 # When MathJax is enabled you need to specify the location relative to the HTML 1434 # output directory using the MATHJAX_RELPATH option. The destination directory 1435 # should contain the MathJax.js script. For instance, if the mathjax directory 1436 # is located at the same level as the HTML output directory, then 1437 # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax 1438 # Content Delivery Network so you can quickly see the result without installing 1439 # MathJax. However, it is strongly recommended to install a local copy of 1440 # MathJax from http://www.mathjax.org before deployment. 1441 # The default value is: http://cdn.mathjax.org/mathjax/latest. 1442 # This tag requires that the tag USE_MATHJAX is set to YES. 1240 1443 1241 1444 MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest 1242 1445 1243 # The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension 1244 # names that should be enabled during MathJax rendering. 1446 # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax 1447 # extension names that should be enabled during MathJax rendering. For example 1448 # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols 1449 # This tag requires that the tag USE_MATHJAX is set to YES. 1245 1450 1246 1451 MATHJAX_EXTENSIONS = 1247 1452 1248 # When the SEARCHENGINE tag is enabled doxygen will generate a search box 1249 # for the HTML output. The underlying search engine uses javascript 1250 # and DHTML and should work on any modern browser. Note that when using 1251 # HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets 1252 # (GENERATE_DOCSET) there is already a search function so this one should 1253 # typically be disabled. For large projects the javascript based search engine 1254 # can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. 1453 # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces 1454 # of code that will be used on startup of the MathJax code. See the MathJax site 1455 # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an 1456 # example see the documentation. 1457 # This tag requires that the tag USE_MATHJAX is set to YES. 1458 1459 MATHJAX_CODEFILE = 1460 1461 # When the SEARCHENGINE tag is enabled doxygen will generate a search box for 1462 # the HTML output. The underlying search engine uses javascript and DHTML and 1463 # should work on any modern browser. Note that when using HTML help 1464 # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) 1465 # there is already a search function so this one should typically be disabled. 1466 # For large projects the javascript based search engine can be slow, then 1467 # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to 1468 # search using the keyboard; to jump to the search box use <access key> + S 1469 # (what the <access key> is depends on the OS and browser, but it is typically 1470 # <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down 1471 # key> to jump into the search results window, the results can be navigated 1472 # using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel 1473 # the search. The filter options can be selected when the cursor is inside the 1474 # search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys> 1475 # to select a filter and <Enter> or <escape> to activate or cancel the filter 1476 # option. 1477 # The default value is: YES. 1478 # This tag requires that the tag GENERATE_HTML is set to YES. 1255 1479 1256 1480 SEARCHENGINE = YES 1257 1481 1258 1482 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be 1259 # implemented using a web server instead of a web client using Javascript. 1260 # There are two flavours of web server based searchdepending on the1483 # implemented using a web server instead of a web client using Javascript. There 1484 # are two flavours of web server based searching depending on the 1261 1485 # EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for 1262 1486 # searching and an index file used by the script. When EXTERNAL_SEARCH is 1263 # enabled the indexing and searching needs to be provided by external tools. 1264 # See the manual for details. 1487 # enabled the indexing and searching needs to be provided by external tools. See 1488 # the section "External Indexing and Searching" for details. 1489 # The default value is: NO. 1490 # This tag requires that the tag SEARCHENGINE is set to YES. 1265 1491 1266 1492 SERVER_BASED_SEARCH = NO 1267 1493 1268 # When EXTERNAL_SEARCH is enabled doxygen will no longer generate the PHP1494 # When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP 1269 1495 # script for searching. Instead the search results are written to an XML file 1270 1496 # which needs to be processed by an external indexer. Doxygen will invoke an 1271 # external search engine pointed to by the SEARCHENGINE_URL option to obtain 1272 # the search results. Doxygen ships with an example indexer (doxyindexer) and 1273 # search engine (doxysearch.cgi) which are based on the open source search engine 1274 # library Xapian. See the manual for configuration details. 1497 # external search engine pointed to by the SEARCHENGINE_URL option to obtain the 1498 # search results. 1499 # 1500 # Doxygen ships with an example indexer ( doxyindexer) and search engine 1501 # (doxysearch.cgi) which are based on the open source search engine library 1502 # Xapian (see: http://xapian.org/). 1503 # 1504 # See the section "External Indexing and Searching" for details. 1505 # The default value is: NO. 1506 # This tag requires that the tag SEARCHENGINE is set to YES. 1275 1507 1276 1508 EXTERNAL_SEARCH = NO 1277 1509 1278 1510 # The SEARCHENGINE_URL should point to a search engine hosted by a web server 1279 # which will returned the search results when EXTERNAL_SEARCH is enabled. 1280 # Doxygen ships with an example search engine (doxysearch) which is based on 1281 # the open source search engine library Xapian. See the manual for configuration 1282 # details. 1511 # which will return the search results when EXTERNAL_SEARCH is enabled. 1512 # 1513 # Doxygen ships with an example indexer ( doxyindexer) and search engine 1514 # (doxysearch.cgi) which are based on the open source search engine library 1515 # Xapian (see: http://xapian.org/). See the section "External Indexing and 1516 # Searching" for details. 1517 # This tag requires that the tag SEARCHENGINE is set to YES. 1283 1518 1284 1519 SEARCHENGINE_URL = … … 1287 1522 # search data is written to a file for indexing by an external tool. With the 1288 1523 # SEARCHDATA_FILE tag the name of this file can be specified. 1524 # The default file is: searchdata.xml. 1525 # This tag requires that the tag SEARCHENGINE is set to YES. 1289 1526 1290 1527 SEARCHDATA_FILE = searchdata.xml 1291 1528 1292 # When SERVER_BASED_SEARCH ANDEXTERNAL_SEARCH are both enabled the1529 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the 1293 1530 # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is 1294 1531 # useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple 1295 1532 # projects and redirect the results back to the right project. 1533 # This tag requires that the tag SEARCHENGINE is set to YES. 1296 1534 1297 1535 EXTERNAL_SEARCH_ID = … … 1300 1538 # projects other than the one defined by this configuration file, but that are 1301 1539 # all added to the same external search index. Each project needs to have a 1302 # unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id 1303 # of to a relative location where the documentation can be found. 1304 # The format is: EXTRA_SEARCH_MAPPINGS = id1=loc1 id2=loc2 ... 1540 # unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of 1541 # to a relative location where the documentation can be found. The format is: 1542 # EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ... 1543 # This tag requires that the tag SEARCHENGINE is set to YES. 1305 1544 1306 1545 EXTRA_SEARCH_MAPPINGS = 1307 1546 1308 1547 #--------------------------------------------------------------------------- 1309 # configuration options related to the LaTeX output1310 #--------------------------------------------------------------------------- 1311 1312 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will1313 # generate Latex output.1548 # Configuration options related to the LaTeX output 1549 #--------------------------------------------------------------------------- 1550 1551 # If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output. 1552 # The default value is: YES. 1314 1553 1315 1554 GENERATE_LATEX = NO 1316 1555 1317 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 1318 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 1319 # put in front of it. If left blank `latex' will be used as the default path. 1556 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a 1557 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1558 # it. 1559 # The default directory is: latex. 1560 # This tag requires that the tag GENERATE_LATEX is set to YES. 1320 1561 1321 1562 LATEX_OUTPUT = latex 1322 1563 1323 1564 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 1324 # invoked. If left blank `latex' will be used as the default command name. 1325 # Note that when enabling USE_PDFLATEX this option is only used for 1326 # generating bitmaps for formulas in the HTML output, but not in the 1327 # Makefile that is written to the output directory. 1565 # invoked. 1566 # 1567 # Note that when enabling USE_PDFLATEX this option is only used for generating 1568 # bitmaps for formulas in the HTML output, but not in the Makefile that is 1569 # written to the output directory. 1570 # The default file is: latex. 1571 # This tag requires that the tag GENERATE_LATEX is set to YES. 1328 1572 1329 1573 LATEX_CMD_NAME = latex 1330 1574 1331 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 1332 # generate index for LaTeX. If left blank `makeindex' will be used as the 1333 # default command name. 1575 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate 1576 # index for LaTeX. 1577 # The default file is: makeindex. 1578 # This tag requires that the tag GENERATE_LATEX is set to YES. 1334 1579 1335 1580 MAKEINDEX_CMD_NAME = makeindex 1336 1581 1337 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 1338 # LaTeX documents. This may be useful for small projects and may help to 1339 # save some trees in general. 1582 # If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX 1583 # documents. This may be useful for small projects and may help to save some 1584 # trees in general. 1585 # The default value is: NO. 1586 # This tag requires that the tag GENERATE_LATEX is set to YES. 1340 1587 1341 1588 COMPACT_LATEX = NO 1342 1589 1343 # The PAPER_TYPE tag can be used to set the paper type that is used 1344 # by the printer. Possible values are: a4, letter, legal and 1345 # executive. If left blank a4wide will be used. 1590 # The PAPER_TYPE tag can be used to set the paper type that is used by the 1591 # printer. 1592 # Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x 1593 # 14 inches) and executive (7.25 x 10.5 inches). 1594 # The default value is: a4. 1595 # This tag requires that the tag GENERATE_LATEX is set to YES. 1346 1596 1347 1597 PAPER_TYPE = a4 1348 1598 1349 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 1350 # packages that should be included in the LaTeX output. 1599 # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names 1600 # that should be included in the LaTeX output. To get the times font for 1601 # instance you can specify 1602 # EXTRA_PACKAGES=times 1603 # If left blank no extra packages will be included. 1604 # This tag requires that the tag GENERATE_LATEX is set to YES. 1351 1605 1352 1606 EXTRA_PACKAGES = 1353 1607 1354 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for 1355 # the generated latex document. The header should contain everything until 1356 # the first chapter. If it is left blank doxygen will generate a 1357 # standard header. Notice: only use this tag if you know what you are doing! 1608 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the 1609 # generated LaTeX document. The header should contain everything until the first 1610 # chapter. If it is left blank doxygen will generate a standard header. See 1611 # section "Doxygen usage" for information on how to let doxygen write the 1612 # default header to a separate file. 1613 # 1614 # Note: Only use a user-defined header if you know what you are doing! The 1615 # following commands have a special meaning inside the header: $title, 1616 # $datetime, $date, $doxygenversion, $projectname, $projectnumber. Doxygen will 1617 # replace them by respectively the title of the page, the current date and time, 1618 # only the current date, the version number of doxygen, the project name (see 1619 # PROJECT_NAME), or the project number (see PROJECT_NUMBER). 1620 # This tag requires that the tag GENERATE_LATEX is set to YES. 1358 1621 1359 1622 LATEX_HEADER = 1360 1623 1361 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for 1362 # the generated latex document. The footer should contain everything after 1363 # the last chapter. If it is left blank doxygen will generate a 1364 # standard footer. Notice: only use this tag if you know what you are doing! 1624 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the 1625 # generated LaTeX document. The footer should contain everything after the last 1626 # chapter. If it is left blank doxygen will generate a standard footer. 1627 # 1628 # Note: Only use a user-defined footer if you know what you are doing! 1629 # This tag requires that the tag GENERATE_LATEX is set to YES. 1365 1630 1366 1631 LATEX_FOOTER = 1367 1632 1368 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 1369 # is prepared for conversion to pdf (using ps2pdf). The pdf file will 1370 # contain links (just like the HTML output) instead of page references 1371 # This makes the output suitable for online browsing using a pdf viewer. 1633 # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or 1634 # other source files which should be copied to the LATEX_OUTPUT output 1635 # directory. Note that the files will be copied as-is; there are no commands or 1636 # markers available. 1637 # This tag requires that the tag GENERATE_LATEX is set to YES. 1638 1639 LATEX_EXTRA_FILES = 1640 1641 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is 1642 # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will 1643 # contain links (just like the HTML output) instead of page references. This 1644 # makes the output suitable for online browsing using a PDF viewer. 1645 # The default value is: YES. 1646 # This tag requires that the tag GENERATE_LATEX is set to YES. 1372 1647 1373 1648 PDF_HYPERLINKS = YES 1374 1649 1375 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of1376 # plain latex in the generated Makefile. Set this option to YES to get a1650 # If the LATEX_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate 1651 # the PDF file directly from the LaTeX files. Set this option to YES to get a 1377 1652 # higher quality PDF documentation. 1653 # The default value is: YES. 1654 # This tag requires that the tag GENERATE_LATEX is set to YES. 1378 1655 1379 1656 USE_PDFLATEX = YES 1380 1657 1381 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 1382 # command to the generated LaTeX files. This will instruct LaTeX to keep 1383 # running if errors occur, instead of asking the user for help. 1384 # This option is also used when generating formulas in HTML. 1658 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode 1659 # command to the generated LaTeX files. This will instruct LaTeX to keep running 1660 # if errors occur, instead of asking the user for help. This option is also used 1661 # when generating formulas in HTML. 1662 # The default value is: NO. 1663 # This tag requires that the tag GENERATE_LATEX is set to YES. 1385 1664 1386 1665 LATEX_BATCHMODE = NO 1387 1666 1388 # If LATEX_HIDE_INDICES is set to YES then doxygen will not 1389 # include the index chapters (such as File Index, Compound Index, etc.) 1390 # in the output. 1667 # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the 1668 # index chapters (such as File Index, Compound Index, etc.) in the output. 1669 # The default value is: NO. 1670 # This tag requires that the tag GENERATE_LATEX is set to YES. 1391 1671 1392 1672 LATEX_HIDE_INDICES = NO 1393 1673 1394 # If LATEX_SOURCE_CODE is set to YES then doxygen will include 1395 # source code with syntax highlighting in the LaTeX output. 1396 # Note that which sources are shown also depends on other settings 1397 # such as SOURCE_BROWSER. 1674 # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source 1675 # code with syntax highlighting in the LaTeX output. 1676 # 1677 # Note that which sources are shown also depends on other settings such as 1678 # SOURCE_BROWSER. 1679 # The default value is: NO. 1680 # This tag requires that the tag GENERATE_LATEX is set to YES. 1398 1681 1399 1682 LATEX_SOURCE_CODE = NO 1400 1683 1401 1684 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the 1402 # bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See 1403 # http://en.wikipedia.org/wiki/BibTeX for more info. 1685 # bibliography, e.g. plainnat, or ieeetr. See 1686 # http://en.wikipedia.org/wiki/BibTeX and \cite for more info. 1687 # The default value is: plain. 1688 # This tag requires that the tag GENERATE_LATEX is set to YES. 1404 1689 1405 1690 LATEX_BIB_STYLE = plain 1406 1691 1407 1692 #--------------------------------------------------------------------------- 1408 # configuration options related to the RTF output 1409 #--------------------------------------------------------------------------- 1410 1411 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 1412 # The RTF output is optimized for Word 97 and may not look very pretty with 1413 # other RTF readers or editors. 1693 # Configuration options related to the RTF output 1694 #--------------------------------------------------------------------------- 1695 1696 # If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The 1697 # RTF output is optimized for Word 97 and may not look too pretty with other RTF 1698 # readers/editors. 1699 # The default value is: NO. 1414 1700 1415 1701 GENERATE_RTF = NO 1416 1702 1417 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 1418 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 1419 # put in front of it. If left blank `rtf' will be used as the default path. 1703 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a 1704 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1705 # it. 1706 # The default directory is: rtf. 1707 # This tag requires that the tag GENERATE_RTF is set to YES. 1420 1708 1421 1709 RTF_OUTPUT = rtf 1422 1710 1423 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact 1424 # RTF documents. This may be useful for small projects and may help to 1425 # save some trees in general. 1711 # If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF 1712 # documents. This may be useful for small projects and may help to save some 1713 # trees in general. 1714 # The default value is: NO. 1715 # This tag requires that the tag GENERATE_RTF is set to YES. 1426 1716 1427 1717 COMPACT_RTF = NO 1428 1718 1429 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 1430 # will contain hyperlink fields. The RTF file will 1431 # contain links (just like the HTML output) instead of page references. 1432 # This makes the output suitable for online browsing using WORD or other 1433 # programs which support those fields. 1434 # Note: wordpad (write) and others do not support links. 1719 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will 1720 # contain hyperlink fields. The RTF file will contain links (just like the HTML 1721 # output) instead of page references. This makes the output suitable for online 1722 # browsing using Word or some other Word compatible readers that support those 1723 # fields. 1724 # 1725 # Note: WordPad (write) and others do not support links. 1726 # The default value is: NO. 1727 # This tag requires that the tag GENERATE_RTF is set to YES. 1435 1728 1436 1729 RTF_HYPERLINKS = NO 1437 1730 1438 # Load style sheet definitions from file. Syntax is similar to doxygen's 1439 # config file, i.e. a series of assignments. You only have to provide 1440 # replacements, missing definitions are set to their default value. 1731 # Load stylesheet definitions from file. Syntax is similar to doxygen's config 1732 # file, i.e. a series of assignments. You only have to provide replacements, 1733 # missing definitions are set to their default value. 1734 # 1735 # See also section "Doxygen usage" for information on how to generate the 1736 # default style sheet that doxygen normally uses. 1737 # This tag requires that the tag GENERATE_RTF is set to YES. 1441 1738 1442 1739 RTF_STYLESHEET_FILE = 1443 1740 1444 # Set optional variables used in the generation of an rtf document. 1445 # Syntax is similar to doxygen's config file. 1741 # Set optional variables used in the generation of an RTF document. Syntax is 1742 # similar to doxygen's config file. A template extensions file can be generated 1743 # using doxygen -e rtf extensionFile. 1744 # This tag requires that the tag GENERATE_RTF is set to YES. 1446 1745 1447 1746 RTF_EXTENSIONS_FILE = 1448 1747 1449 1748 #--------------------------------------------------------------------------- 1450 # configuration options related to the man page output 1451 #--------------------------------------------------------------------------- 1452 1453 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will 1454 # generate man pages 1749 # Configuration options related to the man page output 1750 #--------------------------------------------------------------------------- 1751 1752 # If the GENERATE_MAN tag is set to YES doxygen will generate man pages for 1753 # classes and files. 1754 # The default value is: NO. 1455 1755 1456 1756 GENERATE_MAN = NO 1457 1757 1458 # The MAN_OUTPUT tag is used to specify where the man pages will be put. 1459 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 1460 # put in front of it. If left blank `man' will be used as the default path. 1758 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a 1759 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1760 # it. A directory man3 will be created inside the directory specified by 1761 # MAN_OUTPUT. 1762 # The default directory is: man. 1763 # This tag requires that the tag GENERATE_MAN is set to YES. 1461 1764 1462 1765 MAN_OUTPUT = man 1463 1766 1464 # The MAN_EXTENSION tag determines the extension that is added to 1465 # the generated man pages (default is the subroutine's section .3) 1767 # The MAN_EXTENSION tag determines the extension that is added to the generated 1768 # man pages. In case the manual section does not start with a number, the number 1769 # 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is 1770 # optional. 1771 # The default value is: .3. 1772 # This tag requires that the tag GENERATE_MAN is set to YES. 1466 1773 1467 1774 MAN_EXTENSION = .3 1468 1775 1469 # If the MAN_LINKS tag is set to YES and Doxygen generates man output, 1470 # then it will generate one additional man file for each entity 1471 # documented in the real man page(s). These additional files 1472 # only source the real man page, but without them the man command 1473 # would be unable to find the correct page. The default is NO. 1776 # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it 1777 # will generate one additional man file for each entity documented in the real 1778 # man page(s). These additional files only source the real man page, but without 1779 # them the man command would be unable to find the correct page. 1780 # The default value is: NO. 1781 # This tag requires that the tag GENERATE_MAN is set to YES. 1474 1782 1475 1783 MAN_LINKS = NO 1476 1784 1477 1785 #--------------------------------------------------------------------------- 1478 # configuration options related to the XML output1479 #--------------------------------------------------------------------------- 1480 1481 # If the GENERATE_XML tag is set to YES Doxygen will1482 # generate an XML file that captures the structure of1483 # the code including all documentation.1786 # Configuration options related to the XML output 1787 #--------------------------------------------------------------------------- 1788 1789 # If the GENERATE_XML tag is set to YES doxygen will generate an XML file that 1790 # captures the structure of the code including all documentation. 1791 # The default value is: NO. 1484 1792 1485 1793 GENERATE_XML = NO 1486 1794 1487 # The XML_OUTPUT tag is used to specify where the XML pages will be put. 1488 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 1489 # put in front of it. If left blank `xml' will be used as the default path. 1795 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a 1796 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1797 # it. 1798 # The default directory is: xml. 1799 # This tag requires that the tag GENERATE_XML is set to YES. 1490 1800 1491 1801 XML_OUTPUT = xml 1492 1802 1493 # The XML_SCHEMA tag can be used to specify a n XML schema,1494 # which can be used by a validating XML parser to check the1495 # syntax of the XML files.1803 # The XML_SCHEMA tag can be used to specify a XML schema, which can be used by a 1804 # validating XML parser to check the syntax of the XML files. 1805 # This tag requires that the tag GENERATE_XML is set to YES. 1496 1806 1497 1807 XML_SCHEMA = 1498 1808 1499 # The XML_DTD tag can be used to specify a n XML DTD,1500 # which can be used by a validating XML parser to check the1501 # syntax of the XML files.1809 # The XML_DTD tag can be used to specify a XML DTD, which can be used by a 1810 # validating XML parser to check the syntax of the XML files. 1811 # This tag requires that the tag GENERATE_XML is set to YES. 1502 1812 1503 1813 XML_DTD = 1504 1814 1505 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will 1506 # dump the program listings (including syntax highlighting 1507 # and cross-referencing information) to the XML output. Note that 1508 # enabling this will significantly increase the size of the XML output. 1815 # If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program 1816 # listings (including syntax highlighting and cross-referencing information) to 1817 # the XML output. Note that enabling this will significantly increase the size 1818 # of the XML output. 1819 # The default value is: YES. 1820 # This tag requires that the tag GENERATE_XML is set to YES. 1509 1821 1510 1822 XML_PROGRAMLISTING = YES 1511 1823 1512 1824 #--------------------------------------------------------------------------- 1513 # configuration options for the AutoGen Definitions output 1514 #--------------------------------------------------------------------------- 1515 1516 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 1517 # generate an AutoGen Definitions (see autogen.sf.net) file 1518 # that captures the structure of the code including all 1519 # documentation. Note that this feature is still experimental 1520 # and incomplete at the moment. 1825 # Configuration options related to the DOCBOOK output 1826 #--------------------------------------------------------------------------- 1827 1828 # If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files 1829 # that can be used to generate PDF. 1830 # The default value is: NO. 1831 1832 GENERATE_DOCBOOK = NO 1833 1834 # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put. 1835 # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in 1836 # front of it. 1837 # The default directory is: docbook. 1838 # This tag requires that the tag GENERATE_DOCBOOK is set to YES. 1839 1840 DOCBOOK_OUTPUT = docbook 1841 1842 #--------------------------------------------------------------------------- 1843 # Configuration options for the AutoGen Definitions output 1844 #--------------------------------------------------------------------------- 1845 1846 # If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen 1847 # Definitions (see http://autogen.sf.net) file that captures the structure of 1848 # the code including all documentation. Note that this feature is still 1849 # experimental and incomplete at the moment. 1850 # The default value is: NO. 1521 1851 1522 1852 GENERATE_AUTOGEN_DEF = NO 1523 1853 1524 1854 #--------------------------------------------------------------------------- 1525 # configuration options related to the Perl module output1526 #--------------------------------------------------------------------------- 1527 1528 # If the GENERATE_PERLMOD tag is set to YES Doxygen will1529 # generate a Perl module file that captures the structure of1530 # the code including all documentation. Note that this1531 # feature is still experimental and incomplete at the1532 # moment.1855 # Configuration options related to the Perl module output 1856 #--------------------------------------------------------------------------- 1857 1858 # If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module 1859 # file that captures the structure of the code including all documentation. 1860 # 1861 # Note that this feature is still experimental and incomplete at the moment. 1862 # The default value is: NO. 1533 1863 1534 1864 GENERATE_PERLMOD = NO 1535 1865 1536 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate 1537 # the necessary Makefile rules, Perl scripts and LaTeX code to be able 1538 # to generate PDF and DVI output from the Perl module output. 1866 # If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary 1867 # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI 1868 # output from the Perl module output. 1869 # The default value is: NO. 1870 # This tag requires that the tag GENERATE_PERLMOD is set to YES. 1539 1871 1540 1872 PERLMOD_LATEX = NO 1541 1873 1542 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 1543 # nicely formatted so it can be parsed by a human reader.1544 # This is useful1545 # if you want to understand what is going on.1546 # On the other hand, if this1547 # tag is set to NO the size of the Perl module output will be much smaller1548 # and Perl will parse it just the same.1874 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely 1875 # formatted so it can be parsed by a human reader. This is useful if you want to 1876 # understand what is going on. On the other hand, if this tag is set to NO the 1877 # size of the Perl module output will be much smaller and Perl will parse it 1878 # just the same. 1879 # The default value is: YES. 1880 # This tag requires that the tag GENERATE_PERLMOD is set to YES. 1549 1881 1550 1882 PERLMOD_PRETTY = YES 1551 1883 1552 # The names of the make variables in the generated doxyrules.make file 1553 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 1554 # This is useful so different doxyrules.make files included by the same 1555 # Makefile don't overwrite each other's variables. 1884 # The names of the make variables in the generated doxyrules.make file are 1885 # prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful 1886 # so different doxyrules.make files included by the same Makefile don't 1887 # overwrite each other's variables. 1888 # This tag requires that the tag GENERATE_PERLMOD is set to YES. 1556 1889 1557 1890 PERLMOD_MAKEVAR_PREFIX = … … 1561 1894 #--------------------------------------------------------------------------- 1562 1895 1563 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will1564 # evaluate all C-preprocessor directives found in the sources and include1565 # files.1896 # If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all 1897 # C-preprocessor directives found in the sources and include files. 1898 # The default value is: YES. 1566 1899 1567 1900 ENABLE_PREPROCESSING = YES 1568 1901 1569 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 1570 # names in the source code. If set to NO (the default) only conditional 1571 # compilation will be performed. Macro expansion can be done in a controlled 1572 # way by setting EXPAND_ONLY_PREDEF to YES. 1902 # If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names 1903 # in the source code. If set to NO only conditional compilation will be 1904 # performed. Macro expansion can be done in a controlled way by setting 1905 # EXPAND_ONLY_PREDEF to YES. 1906 # The default value is: NO. 1907 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 1573 1908 1574 1909 MACRO_EXPANSION = NO 1575 1910 1576 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 1577 # then the macro expansion is limited to the macros specified with the 1578 # PREDEFINED and EXPAND_AS_DEFINED tags. 1911 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then 1912 # the macro expansion is limited to the macros specified with the PREDEFINED and 1913 # EXPAND_AS_DEFINED tags. 1914 # The default value is: NO. 1915 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 1579 1916 1580 1917 EXPAND_ONLY_PREDEF = NO 1581 1918 1582 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 1583 # pointed to by INCLUDE_PATH will be searched when a #include is found. 1919 # If the SEARCH_INCLUDES tag is set to YES the includes files in the 1920 # INCLUDE_PATH will be searched if a #include is found. 1921 # The default value is: YES. 1922 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 1584 1923 1585 1924 SEARCH_INCLUDES = YES 1586 1925 1587 1926 # The INCLUDE_PATH tag can be used to specify one or more directories that 1588 # contain include files that are not input files but should be processed by 1589 # the preprocessor. 1927 # contain include files that are not input files but should be processed by the 1928 # preprocessor. 1929 # This tag requires that the tag SEARCH_INCLUDES is set to YES. 1590 1930 1591 1931 INCLUDE_PATH = … … 1593 1933 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 1594 1934 # patterns (like *.h and *.hpp) to filter out the header-files in the 1595 # directories. If left blank, the patterns specified with FILE_PATTERNS will 1596 # be used. 1935 # directories. If left blank, the patterns specified with FILE_PATTERNS will be 1936 # used. 1937 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 1597 1938 1598 1939 INCLUDE_FILE_PATTERNS = *.h 1599 1940 1600 # The PREDEFINED tag can be used to specify one or more macro names that 1601 # are defined before the preprocessor is started (similar to the -D option of1602 # gcc). The argument of the tag is a list of macros of the form: name 1603 # or name=definition (no spaces). If the definition and the = are1604 # omitted =1 is assumed. To prevent a macro definition from being1605 # undefined via #undef or recursively expanded use the := operator1606 # instead of the = operator.1941 # The PREDEFINED tag can be used to specify one or more macro names that are 1942 # defined before the preprocessor is started (similar to the -D option of e.g. 1943 # gcc). The argument of the tag is a list of macros of the form: name or 1944 # name=definition (no spaces). If the definition and the "=" are omitted, "=1" 1945 # is assumed. To prevent a macro definition from being undefined via #undef or 1946 # recursively expanded use the := operator instead of the = operator. 1947 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 1607 1948 1608 1949 PREDEFINED = 1609 1950 1610 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 1611 # this tag can be used to specify a list of macro names that should be expanded. 1612 # The macro definition that is found in the sources will be used. 1613 # Use the PREDEFINED tag if you want to use a different macro definition that 1614 # overrules the definition found in the source code. 1951 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this 1952 # tag can be used to specify a list of macro names that should be expanded. The 1953 # macro definition that is found in the sources will be used. Use the PREDEFINED 1954 # tag if you want to use a different macro definition that overrules the 1955 # definition found in the source code. 1956 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 1615 1957 1616 1958 EXPAND_AS_DEFINED = 1617 1959 1618 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 1619 # doxygen's preprocessor will remove all references to function-like macros 1620 # that are alone on a line, have an all uppercase name, and do not end with a 1621 # semicolon, because these will confuse the parser if not removed. 1960 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will 1961 # remove all refrences to function-like macros that are alone on a line, have an 1962 # all uppercase name, and do not end with a semicolon. Such function macros are 1963 # typically used for boiler-plate code, and will confuse the parser if not 1964 # removed. 1965 # The default value is: YES. 1966 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 1622 1967 1623 1968 SKIP_FUNCTION_MACROS = YES 1624 1969 1625 1970 #--------------------------------------------------------------------------- 1626 # Configuration::additions related to external references 1627 #--------------------------------------------------------------------------- 1628 1629 # The TAGFILES option can be used to specify one or more tagfiles. For each 1630 # tag file the location of the external documentation should be added. The 1631 # format of a tag file without this location is as follows: 1632 # 1971 # Configuration options related to external references 1972 #--------------------------------------------------------------------------- 1973 1974 # The TAGFILES tag can be used to specify one or more tag files. For each tag 1975 # file the location of the external documentation should be added. The format of 1976 # a tag file without this location is as follows: 1633 1977 # TAGFILES = file1 file2 ... 1634 1978 # Adding location for the tag files is done as follows: 1635 #1636 1979 # TAGFILES = file1=loc1 "file2 = loc2" ... 1637 # where "loc1" and "loc2" can be relative or absolute paths 1638 # or URLs. Note that each tag file must have a unique name (where the name does 1639 # NOT include the path). If a tag file is not located in the directory in which 1640 # doxygen is run, you must also specify the path to the tagfile here. 1980 # where loc1 and loc2 can be relative or absolute paths or URLs. See the 1981 # section "Linking to external documentation" for more information about the use 1982 # of tag files. 1983 # Note: Each tag file must have an unique name (where the name does NOT include 1984 # the path). If a tag file is not located in the directory in which doxygen is 1985 # run, you must also specify the path to the tagfile here. 1641 1986 1642 1987 TAGFILES = 1643 1988 1644 # When a file name is specified after GENERATE_TAGFILE, doxygen will create 1645 # a tag file that is based on the input files it reads. 1989 # When a file name is specified after GENERATE_TAGFILE, doxygen will create a 1990 # tag file that is based on the input files it reads. See section "Linking to 1991 # external documentation" for more information about the usage of tag files. 1646 1992 1647 1993 GENERATE_TAGFILE = 1648 1994 1649 # If the ALLEXTERNALS tag is set to YES all external class es will be listed1650 # in the class index. If set to NO only the inherited external classes1651 # will be listed.1995 # If the ALLEXTERNALS tag is set to YES all external class will be listed in the 1996 # class index. If set to NO only the inherited external classes will be listed. 1997 # The default value is: NO. 1652 1998 1653 1999 ALLEXTERNALS = NO 1654 2000 1655 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 1656 # in the modules index. If set to NO, only the current project's groups will 2001 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in 2002 # the modules index. If set to NO, only the current project's groups will be 2003 # listed. 2004 # The default value is: YES. 2005 2006 EXTERNAL_GROUPS = YES 2007 2008 # If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in 2009 # the related pages index. If set to NO, only the current project's pages will 1657 2010 # be listed. 1658 1659 EXTERNAL_GROUPS = YES 2011 # The default value is: YES. 2012 2013 EXTERNAL_PAGES = YES 1660 2014 1661 2015 # The PERL_PATH should be the absolute path and name of the perl script 1662 # interpreter (i.e. the result of `which perl'). 2016 # interpreter (i.e. the result of 'which perl'). 2017 # The default file (with absolute path) is: /usr/bin/perl. 1663 2018 1664 2019 PERL_PATH = /usr/bin/perl … … 1668 2023 #--------------------------------------------------------------------------- 1669 2024 1670 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 1671 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base 1672 # or super classes. Setting the tag to NO turns the diagrams off. Note that 1673 # this option also works with HAVE_DOT disabled, but it is recommended to 1674 # install and use dot, since it yields more powerful graphs. 2025 # If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram 2026 # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to 2027 # NO turns the diagrams off. Note that this option also works with HAVE_DOT 2028 # disabled, but it is recommended to install and use dot, since it yields more 2029 # powerful graphs. 2030 # The default value is: YES. 1675 2031 1676 2032 CLASS_DIAGRAMS = YES 1677 2033 1678 2034 # You can define message sequence charts within doxygen comments using the \msc 1679 # command. Doxygen will then run the mscgen tool (see 1680 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the2035 # command. Doxygen will then run the mscgen tool (see: 2036 # http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the 1681 2037 # documentation. The MSCGEN_PATH tag allows you to specify the directory where 1682 2038 # the mscgen tool resides. If left empty the tool is assumed to be found in the … … 1685 2041 MSCGEN_PATH = 1686 2042 1687 # If set to YES, the inheritance and collaboration graphs will hide 1688 # inheritance and usage relations if the target is undocumented1689 # or is not a class.2043 # If set to YES, the inheritance and collaboration graphs will hide inheritance 2044 # and usage relations if the target is undocumented or is not a class. 2045 # The default value is: YES. 1690 2046 1691 2047 HIDE_UNDOC_RELATIONS = YES 1692 2048 1693 2049 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 1694 # available from the path. This tool is part of Graphviz, a graph visualization 1695 # toolkit from AT&T and Lucent Bell Labs. The other options in this section 1696 # have no effect if this option is set to NO (the default) 2050 # available from the path. This tool is part of Graphviz (see: 2051 # http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent 2052 # Bell Labs. The other options in this section have no effect if this option is 2053 # set to NO 2054 # The default value is: NO. 1697 2055 1698 2056 HAVE_DOT = NO 1699 2057 1700 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is 1701 # allowed to run in parallel. When set to 0 (the default) doxygen will 1702 # base this on the number of processors available in the system. You can set it 1703 # explicitly to a value larger than 0 to get control over the balance 1704 # between CPU load and processing speed. 2058 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed 2059 # to run in parallel. When set to 0 doxygen will base this on the number of 2060 # processors available in the system. You can set it explicitly to a value 2061 # larger than 0 to get control over the balance between CPU load and processing 2062 # speed. 2063 # Minimum value: 0, maximum value: 32, default value: 0. 2064 # This tag requires that the tag HAVE_DOT is set to YES. 1705 2065 1706 2066 DOT_NUM_THREADS = 0 1707 2067 1708 # By default doxygen will use the Helvetica font for all dot files that 1709 # doxygen generates. When you want a differently looking font you can specify 1710 # the font name using DOT_FONTNAME. You need to make sure dot is able to find 1711 # the font, which can be done by putting it in a standard location or by setting 1712 # the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the 1713 # directory containing the font. 1714 1715 DOT_FONTNAME = FreeSans 1716 1717 # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. 1718 # The default size is 10pt. 2068 # When you want a differently looking font n the dot files that doxygen 2069 # generates you can specify the font name using DOT_FONTNAME. You need to make 2070 # sure dot is able to find the font, which can be done by putting it in a 2071 # standard location or by setting the DOTFONTPATH environment variable or by 2072 # setting DOT_FONTPATH to the directory containing the font. 2073 # The default value is: Helvetica. 2074 # This tag requires that the tag HAVE_DOT is set to YES. 2075 2076 DOT_FONTNAME = 2077 2078 # The DOT_FONTSIZE tag can be used to set the size (in points) of the font of 2079 # dot graphs. 2080 # Minimum value: 4, maximum value: 24, default value: 10. 2081 # This tag requires that the tag HAVE_DOT is set to YES. 1719 2082 1720 2083 DOT_FONTSIZE = 10 1721 2084 1722 # By default doxygen will tell dot to use the Helvetica font. 1723 # If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to 1724 # set the path where dot can find it. 2085 # By default doxygen will tell dot to use the default font as specified with 2086 # DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set 2087 # the path where dot can find it using this tag. 2088 # This tag requires that the tag HAVE_DOT is set to YES. 1725 2089 1726 2090 DOT_FONTPATH = 1727 2091 1728 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 1729 # will generate a graph for each documented class showing the direct and 1730 # indirect inheritance relations. Setting this tag to YES will force the 1731 # CLASS_DIAGRAMS tag to NO. 2092 # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for 2093 # each documented class showing the direct and indirect inheritance relations. 2094 # Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO. 2095 # The default value is: YES. 2096 # This tag requires that the tag HAVE_DOT is set to YES. 1732 2097 1733 2098 CLASS_GRAPH = YES 1734 2099 1735 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 1736 # will generate a graph for each documented class showing the direct and 1737 # indirect implementation dependencies (inheritance, containment, and 1738 # class references variables) of the class with other documented classes. 2100 # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a 2101 # graph for each documented class showing the direct and indirect implementation 2102 # dependencies (inheritance, containment, and class references variables) of the 2103 # class with other documented classes. 2104 # The default value is: YES. 2105 # This tag requires that the tag HAVE_DOT is set to YES. 1739 2106 1740 2107 COLLABORATION_GRAPH = YES 1741 2108 1742 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen 1743 # will generate a graph for groups, showing the direct groups dependencies 2109 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for 2110 # groups, showing the direct groups dependencies. 2111 # The default value is: YES. 2112 # This tag requires that the tag HAVE_DOT is set to YES. 1744 2113 1745 2114 GROUP_GRAPHS = YES … … 1748 2117 # collaboration diagrams in a style similar to the OMG's Unified Modeling 1749 2118 # Language. 2119 # The default value is: NO. 2120 # This tag requires that the tag HAVE_DOT is set to YES. 1750 2121 1751 2122 UML_LOOK = NO 1752 2123 1753 # If the UML_LOOK tag is enabled, the fields and methods are shown inside 1754 # the class node. If there are many fields or methods and many nodes the 1755 # graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS 1756 # threshold limits the number of items for each type to make the size more 1757 # managable. Set this to 0 for no limit. Note that the threshold may be 1758 # exceeded by 50% before the limit is enforced. 2124 # If the UML_LOOK tag is enabled, the fields and methods are shown inside the 2125 # class node. If there are many fields or methods and many nodes the graph may 2126 # become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the 2127 # number of items for each type to make the size more manageable. Set this to 0 2128 # for no limit. Note that the threshold may be exceeded by 50% before the limit 2129 # is enforced. So when you set the threshold to 10, up to 15 fields may appear, 2130 # but if the number exceeds 15, the total amount of fields shown is limited to 2131 # 10. 2132 # Minimum value: 0, maximum value: 100, default value: 10. 2133 # This tag requires that the tag HAVE_DOT is set to YES. 1759 2134 1760 2135 UML_LIMIT_NUM_FIELDS = 10 1761 2136 1762 # If set to YES, the inheritance and collaboration graphs will show the 1763 # relations between templates and their instances. 2137 # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and 2138 # collaboration graphs will show the relations between templates and their 2139 # instances. 2140 # The default value is: NO. 2141 # This tag requires that the tag HAVE_DOT is set to YES. 1764 2142 1765 2143 TEMPLATE_RELATIONS = NO 1766 2144 1767 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 1768 # tags are set to YES then doxygen will generate a graph for each documented 1769 # file showing the direct and indirect include dependencies of the file with 1770 # other documented files. 2145 # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to 2146 # YES then doxygen will generate a graph for each documented file showing the 2147 # direct and indirect include dependencies of the file with other documented 2148 # files. 2149 # The default value is: YES. 2150 # This tag requires that the tag HAVE_DOT is set to YES. 1771 2151 1772 2152 INCLUDE_GRAPH = YES 1773 2153 1774 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 1775 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each 1776 # documented header file showing the documented files that directly or 1777 # indirectly include this file. 2154 # If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are 2155 # set to YES then doxygen will generate a graph for each documented file showing 2156 # the direct and indirect include dependencies of the file with other documented 2157 # files. 2158 # The default value is: YES. 2159 # This tag requires that the tag HAVE_DOT is set to YES. 1778 2160 1779 2161 INCLUDED_BY_GRAPH = YES 1780 2162 1781 # If the CALL_GRAPH and HAVE_DOT options are set to YES then 1782 # doxygen will generate a call dependency graph for every global function 1783 # or class method. Note that enabling this option will significantly increase 1784 # the time of a run. So in most cases it will be better to enable call graphs 1785 # for selected functions only using the \callgraph command. 2163 # If the CALL_GRAPH tag is set to YES then doxygen will generate a call 2164 # dependency graph for every global function or class method. 2165 # 2166 # Note that enabling this option will significantly increase the time of a run. 2167 # So in most cases it will be better to enable call graphs for selected 2168 # functions only using the \callgraph command. 2169 # The default value is: NO. 2170 # This tag requires that the tag HAVE_DOT is set to YES. 1786 2171 1787 2172 CALL_GRAPH = NO 1788 2173 1789 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then 1790 # doxygen will generate a caller dependency graph for every global function 1791 # or class method. Note that enabling this option will significantly increase 1792 # the time of a run. So in most cases it will be better to enable caller 1793 # graphs for selected functions only using the \callergraph command. 2174 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller 2175 # dependency graph for every global function or class method. 2176 # 2177 # Note that enabling this option will significantly increase the time of a run. 2178 # So in most cases it will be better to enable caller graphs for selected 2179 # functions only using the \callergraph command. 2180 # The default value is: NO. 2181 # This tag requires that the tag HAVE_DOT is set to YES. 1794 2182 1795 2183 CALLER_GRAPH = NO 1796 2184 1797 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 1798 # will generate a graphical hierarchy of all classes instead of a textual one. 2185 # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical 2186 # hierarchy of all classes instead of a textual one. 2187 # The default value is: YES. 2188 # This tag requires that the tag HAVE_DOT is set to YES. 1799 2189 1800 2190 GRAPHICAL_HIERARCHY = YES 1801 2191 1802 # If the DIRECTORY_GRAPH and HAVE_DOT tags are set to YES 1803 # then doxygen will show the dependencies a directory has on other directories 1804 # in a graphical way. The dependency relations are determined by the #include 1805 # relations between the files in the directories. 2192 # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the 2193 # dependencies a directory has on other directories in a graphical way. The 2194 # dependency relations are determined by the #include relations between the 2195 # files in the directories. 2196 # The default value is: YES. 2197 # This tag requires that the tag HAVE_DOT is set to YES. 1806 2198 1807 2199 DIRECTORY_GRAPH = YES 1808 2200 1809 2201 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 1810 # generated by dot. Possible values are svg, png, jpg, or gif. 1811 # If left blank png will be used. If you choose svg you need to set 1812 # HTML_FILE_EXTENSION to xhtml in order to make the SVG files 1813 # visible in IE 9+ (other browsers do not have this requirement). 2202 # generated by dot. 2203 # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order 2204 # to make the SVG files visible in IE 9+ (other browsers do not have this 2205 # requirement). 2206 # Possible values are: png, jpg, gif and svg. 2207 # The default value is: png. 2208 # This tag requires that the tag HAVE_DOT is set to YES. 1814 2209 1815 2210 DOT_IMAGE_FORMAT = png … … 1817 2212 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to 1818 2213 # enable generation of interactive SVG images that allow zooming and panning. 1819 # Note that this requires a modern browser other than Internet Explorer. 1820 # Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you 1821 # need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files 1822 # visible. Older versions of IE do not have SVG support. 2214 # 2215 # Note that this requires a modern browser other than Internet Explorer. Tested 2216 # and working are Firefox, Chrome, Safari, and Opera. 2217 # Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make 2218 # the SVG files visible. Older versions of IE do not have SVG support. 2219 # The default value is: NO. 2220 # This tag requires that the tag HAVE_DOT is set to YES. 1823 2221 1824 2222 INTERACTIVE_SVG = NO 1825 2223 1826 # The tag DOT_PATHcan be used to specify the path where the dot tool can be2224 # The DOT_PATH tag can be used to specify the path where the dot tool can be 1827 2225 # found. If left blank, it is assumed the dot tool can be found in the path. 2226 # This tag requires that the tag HAVE_DOT is set to YES. 1828 2227 1829 2228 DOT_PATH = 1830 2229 1831 2230 # The DOTFILE_DIRS tag can be used to specify one or more directories that 1832 # contain dot files that are included in the documentation (see the 1833 # \dotfile command). 2231 # contain dot files that are included in the documentation (see the \dotfile 2232 # command). 2233 # This tag requires that the tag HAVE_DOT is set to YES. 1834 2234 1835 2235 DOTFILE_DIRS = 1836 2236 1837 2237 # The MSCFILE_DIRS tag can be used to specify one or more directories that 1838 # contain msc files that are included in the documentation (see the 1839 # \mscfilecommand).2238 # contain msc files that are included in the documentation (see the \mscfile 2239 # command). 1840 2240 1841 2241 MSCFILE_DIRS = 1842 2242 1843 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of 1844 # nodes that will be shown in the graph. If the number of nodes in a graph 1845 # becomes larger than this value, doxygen will truncate the graph, which is 1846 # visualized by representing a node as a red box. Note that doxygen if the 1847 # number of direct children of the root node in a graph is already larger than 1848 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note 1849 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. 2243 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes 2244 # that will be shown in the graph. If the number of nodes in a graph becomes 2245 # larger than this value, doxygen will truncate the graph, which is visualized 2246 # by representing a node as a red box. Note that doxygen if the number of direct 2247 # children of the root node in a graph is already larger than 2248 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that 2249 # the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. 2250 # Minimum value: 0, maximum value: 10000, default value: 50. 2251 # This tag requires that the tag HAVE_DOT is set to YES. 1850 2252 1851 2253 DOT_GRAPH_MAX_NODES = 50 1852 2254 1853 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 1854 # g raphs generated by dot. A depth value of 3 means that only nodes reachable1855 # from the root by following a path via at most 3 edges will be shown. Nodes1856 # that lay further from the root node will be omitted. Note that setting this1857 # o ption to 1 or 2 may greatly reduce the computation time needed for large1858 # code bases. Alsonote that the size of a graph can be further restricted by2255 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs 2256 # generated by dot. A depth value of 3 means that only nodes reachable from the 2257 # root by following a path via at most 3 edges will be shown. Nodes that lay 2258 # further from the root node will be omitted. Note that setting this option to 1 2259 # or 2 may greatly reduce the computation time needed for large code bases. Also 2260 # note that the size of a graph can be further restricted by 1859 2261 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. 2262 # Minimum value: 0, maximum value: 1000, default value: 0. 2263 # This tag requires that the tag HAVE_DOT is set to YES. 1860 2264 1861 2265 MAX_DOT_GRAPH_DEPTH = 0 1862 2266 1863 2267 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 1864 # background. This is disabled by default, because dot on Windows does not 1865 # seem to support this out of the box. Warning: Depending on the platform used, 1866 # enabling this option may lead to badly anti-aliased labels on the edges of 1867 # a graph (i.e. they become hard to read). 2268 # background. This is disabled by default, because dot on Windows does not seem 2269 # to support this out of the box. 2270 # 2271 # Warning: Depending on the platform used, enabling this option may lead to 2272 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to 2273 # read). 2274 # The default value is: NO. 2275 # This tag requires that the tag HAVE_DOT is set to YES. 1868 2276 1869 2277 DOT_TRANSPARENT = NO … … 1871 2279 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output 1872 2280 # files in one run (i.e. multiple -o and -T options on the command line). This 1873 # makes dot run faster, but since only newer versions of dot (>1.8.10) 1874 # support this, this feature is disabled by default. 2281 # makes dot run faster, but since only newer versions of dot (>1.8.10) support 2282 # this, this feature is disabled by default. 2283 # The default value is: NO. 2284 # This tag requires that the tag HAVE_DOT is set to YES. 1875 2285 1876 2286 DOT_MULTI_TARGETS = NO 1877 2287 1878 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 1879 # generate a legend page explaining the meaning of the various boxes and 1880 # arrows in the dot generated graphs. 2288 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page 2289 # explaining the meaning of the various boxes and arrows in the dot generated 2290 # graphs. 2291 # The default value is: YES. 2292 # This tag requires that the tag HAVE_DOT is set to YES. 1881 2293 1882 2294 GENERATE_LEGEND = YES 1883 2295 1884 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 1885 # remove the intermediate dot files that are used to generate 1886 # the various graphs. 2296 # If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot 2297 # files that are used to generate the various graphs. 2298 # The default value is: YES. 2299 # This tag requires that the tag HAVE_DOT is set to YES. 1887 2300 1888 2301 DOT_CLEANUP = YES
Note: See TracChangeset
for help on using the changeset viewer.