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