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