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