├── .clangd ├── .editorconfig ├── .github └── workflows │ ├── build.yml │ └── gh-pages.yml ├── .gitignore ├── .gitmodules ├── Doxyfile ├── LICENSE ├── README.md ├── build ├── example_host.c ├── example_plugin.c ├── example_shared.h ├── mainpage.md ├── premake5.lua ├── remodule.h └── remodule_monitor.h /.clangd: -------------------------------------------------------------------------------- 1 | --- 2 | CompileFlags: 3 | Add: [-xc, -Wall, -Werror, -pedantic, -std=c11] 4 | --- 5 | If: 6 | PathMatch: remodule\.h 7 | CompileFlags: 8 | Add: [-DREMODULE_PLUGIN_IMPLEMENTATION, -DREMODULE_HOST_IMPLEMENTATION] 9 | --- 10 | If: 11 | PathMatch: remodule_monitor\.h 12 | CompileFlags: 13 | Add: [-DREMODULE_MONITOR_IMPLEMENTATION] 14 | -------------------------------------------------------------------------------- /.editorconfig: -------------------------------------------------------------------------------- 1 | root = true 2 | 3 | # Unix-style newlines with a newline ending every file 4 | [*] 5 | end_of_line = lf 6 | insert_final_newline = true 7 | charset = utf-8 8 | indent_style = tab 9 | trim_trailing_whitespace = true 10 | 11 | [*.yml] 12 | indent_style = space 13 | -------------------------------------------------------------------------------- /.github/workflows/build.yml: -------------------------------------------------------------------------------- 1 | name: Build 2 | run-name: Build 3 | concurrency: 4 | group: ${{ github.workflow }}-${{ github.ref }} 5 | cancel-in-progress: true 6 | on: 7 | - push 8 | jobs: 9 | build-windows: 10 | runs-on: windows-latest 11 | steps: 12 | - name: Checkout code 13 | uses: actions/checkout@v2 14 | with: 15 | submodules: recursive 16 | - name: Install MSVC 17 | uses: ilammy/msvc-dev-cmd@v1 18 | with: 19 | arch: x64 20 | sdk: 10.0.22621.0 21 | vsversion: 2022 22 | - name: Install Premake 23 | uses: abel0b/setup-premake@v2.3 24 | with: 25 | version: "5.0.0-beta2" 26 | - name: Generate project 27 | run: premake5 vs2022 28 | - name: Build 29 | run: | 30 | cd vs2022 31 | msbuild remodule.sln /property:Configuration=Release /property:Platform=x64 32 | build-linux: 33 | runs-on: ubuntu-latest 34 | steps: 35 | - name: Checkout code 36 | uses: actions/checkout@v4 37 | with: 38 | submodules: recursive 39 | - name: Build 40 | run: ./build 41 | -------------------------------------------------------------------------------- /.github/workflows/gh-pages.yml: -------------------------------------------------------------------------------- 1 | name: Deploy Github pages from Doxygen 2 | 3 | on: 4 | push: 5 | branches: 6 | - master 7 | 8 | permissions: 9 | contents: write 10 | 11 | jobs: 12 | deploy: 13 | runs-on: ubuntu-latest 14 | steps: 15 | - uses: DenverCoder1/doxygen-github-pages-action@v1.3.0 16 | with: 17 | github_token: ${{ secrets.GITHUB_TOKEN }} 18 | folder: doc 19 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | /vs2022 2 | /bin 3 | /doc 4 | -------------------------------------------------------------------------------- /.gitmodules: -------------------------------------------------------------------------------- 1 | [submodule "libs"] 2 | path = libs 3 | url = https://github.com/bullno1/libs.git 4 | -------------------------------------------------------------------------------- /Doxyfile: -------------------------------------------------------------------------------- 1 | # Doxyfile 1.10.0 2 | 3 | # This file describes the settings to be used by the documentation system 4 | # doxygen (www.doxygen.org) for a project. 5 | # 6 | # All text after a double hash (##) is considered a comment and is placed in 7 | # front of the TAG it is preceding. 8 | # 9 | # All text after a single hash (#) is considered a comment and will be ignored. 10 | # The format is: 11 | # TAG = value [value, ...] 12 | # For lists, items can also be appended using: 13 | # TAG += value [value, ...] 14 | # Values that contain spaces should be placed between quotes (\" \"). 15 | # 16 | # Note: 17 | # 18 | # Use doxygen to compare the used configuration file with the template 19 | # configuration file: 20 | # doxygen -x [configFile] 21 | # Use doxygen to compare the used configuration file with the template 22 | # configuration file without replacing the environment variables or CMake type 23 | # replacement variables: 24 | # doxygen -x_noenv [configFile] 25 | 26 | #--------------------------------------------------------------------------- 27 | # Project related configuration options 28 | #--------------------------------------------------------------------------- 29 | 30 | # This tag specifies the encoding used for all characters in the configuration 31 | # file that follow. The default is UTF-8 which is also the encoding used for all 32 | # text before the first occurrence of this tag. Doxygen uses libiconv (or the 33 | # iconv built into libc) for the transcoding. See 34 | # https://www.gnu.org/software/libiconv/ for the list of possible encodings. 35 | # The default value is: UTF-8. 36 | 37 | DOXYFILE_ENCODING = UTF-8 38 | 39 | # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by 40 | # double-quotes, unless you are using Doxywizard) that should identify the 41 | # project for which the documentation is generated. This name is used in the 42 | # title of most generated pages and in a few other places. 43 | # The default value is: My Project. 44 | 45 | PROJECT_NAME = "re:module" 46 | 47 | # The PROJECT_NUMBER tag can be used to enter a project or revision number. This 48 | # could be handy for archiving the generated documentation or if some version 49 | # control system is used. 50 | 51 | PROJECT_NUMBER = 52 | 53 | # Using the PROJECT_BRIEF tag one can provide an optional one line description 54 | # for a project that appears at the top of each page and should give viewer a 55 | # quick idea about the purpose of the project. Keep the description short. 56 | 57 | PROJECT_BRIEF = "Hot reload C modules" 58 | 59 | # With the PROJECT_LOGO tag one can specify a logo or an icon that is included 60 | # in the documentation. The maximum height of the logo should not exceed 55 61 | # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy 62 | # the logo to the output directory. 63 | 64 | PROJECT_LOGO = 65 | 66 | # With the PROJECT_ICON tag one can specify an icon that is included in the tabs 67 | # when the HTML document is shown. Doxygen will copy the logo to the output 68 | # directory. 69 | 70 | PROJECT_ICON = 71 | 72 | # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path 73 | # into which the generated documentation will be written. If a relative path is 74 | # entered, it will be relative to the location where doxygen was started. If 75 | # left blank the current directory will be used. 76 | 77 | OUTPUT_DIRECTORY = "doc" 78 | 79 | # If the CREATE_SUBDIRS tag is set to YES then doxygen will create up to 4096 80 | # sub-directories (in 2 levels) under the output directory of each output format 81 | # and will distribute the generated files over these directories. Enabling this 82 | # option can be useful when feeding doxygen a huge amount of source files, where 83 | # putting all generated files in the same directory would otherwise causes 84 | # performance problems for the file system. Adapt CREATE_SUBDIRS_LEVEL to 85 | # control the number of sub-directories. 86 | # The default value is: NO. 87 | 88 | CREATE_SUBDIRS = NO 89 | 90 | # Controls the number of sub-directories that will be created when 91 | # CREATE_SUBDIRS tag is set to YES. Level 0 represents 16 directories, and every 92 | # level increment doubles the number of directories, resulting in 4096 93 | # directories at level 8 which is the default and also the maximum value. The 94 | # sub-directories are organized in 2 levels, the first level always has a fixed 95 | # number of 16 directories. 96 | # Minimum value: 0, maximum value: 8, default value: 8. 97 | # This tag requires that the tag CREATE_SUBDIRS is set to YES. 98 | 99 | CREATE_SUBDIRS_LEVEL = 8 100 | 101 | # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII 102 | # characters to appear in the names of generated files. If set to NO, non-ASCII 103 | # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode 104 | # U+3044. 105 | # The default value is: NO. 106 | 107 | ALLOW_UNICODE_NAMES = NO 108 | 109 | # The OUTPUT_LANGUAGE tag is used to specify the language in which all 110 | # documentation generated by doxygen is written. Doxygen will use this 111 | # information to generate all constant output in the proper language. 112 | # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Bulgarian, 113 | # Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, English 114 | # (United States), Esperanto, Farsi (Persian), Finnish, French, German, Greek, 115 | # Hindi, Hungarian, Indonesian, Italian, Japanese, Japanese-en (Japanese with 116 | # English messages), Korean, Korean-en (Korean with English messages), Latvian, 117 | # Lithuanian, Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, 118 | # Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, 119 | # Swedish, Turkish, Ukrainian and Vietnamese. 120 | # The default value is: English. 121 | 122 | OUTPUT_LANGUAGE = English 123 | 124 | # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member 125 | # descriptions after the members that are listed in the file and class 126 | # documentation (similar to Javadoc). Set to NO to disable this. 127 | # The default value is: YES. 128 | 129 | BRIEF_MEMBER_DESC = YES 130 | 131 | # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief 132 | # description of a member or function before the detailed description 133 | # 134 | # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 135 | # brief descriptions will be completely suppressed. 136 | # The default value is: YES. 137 | 138 | REPEAT_BRIEF = YES 139 | 140 | # This tag implements a quasi-intelligent brief description abbreviator that is 141 | # used to form the text in various listings. Each string in this list, if found 142 | # as the leading text of the brief description, will be stripped from the text 143 | # and the result, after processing the whole list, is used as the annotated 144 | # text. Otherwise, the brief description is used as-is. If left blank, the 145 | # following values are used ($name is automatically replaced with the name of 146 | # the entity):The $name class, The $name widget, The $name file, is, provides, 147 | # specifies, contains, represents, a, an and the. 148 | 149 | ABBREVIATE_BRIEF = "The $name class" \ 150 | "The $name widget" \ 151 | "The $name file" \ 152 | is \ 153 | provides \ 154 | specifies \ 155 | contains \ 156 | represents \ 157 | a \ 158 | an \ 159 | the 160 | 161 | # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 162 | # doxygen will generate a detailed section even if there is only a brief 163 | # description. 164 | # The default value is: NO. 165 | 166 | ALWAYS_DETAILED_SEC = NO 167 | 168 | # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 169 | # inherited members of a class in the documentation of that class as if those 170 | # members were ordinary class members. Constructors, destructors and assignment 171 | # operators of the base classes will not be shown. 172 | # The default value is: NO. 173 | 174 | INLINE_INHERITED_MEMB = NO 175 | 176 | # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path 177 | # before files name in the file list and in the header files. If set to NO the 178 | # shortest path that makes the file name unique will be used 179 | # The default value is: YES. 180 | 181 | FULL_PATH_NAMES = YES 182 | 183 | # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. 184 | # Stripping is only done if one of the specified strings matches the left-hand 185 | # part of the path. The tag can be used to show relative paths in the file list. 186 | # If left blank the directory from which doxygen is run is used as the path to 187 | # strip. 188 | # 189 | # Note that you can specify absolute paths here, but also relative paths, which 190 | # will be relative from the directory where doxygen is started. 191 | # This tag requires that the tag FULL_PATH_NAMES is set to YES. 192 | 193 | STRIP_FROM_PATH = 194 | 195 | # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the 196 | # path mentioned in the documentation of a class, which tells the reader which 197 | # header file to include in order to use a class. If left blank only the name of 198 | # the header file containing the class definition is used. Otherwise one should 199 | # specify the list of include paths that are normally passed to the compiler 200 | # using the -I flag. 201 | 202 | STRIP_FROM_INC_PATH = 203 | 204 | # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but 205 | # less readable) file names. This can be useful is your file systems doesn't 206 | # support long names like on DOS, Mac, or CD-ROM. 207 | # The default value is: NO. 208 | 209 | SHORT_NAMES = NO 210 | 211 | # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the 212 | # first line (until the first dot) of a Javadoc-style comment as the brief 213 | # description. If set to NO, the Javadoc-style will behave just like regular Qt- 214 | # style comments (thus requiring an explicit @brief command for a brief 215 | # description.) 216 | # The default value is: NO. 217 | 218 | JAVADOC_AUTOBRIEF = NO 219 | 220 | # If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line 221 | # such as 222 | # /*************** 223 | # as being the beginning of a Javadoc-style comment "banner". If set to NO, the 224 | # Javadoc-style will behave just like regular comments and it will not be 225 | # interpreted by doxygen. 226 | # The default value is: NO. 227 | 228 | JAVADOC_BANNER = NO 229 | 230 | # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first 231 | # line (until the first dot) of a Qt-style comment as the brief description. If 232 | # set to NO, the Qt-style will behave just like regular Qt-style comments (thus 233 | # requiring an explicit \brief command for a brief description.) 234 | # The default value is: NO. 235 | 236 | QT_AUTOBRIEF = YES 237 | 238 | # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a 239 | # multi-line C++ special comment block (i.e. a block of //! or /// comments) as 240 | # a brief description. This used to be the default behavior. The new default is 241 | # to treat a multi-line C++ comment block as a detailed description. Set this 242 | # tag to YES if you prefer the old behavior instead. 243 | # 244 | # Note that setting this tag to YES also means that rational rose comments are 245 | # not recognized any more. 246 | # The default value is: NO. 247 | 248 | MULTILINE_CPP_IS_BRIEF = NO 249 | 250 | # By default Python docstrings are displayed as preformatted text and doxygen's 251 | # special commands cannot be used. By setting PYTHON_DOCSTRING to NO the 252 | # doxygen's special commands can be used and the contents of the docstring 253 | # documentation blocks is shown as doxygen documentation. 254 | # The default value is: YES. 255 | 256 | PYTHON_DOCSTRING = YES 257 | 258 | # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the 259 | # documentation from any documented member that it re-implements. 260 | # The default value is: YES. 261 | 262 | INHERIT_DOCS = YES 263 | 264 | # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new 265 | # page for each member. If set to NO, the documentation of a member will be part 266 | # of the file/class/namespace that contains it. 267 | # The default value is: NO. 268 | 269 | SEPARATE_MEMBER_PAGES = NO 270 | 271 | # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen 272 | # uses this value to replace tabs by spaces in code fragments. 273 | # Minimum value: 1, maximum value: 16, default value: 4. 274 | 275 | TAB_SIZE = 4 276 | 277 | # This tag can be used to specify a number of aliases that act as commands in 278 | # the documentation. An alias has the form: 279 | # name=value 280 | # For example adding 281 | # "sideeffect=@par Side Effects:^^" 282 | # will allow you to put the command \sideeffect (or @sideeffect) in the 283 | # documentation, which will result in a user-defined paragraph with heading 284 | # "Side Effects:". Note that you cannot put \n's in the value part of an alias 285 | # to insert newlines (in the resulting output). You can put ^^ in the value part 286 | # of an alias to insert a newline as if a physical newline was in the original 287 | # file. When you need a literal { or } or , in the value part of an alias you 288 | # have to escape them by means of a backslash (\), this can lead to conflicts 289 | # with the commands \{ and \} for these it is advised to use the version @{ and 290 | # @} or use a double escape (\\{ and \\}) 291 | 292 | ALIASES = 293 | 294 | # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources 295 | # only. Doxygen will then generate output that is more tailored for C. For 296 | # instance, some of the names that are used will be different. The list of all 297 | # members will be omitted, etc. 298 | # The default value is: NO. 299 | 300 | OPTIMIZE_OUTPUT_FOR_C = NO 301 | 302 | # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or 303 | # Python sources only. Doxygen will then generate output that is more tailored 304 | # for that language. For instance, namespaces will be presented as packages, 305 | # qualified scopes will look different, etc. 306 | # The default value is: NO. 307 | 308 | OPTIMIZE_OUTPUT_JAVA = NO 309 | 310 | # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 311 | # sources. Doxygen will then generate output that is tailored for Fortran. 312 | # The default value is: NO. 313 | 314 | OPTIMIZE_FOR_FORTRAN = NO 315 | 316 | # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 317 | # sources. Doxygen will then generate output that is tailored for VHDL. 318 | # The default value is: NO. 319 | 320 | OPTIMIZE_OUTPUT_VHDL = NO 321 | 322 | # Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice 323 | # sources only. Doxygen will then generate output that is more tailored for that 324 | # language. For instance, namespaces will be presented as modules, types will be 325 | # separated into more groups, etc. 326 | # The default value is: NO. 327 | 328 | OPTIMIZE_OUTPUT_SLICE = NO 329 | 330 | # Doxygen selects the parser to use depending on the extension of the files it 331 | # parses. With this tag you can assign which parser to use for a given 332 | # extension. Doxygen has a built-in mapping, but you can override or extend it 333 | # using this tag. The format is ext=language, where ext is a file extension, and 334 | # language is one of the parsers supported by doxygen: IDL, Java, JavaScript, 335 | # Csharp (C#), C, C++, Lex, D, PHP, md (Markdown), Objective-C, Python, Slice, 336 | # VHDL, Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: 337 | # FortranFree, unknown formatted Fortran: Fortran. In the later case the parser 338 | # tries to guess whether the code is fixed or free formatted code, this is the 339 | # default for Fortran type files). For instance to make doxygen treat .inc files 340 | # as Fortran files (default is PHP), and .f files as C (default is Fortran), 341 | # use: inc=Fortran f=C. 342 | # 343 | # Note: For files without extension you can use no_extension as a placeholder. 344 | # 345 | # Note that for custom extensions you also need to set FILE_PATTERNS otherwise 346 | # the files are not read by doxygen. When specifying no_extension you should add 347 | # * to the FILE_PATTERNS. 348 | # 349 | # Note see also the list of default file extension mappings. 350 | 351 | EXTENSION_MAPPING = 352 | 353 | # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments 354 | # according to the Markdown format, which allows for more readable 355 | # documentation. See https://daringfireball.net/projects/markdown/ for details. 356 | # The output of markdown processing is further processed by doxygen, so you can 357 | # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in 358 | # case of backward compatibilities issues. 359 | # The default value is: YES. 360 | 361 | MARKDOWN_SUPPORT = YES 362 | 363 | # When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up 364 | # to that level are automatically included in the table of contents, even if 365 | # they do not have an id attribute. 366 | # Note: This feature currently applies only to Markdown headings. 367 | # Minimum value: 0, maximum value: 99, default value: 5. 368 | # This tag requires that the tag MARKDOWN_SUPPORT is set to YES. 369 | 370 | TOC_INCLUDE_HEADINGS = 5 371 | 372 | # The MARKDOWN_ID_STYLE tag can be used to specify the algorithm used to 373 | # generate identifiers for the Markdown headings. Note: Every identifier is 374 | # unique. 375 | # Possible values are: DOXYGEN use a fixed 'autotoc_md' string followed by a 376 | # sequence number starting at 0 and GITHUB use the lower case version of title 377 | # with any whitespace replaced by '-' and punctuation characters removed. 378 | # The default value is: DOXYGEN. 379 | # This tag requires that the tag MARKDOWN_SUPPORT is set to YES. 380 | 381 | MARKDOWN_ID_STYLE = DOXYGEN 382 | 383 | # When enabled doxygen tries to link words that correspond to documented 384 | # classes, or namespaces to their corresponding documentation. Such a link can 385 | # be prevented in individual cases by putting a % sign in front of the word or 386 | # globally by setting AUTOLINK_SUPPORT to NO. 387 | # The default value is: YES. 388 | 389 | AUTOLINK_SUPPORT = YES 390 | 391 | # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 392 | # to include (a tag file for) the STL sources as input, then you should set this 393 | # tag to YES in order to let doxygen match functions declarations and 394 | # definitions whose arguments contain STL classes (e.g. func(std::string); 395 | # versus func(std::string) {}). This also make the inheritance and collaboration 396 | # diagrams that involve STL classes more complete and accurate. 397 | # The default value is: NO. 398 | 399 | BUILTIN_STL_SUPPORT = NO 400 | 401 | # If you use Microsoft's C++/CLI language, you should set this option to YES to 402 | # enable parsing support. 403 | # The default value is: NO. 404 | 405 | CPP_CLI_SUPPORT = NO 406 | 407 | # Set the SIP_SUPPORT tag to YES if your project consists of sip (see: 408 | # https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen 409 | # will parse them like normal C++ but will assume all classes use public instead 410 | # of private inheritance when no explicit protection keyword is present. 411 | # The default value is: NO. 412 | 413 | SIP_SUPPORT = NO 414 | 415 | # For Microsoft's IDL there are propget and propput attributes to indicate 416 | # getter and setter methods for a property. Setting this option to YES will make 417 | # doxygen to replace the get and set methods by a property in the documentation. 418 | # This will only work if the methods are indeed getting or setting a simple 419 | # type. If this is not the case, or you want to show the methods anyway, you 420 | # should set this option to NO. 421 | # The default value is: YES. 422 | 423 | IDL_PROPERTY_SUPPORT = YES 424 | 425 | # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 426 | # tag is set to YES then doxygen will reuse the documentation of the first 427 | # member in the group (if any) for the other members of the group. By default 428 | # all members of a group must be documented explicitly. 429 | # The default value is: NO. 430 | 431 | DISTRIBUTE_GROUP_DOC = NO 432 | 433 | # If one adds a struct or class to a group and this option is enabled, then also 434 | # any nested class or struct is added to the same group. By default this option 435 | # is disabled and one has to add nested compounds explicitly via \ingroup. 436 | # The default value is: NO. 437 | 438 | GROUP_NESTED_COMPOUNDS = NO 439 | 440 | # Set the SUBGROUPING tag to YES to allow class member groups of the same type 441 | # (for instance a group of public functions) to be put as a subgroup of that 442 | # type (e.g. under the Public Functions section). Set it to NO to prevent 443 | # subgrouping. Alternatively, this can be done per class using the 444 | # \nosubgrouping command. 445 | # The default value is: YES. 446 | 447 | SUBGROUPING = YES 448 | 449 | # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions 450 | # are shown inside the group in which they are included (e.g. using \ingroup) 451 | # instead of on a separate page (for HTML and Man pages) or section (for LaTeX 452 | # and RTF). 453 | # 454 | # Note that this feature does not work in combination with 455 | # SEPARATE_MEMBER_PAGES. 456 | # The default value is: NO. 457 | 458 | INLINE_GROUPED_CLASSES = NO 459 | 460 | # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions 461 | # with only public data fields or simple typedef fields will be shown inline in 462 | # the documentation of the scope in which they are defined (i.e. file, 463 | # namespace, or group documentation), provided this scope is documented. If set 464 | # to NO, structs, classes, and unions are shown on a separate page (for HTML and 465 | # Man pages) or section (for LaTeX and RTF). 466 | # The default value is: NO. 467 | 468 | INLINE_SIMPLE_STRUCTS = NO 469 | 470 | # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or 471 | # enum is documented as struct, union, or enum with the name of the typedef. So 472 | # typedef struct TypeS {} TypeT, will appear in the documentation as a struct 473 | # with name TypeT. When disabled the typedef will appear as a member of a file, 474 | # namespace, or class. And the struct will be named TypeS. This can typically be 475 | # useful for C code in case the coding convention dictates that all compound 476 | # types are typedef'ed and only the typedef is referenced, never the tag name. 477 | # The default value is: NO. 478 | 479 | TYPEDEF_HIDES_STRUCT = NO 480 | 481 | # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This 482 | # cache is used to resolve symbols given their name and scope. Since this can be 483 | # an expensive process and often the same symbol appears multiple times in the 484 | # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small 485 | # doxygen will become slower. If the cache is too large, memory is wasted. The 486 | # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range 487 | # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 488 | # symbols. At the end of a run doxygen will report the cache usage and suggest 489 | # the optimal cache size from a speed point of view. 490 | # Minimum value: 0, maximum value: 9, default value: 0. 491 | 492 | LOOKUP_CACHE_SIZE = 0 493 | 494 | # The NUM_PROC_THREADS specifies the number of threads doxygen is allowed to use 495 | # during processing. When set to 0 doxygen will based this on the number of 496 | # cores available in the system. You can set it explicitly to a value larger 497 | # than 0 to get more control over the balance between CPU load and processing 498 | # speed. At this moment only the input processing can be done using multiple 499 | # threads. Since this is still an experimental feature the default is set to 1, 500 | # which effectively disables parallel processing. Please report any issues you 501 | # encounter. Generating dot graphs in parallel is controlled by the 502 | # DOT_NUM_THREADS setting. 503 | # Minimum value: 0, maximum value: 32, default value: 1. 504 | 505 | NUM_PROC_THREADS = 1 506 | 507 | # If the TIMESTAMP tag is set different from NO then each generated page will 508 | # contain the date or date and time when the page was generated. Setting this to 509 | # NO can help when comparing the output of multiple runs. 510 | # Possible values are: YES, NO, DATETIME and DATE. 511 | # The default value is: NO. 512 | 513 | TIMESTAMP = NO 514 | 515 | #--------------------------------------------------------------------------- 516 | # Build related configuration options 517 | #--------------------------------------------------------------------------- 518 | 519 | # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in 520 | # documentation are documented, even if no documentation was available. Private 521 | # class members and static file members will be hidden unless the 522 | # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. 523 | # Note: This will also disable the warnings about undocumented members that are 524 | # normally produced when WARNINGS is set to YES. 525 | # The default value is: NO. 526 | 527 | EXTRACT_ALL = NO 528 | 529 | # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will 530 | # be included in the documentation. 531 | # The default value is: NO. 532 | 533 | EXTRACT_PRIVATE = NO 534 | 535 | # If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual 536 | # methods of a class will be included in the documentation. 537 | # The default value is: NO. 538 | 539 | EXTRACT_PRIV_VIRTUAL = NO 540 | 541 | # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal 542 | # scope will be included in the documentation. 543 | # The default value is: NO. 544 | 545 | EXTRACT_PACKAGE = NO 546 | 547 | # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be 548 | # included in the documentation. 549 | # The default value is: NO. 550 | 551 | EXTRACT_STATIC = NO 552 | 553 | # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined 554 | # locally in source files will be included in the documentation. If set to NO, 555 | # only classes defined in header files are included. Does not have any effect 556 | # for Java sources. 557 | # The default value is: YES. 558 | 559 | EXTRACT_LOCAL_CLASSES = YES 560 | 561 | # This flag is only useful for Objective-C code. If set to YES, local methods, 562 | # which are defined in the implementation section but not in the interface are 563 | # included in the documentation. If set to NO, only methods in the interface are 564 | # included. 565 | # The default value is: NO. 566 | 567 | EXTRACT_LOCAL_METHODS = NO 568 | 569 | # If this flag is set to YES, the members of anonymous namespaces will be 570 | # extracted and appear in the documentation as a namespace called 571 | # 'anonymous_namespace{file}', where file will be replaced with the base name of 572 | # the file that contains the anonymous namespace. By default anonymous namespace 573 | # are hidden. 574 | # The default value is: NO. 575 | 576 | EXTRACT_ANON_NSPACES = NO 577 | 578 | # If this flag is set to YES, the name of an unnamed parameter in a declaration 579 | # will be determined by the corresponding definition. By default unnamed 580 | # parameters remain unnamed in the output. 581 | # The default value is: YES. 582 | 583 | RESOLVE_UNNAMED_PARAMS = YES 584 | 585 | # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all 586 | # undocumented members inside documented classes or files. If set to NO these 587 | # members will be included in the various overviews, but no documentation 588 | # section is generated. This option has no effect if EXTRACT_ALL is enabled. 589 | # The default value is: NO. 590 | 591 | HIDE_UNDOC_MEMBERS = NO 592 | 593 | # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all 594 | # undocumented classes that are normally visible in the class hierarchy. If set 595 | # to NO, these classes will be included in the various overviews. This option 596 | # will also hide undocumented C++ concepts if enabled. This option has no effect 597 | # if EXTRACT_ALL is enabled. 598 | # The default value is: NO. 599 | 600 | HIDE_UNDOC_CLASSES = NO 601 | 602 | # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend 603 | # declarations. If set to NO, these declarations will be included in the 604 | # documentation. 605 | # The default value is: NO. 606 | 607 | HIDE_FRIEND_COMPOUNDS = NO 608 | 609 | # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any 610 | # documentation blocks found inside the body of a function. If set to NO, these 611 | # blocks will be appended to the function's detailed documentation block. 612 | # The default value is: NO. 613 | 614 | HIDE_IN_BODY_DOCS = NO 615 | 616 | # The INTERNAL_DOCS tag determines if documentation that is typed after a 617 | # \internal command is included. If the tag is set to NO then the documentation 618 | # will be excluded. Set it to YES to include the internal documentation. 619 | # The default value is: NO. 620 | 621 | INTERNAL_DOCS = NO 622 | 623 | # With the correct setting of option CASE_SENSE_NAMES doxygen will better be 624 | # able to match the capabilities of the underlying filesystem. In case the 625 | # filesystem is case sensitive (i.e. it supports files in the same directory 626 | # whose names only differ in casing), the option must be set to YES to properly 627 | # deal with such files in case they appear in the input. For filesystems that 628 | # are not case sensitive the option should be set to NO to properly deal with 629 | # output files written for symbols that only differ in casing, such as for two 630 | # classes, one named CLASS and the other named Class, and to also support 631 | # references to files without having to specify the exact matching casing. On 632 | # Windows (including Cygwin) and MacOS, users should typically set this option 633 | # to NO, whereas on Linux or other Unix flavors it should typically be set to 634 | # YES. 635 | # Possible values are: SYSTEM, NO and YES. 636 | # The default value is: SYSTEM. 637 | 638 | CASE_SENSE_NAMES = SYSTEM 639 | 640 | # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with 641 | # their full class and namespace scopes in the documentation. If set to YES, the 642 | # scope will be hidden. 643 | # The default value is: NO. 644 | 645 | HIDE_SCOPE_NAMES = NO 646 | 647 | # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will 648 | # append additional text to a page's title, such as Class Reference. If set to 649 | # YES the compound reference will be hidden. 650 | # The default value is: NO. 651 | 652 | HIDE_COMPOUND_REFERENCE= NO 653 | 654 | # If the SHOW_HEADERFILE tag is set to YES then the documentation for a class 655 | # will show which file needs to be included to use the class. 656 | # The default value is: YES. 657 | 658 | SHOW_HEADERFILE = YES 659 | 660 | # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of 661 | # the files that are included by a file in the documentation of that file. 662 | # The default value is: YES. 663 | 664 | SHOW_INCLUDE_FILES = YES 665 | 666 | # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each 667 | # grouped member an include statement to the documentation, telling the reader 668 | # which file to include in order to use the member. 669 | # The default value is: NO. 670 | 671 | SHOW_GROUPED_MEMB_INC = NO 672 | 673 | # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include 674 | # files with double quotes in the documentation rather than with sharp brackets. 675 | # The default value is: NO. 676 | 677 | FORCE_LOCAL_INCLUDES = NO 678 | 679 | # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the 680 | # documentation for inline members. 681 | # The default value is: YES. 682 | 683 | INLINE_INFO = YES 684 | 685 | # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the 686 | # (detailed) documentation of file and class members alphabetically by member 687 | # name. If set to NO, the members will appear in declaration order. 688 | # The default value is: YES. 689 | 690 | SORT_MEMBER_DOCS = YES 691 | 692 | # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief 693 | # descriptions of file, namespace and class members alphabetically by member 694 | # name. If set to NO, the members will appear in declaration order. Note that 695 | # this will also influence the order of the classes in the class list. 696 | # The default value is: NO. 697 | 698 | SORT_BRIEF_DOCS = NO 699 | 700 | # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the 701 | # (brief and detailed) documentation of class members so that constructors and 702 | # destructors are listed first. If set to NO the constructors will appear in the 703 | # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. 704 | # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief 705 | # member documentation. 706 | # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting 707 | # detailed member documentation. 708 | # The default value is: NO. 709 | 710 | SORT_MEMBERS_CTORS_1ST = NO 711 | 712 | # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy 713 | # of group names into alphabetical order. If set to NO the group names will 714 | # appear in their defined order. 715 | # The default value is: NO. 716 | 717 | SORT_GROUP_NAMES = NO 718 | 719 | # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by 720 | # fully-qualified names, including namespaces. If set to NO, the class list will 721 | # be sorted only by class name, not including the namespace part. 722 | # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 723 | # Note: This option applies only to the class list, not to the alphabetical 724 | # list. 725 | # The default value is: NO. 726 | 727 | SORT_BY_SCOPE_NAME = NO 728 | 729 | # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper 730 | # type resolution of all parameters of a function it will reject a match between 731 | # the prototype and the implementation of a member function even if there is 732 | # only one candidate or it is obvious which candidate to choose by doing a 733 | # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still 734 | # accept a match between prototype and implementation in such cases. 735 | # The default value is: NO. 736 | 737 | STRICT_PROTO_MATCHING = NO 738 | 739 | # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo 740 | # list. This list is created by putting \todo commands in the documentation. 741 | # The default value is: YES. 742 | 743 | GENERATE_TODOLIST = YES 744 | 745 | # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test 746 | # list. This list is created by putting \test commands in the documentation. 747 | # The default value is: YES. 748 | 749 | GENERATE_TESTLIST = YES 750 | 751 | # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug 752 | # list. This list is created by putting \bug commands in the documentation. 753 | # The default value is: YES. 754 | 755 | GENERATE_BUGLIST = YES 756 | 757 | # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) 758 | # the deprecated list. This list is created by putting \deprecated commands in 759 | # the documentation. 760 | # The default value is: YES. 761 | 762 | GENERATE_DEPRECATEDLIST= YES 763 | 764 | # The ENABLED_SECTIONS tag can be used to enable conditional documentation 765 | # sections, marked by \if ... \endif and \cond 766 | # ... \endcond blocks. 767 | 768 | ENABLED_SECTIONS = 769 | 770 | # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the 771 | # initial value of a variable or macro / define can have for it to appear in the 772 | # documentation. If the initializer consists of more lines than specified here 773 | # it will be hidden. Use a value of 0 to hide initializers completely. The 774 | # appearance of the value of individual variables and macros / defines can be 775 | # controlled using \showinitializer or \hideinitializer command in the 776 | # documentation regardless of this setting. 777 | # Minimum value: 0, maximum value: 10000, default value: 30. 778 | 779 | MAX_INITIALIZER_LINES = 30 780 | 781 | # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at 782 | # the bottom of the documentation of classes and structs. If set to YES, the 783 | # list will mention the files that were used to generate the documentation. 784 | # The default value is: YES. 785 | 786 | SHOW_USED_FILES = YES 787 | 788 | # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This 789 | # will remove the Files entry from the Quick Index and from the Folder Tree View 790 | # (if specified). 791 | # The default value is: YES. 792 | 793 | SHOW_FILES = YES 794 | 795 | # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces 796 | # page. This will remove the Namespaces entry from the Quick Index and from the 797 | # Folder Tree View (if specified). 798 | # The default value is: YES. 799 | 800 | SHOW_NAMESPACES = YES 801 | 802 | # The FILE_VERSION_FILTER tag can be used to specify a program or script that 803 | # doxygen should invoke to get the current version for each file (typically from 804 | # the version control system). Doxygen will invoke the program by executing (via 805 | # popen()) the command command input-file, where command is the value of the 806 | # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided 807 | # by doxygen. Whatever the program writes to standard output is used as the file 808 | # version. For an example see the documentation. 809 | 810 | FILE_VERSION_FILTER = 811 | 812 | # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed 813 | # by doxygen. The layout file controls the global structure of the generated 814 | # output files in an output format independent way. To create the layout file 815 | # that represents doxygen's defaults, run doxygen with the -l option. You can 816 | # optionally specify a file name after the option, if omitted DoxygenLayout.xml 817 | # will be used as the name of the layout file. See also section "Changing the 818 | # layout of pages" for information. 819 | # 820 | # Note that if you run doxygen from a directory containing a file called 821 | # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE 822 | # tag is left empty. 823 | 824 | LAYOUT_FILE = 825 | 826 | # The CITE_BIB_FILES tag can be used to specify one or more bib files containing 827 | # the reference definitions. This must be a list of .bib files. The .bib 828 | # extension is automatically appended if omitted. This requires the bibtex tool 829 | # to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. 830 | # For LaTeX the style of the bibliography can be controlled using 831 | # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the 832 | # search path. See also \cite for info how to create references. 833 | 834 | CITE_BIB_FILES = 835 | 836 | #--------------------------------------------------------------------------- 837 | # Configuration options related to warning and progress messages 838 | #--------------------------------------------------------------------------- 839 | 840 | # The QUIET tag can be used to turn on/off the messages that are generated to 841 | # standard output by doxygen. If QUIET is set to YES this implies that the 842 | # messages are off. 843 | # The default value is: NO. 844 | 845 | QUIET = NO 846 | 847 | # The WARNINGS tag can be used to turn on/off the warning messages that are 848 | # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES 849 | # this implies that the warnings are on. 850 | # 851 | # Tip: Turn warnings on while writing the documentation. 852 | # The default value is: YES. 853 | 854 | WARNINGS = YES 855 | 856 | # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate 857 | # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag 858 | # will automatically be disabled. 859 | # The default value is: YES. 860 | 861 | WARN_IF_UNDOCUMENTED = YES 862 | 863 | # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for 864 | # potential errors in the documentation, such as documenting some parameters in 865 | # a documented function twice, or documenting parameters that don't exist or 866 | # using markup commands wrongly. 867 | # The default value is: YES. 868 | 869 | WARN_IF_DOC_ERROR = YES 870 | 871 | # If WARN_IF_INCOMPLETE_DOC is set to YES, doxygen will warn about incomplete 872 | # function parameter documentation. If set to NO, doxygen will accept that some 873 | # parameters have no documentation without warning. 874 | # The default value is: YES. 875 | 876 | WARN_IF_INCOMPLETE_DOC = YES 877 | 878 | # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that 879 | # are documented, but have no documentation for their parameters or return 880 | # value. If set to NO, doxygen will only warn about wrong parameter 881 | # documentation, but not about the absence of documentation. If EXTRACT_ALL is 882 | # set to YES then this flag will automatically be disabled. See also 883 | # WARN_IF_INCOMPLETE_DOC 884 | # The default value is: NO. 885 | 886 | WARN_NO_PARAMDOC = NO 887 | 888 | # If WARN_IF_UNDOC_ENUM_VAL option is set to YES, doxygen will warn about 889 | # undocumented enumeration values. If set to NO, doxygen will accept 890 | # undocumented enumeration values. If EXTRACT_ALL is set to YES then this flag 891 | # will automatically be disabled. 892 | # The default value is: NO. 893 | 894 | WARN_IF_UNDOC_ENUM_VAL = NO 895 | 896 | # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when 897 | # a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS 898 | # then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but 899 | # at the end of the doxygen process doxygen will return with a non-zero status. 900 | # If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS_PRINT then doxygen behaves 901 | # like FAIL_ON_WARNINGS but in case no WARN_LOGFILE is defined doxygen will not 902 | # write the warning messages in between other messages but write them at the end 903 | # of a run, in case a WARN_LOGFILE is defined the warning messages will be 904 | # besides being in the defined file also be shown at the end of a run, unless 905 | # the WARN_LOGFILE is defined as - i.e. standard output (stdout) in that case 906 | # the behavior will remain as with the setting FAIL_ON_WARNINGS. 907 | # Possible values are: NO, YES, FAIL_ON_WARNINGS and FAIL_ON_WARNINGS_PRINT. 908 | # The default value is: NO. 909 | 910 | WARN_AS_ERROR = NO 911 | 912 | # The WARN_FORMAT tag determines the format of the warning messages that doxygen 913 | # can produce. The string should contain the $file, $line, and $text tags, which 914 | # will be replaced by the file and line number from which the warning originated 915 | # and the warning text. Optionally the format may contain $version, which will 916 | # be replaced by the version of the file (if it could be obtained via 917 | # FILE_VERSION_FILTER) 918 | # See also: WARN_LINE_FORMAT 919 | # The default value is: $file:$line: $text. 920 | 921 | WARN_FORMAT = "$file:$line: $text" 922 | 923 | # In the $text part of the WARN_FORMAT command it is possible that a reference 924 | # to a more specific place is given. To make it easier to jump to this place 925 | # (outside of doxygen) the user can define a custom "cut" / "paste" string. 926 | # Example: 927 | # WARN_LINE_FORMAT = "'vi $file +$line'" 928 | # See also: WARN_FORMAT 929 | # The default value is: at line $line of file $file. 930 | 931 | WARN_LINE_FORMAT = "at line $line of file $file" 932 | 933 | # The WARN_LOGFILE tag can be used to specify a file to which warning and error 934 | # messages should be written. If left blank the output is written to standard 935 | # error (stderr). In case the file specified cannot be opened for writing the 936 | # warning and error messages are written to standard error. When as file - is 937 | # specified the warning and error messages are written to standard output 938 | # (stdout). 939 | 940 | WARN_LOGFILE = 941 | 942 | #--------------------------------------------------------------------------- 943 | # Configuration options related to the input files 944 | #--------------------------------------------------------------------------- 945 | 946 | # The INPUT tag is used to specify the files and/or directories that contain 947 | # documented source files. You may enter file names like myfile.cpp or 948 | # directories like /usr/src/myproject. Separate the files or directories with 949 | # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING 950 | # Note: If this tag is empty the current directory is searched. 951 | 952 | INPUT = mainpage.md remodule.h remodule_monitor.h 953 | 954 | # This tag can be used to specify the character encoding of the source files 955 | # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses 956 | # libiconv (or the iconv built into libc) for the transcoding. See the libiconv 957 | # documentation (see: 958 | # https://www.gnu.org/software/libiconv/) for the list of possible encodings. 959 | # See also: INPUT_FILE_ENCODING 960 | # The default value is: UTF-8. 961 | 962 | INPUT_ENCODING = UTF-8 963 | 964 | # This tag can be used to specify the character encoding of the source files 965 | # that doxygen parses The INPUT_FILE_ENCODING tag can be used to specify 966 | # character encoding on a per file pattern basis. Doxygen will compare the file 967 | # name with each pattern and apply the encoding instead of the default 968 | # INPUT_ENCODING) if there is a match. The character encodings are a list of the 969 | # form: pattern=encoding (like *.php=ISO-8859-1). See cfg_input_encoding 970 | # "INPUT_ENCODING" for further information on supported encodings. 971 | 972 | INPUT_FILE_ENCODING = 973 | 974 | # If the value of the INPUT tag contains directories, you can use the 975 | # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and 976 | # *.h) to filter out the source-files in the directories. 977 | # 978 | # Note that for custom extensions or not directly supported extensions you also 979 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not 980 | # read by doxygen. 981 | # 982 | # Note the list of default checked file patterns might differ from the list of 983 | # default file extension mappings. 984 | # 985 | # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cxxm, 986 | # *.cpp, *.cppm, *.ccm, *.c++, *.c++m, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, 987 | # *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, *.h++, *.ixx, *.l, *.cs, *.d, 988 | # *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to 989 | # be provided as doxygen C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, 990 | # *.f18, *.f, *.for, *.vhd, *.vhdl, *.ucf, *.qsf and *.ice. 991 | 992 | FILE_PATTERNS = *.c \ 993 | *.cc \ 994 | *.cxx \ 995 | *.cxxm \ 996 | *.cpp \ 997 | *.cppm \ 998 | *.ccm \ 999 | *.c++ \ 1000 | *.c++m \ 1001 | *.java \ 1002 | *.ii \ 1003 | *.ixx \ 1004 | *.ipp \ 1005 | *.i++ \ 1006 | *.inl \ 1007 | *.idl \ 1008 | *.ddl \ 1009 | *.odl \ 1010 | *.h \ 1011 | *.hh \ 1012 | *.hxx \ 1013 | *.hpp \ 1014 | *.h++ \ 1015 | *.ixx \ 1016 | *.l \ 1017 | *.cs \ 1018 | *.d \ 1019 | *.php \ 1020 | *.php4 \ 1021 | *.php5 \ 1022 | *.phtml \ 1023 | *.inc \ 1024 | *.m \ 1025 | *.markdown \ 1026 | *.md \ 1027 | *.mm \ 1028 | *.dox \ 1029 | *.py \ 1030 | *.pyw \ 1031 | *.f90 \ 1032 | *.f95 \ 1033 | *.f03 \ 1034 | *.f08 \ 1035 | *.f18 \ 1036 | *.f \ 1037 | *.for \ 1038 | *.vhd \ 1039 | *.vhdl \ 1040 | *.ucf \ 1041 | *.qsf \ 1042 | *.ice 1043 | 1044 | # The RECURSIVE tag can be used to specify whether or not subdirectories should 1045 | # be searched for input files as well. 1046 | # The default value is: NO. 1047 | 1048 | RECURSIVE = NO 1049 | 1050 | # The EXCLUDE tag can be used to specify files and/or directories that should be 1051 | # excluded from the INPUT source files. This way you can easily exclude a 1052 | # subdirectory from a directory tree whose root is specified with the INPUT tag. 1053 | # 1054 | # Note that relative paths are relative to the directory from which doxygen is 1055 | # run. 1056 | 1057 | EXCLUDE = 1058 | 1059 | # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or 1060 | # directories that are symbolic links (a Unix file system feature) are excluded 1061 | # from the input. 1062 | # The default value is: NO. 1063 | 1064 | EXCLUDE_SYMLINKS = NO 1065 | 1066 | # If the value of the INPUT tag contains directories, you can use the 1067 | # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 1068 | # certain files from those directories. 1069 | # 1070 | # Note that the wildcards are matched against the file with absolute path, so to 1071 | # exclude all test directories for example use the pattern */test/* 1072 | 1073 | EXCLUDE_PATTERNS = 1074 | 1075 | # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 1076 | # (namespaces, classes, functions, etc.) that should be excluded from the 1077 | # output. The symbol name can be a fully qualified name, a word, or if the 1078 | # wildcard * is used, a substring. Examples: ANamespace, AClass, 1079 | # ANamespace::AClass, ANamespace::*Test 1080 | 1081 | EXCLUDE_SYMBOLS = 1082 | 1083 | # The EXAMPLE_PATH tag can be used to specify one or more files or directories 1084 | # that contain example code fragments that are included (see the \include 1085 | # command). 1086 | 1087 | EXAMPLE_PATH = . 1088 | 1089 | # If the value of the EXAMPLE_PATH tag contains directories, you can use the 1090 | # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and 1091 | # *.h) to filter out the source-files in the directories. If left blank all 1092 | # files are included. 1093 | 1094 | EXAMPLE_PATTERNS = * 1095 | 1096 | # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 1097 | # searched for input files to be used with the \include or \dontinclude commands 1098 | # irrespective of the value of the RECURSIVE tag. 1099 | # The default value is: NO. 1100 | 1101 | EXAMPLE_RECURSIVE = NO 1102 | 1103 | # The IMAGE_PATH tag can be used to specify one or more files or directories 1104 | # that contain images that are to be included in the documentation (see the 1105 | # \image command). 1106 | 1107 | IMAGE_PATH = 1108 | 1109 | # The INPUT_FILTER tag can be used to specify a program that doxygen should 1110 | # invoke to filter for each input file. Doxygen will invoke the filter program 1111 | # by executing (via popen()) the command: 1112 | # 1113 | # 1114 | # 1115 | # where is the value of the INPUT_FILTER tag, and is the 1116 | # name of an input file. Doxygen will then use the output that the filter 1117 | # program writes to standard output. If FILTER_PATTERNS is specified, this tag 1118 | # will be ignored. 1119 | # 1120 | # Note that the filter must not add or remove lines; it is applied before the 1121 | # code is scanned, but not when the output code is generated. If lines are added 1122 | # or removed, the anchors will not be placed correctly. 1123 | # 1124 | # Note that doxygen will use the data processed and written to standard output 1125 | # for further processing, therefore nothing else, like debug statements or used 1126 | # commands (so in case of a Windows batch file always use @echo OFF), should be 1127 | # written to standard output. 1128 | # 1129 | # Note that for custom extensions or not directly supported extensions you also 1130 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not 1131 | # properly processed by doxygen. 1132 | 1133 | INPUT_FILTER = 1134 | 1135 | # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 1136 | # basis. Doxygen will compare the file name with each pattern and apply the 1137 | # filter if there is a match. The filters are a list of the form: pattern=filter 1138 | # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how 1139 | # filters are used. If the FILTER_PATTERNS tag is empty or if none of the 1140 | # patterns match the file name, INPUT_FILTER is applied. 1141 | # 1142 | # Note that for custom extensions or not directly supported extensions you also 1143 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not 1144 | # properly processed by doxygen. 1145 | 1146 | FILTER_PATTERNS = 1147 | 1148 | # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 1149 | # INPUT_FILTER) will also be used to filter the input files that are used for 1150 | # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). 1151 | # The default value is: NO. 1152 | 1153 | FILTER_SOURCE_FILES = NO 1154 | 1155 | # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file 1156 | # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and 1157 | # it is also possible to disable source filtering for a specific pattern using 1158 | # *.ext= (so without naming a filter). 1159 | # This tag requires that the tag FILTER_SOURCE_FILES is set to YES. 1160 | 1161 | FILTER_SOURCE_PATTERNS = 1162 | 1163 | # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that 1164 | # is part of the input, its contents will be placed on the main page 1165 | # (index.html). This can be useful if you have a project on for instance GitHub 1166 | # and want to reuse the introduction page also for the doxygen output. 1167 | 1168 | USE_MDFILE_AS_MAINPAGE = mainpage.md 1169 | 1170 | # The Fortran standard specifies that for fixed formatted Fortran code all 1171 | # characters from position 72 are to be considered as comment. A common 1172 | # extension is to allow longer lines before the automatic comment starts. The 1173 | # setting FORTRAN_COMMENT_AFTER will also make it possible that longer lines can 1174 | # be processed before the automatic comment starts. 1175 | # Minimum value: 7, maximum value: 10000, default value: 72. 1176 | 1177 | FORTRAN_COMMENT_AFTER = 72 1178 | 1179 | #--------------------------------------------------------------------------- 1180 | # Configuration options related to source browsing 1181 | #--------------------------------------------------------------------------- 1182 | 1183 | # If the SOURCE_BROWSER tag is set to YES then a list of source files will be 1184 | # generated. Documented entities will be cross-referenced with these sources. 1185 | # 1186 | # Note: To get rid of all source code in the generated output, make sure that 1187 | # also VERBATIM_HEADERS is set to NO. 1188 | # The default value is: NO. 1189 | 1190 | SOURCE_BROWSER = NO 1191 | 1192 | # Setting the INLINE_SOURCES tag to YES will include the body of functions, 1193 | # multi-line macros, enums or list initialized variables directly into the 1194 | # documentation. 1195 | # The default value is: NO. 1196 | 1197 | INLINE_SOURCES = NO 1198 | 1199 | # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any 1200 | # special comment blocks from generated source code fragments. Normal C, C++ and 1201 | # Fortran comments will always remain visible. 1202 | # The default value is: YES. 1203 | 1204 | STRIP_CODE_COMMENTS = YES 1205 | 1206 | # If the REFERENCED_BY_RELATION tag is set to YES then for each documented 1207 | # entity all documented functions referencing it will be listed. 1208 | # The default value is: NO. 1209 | 1210 | REFERENCED_BY_RELATION = NO 1211 | 1212 | # If the REFERENCES_RELATION tag is set to YES then for each documented function 1213 | # all documented entities called/used by that function will be listed. 1214 | # The default value is: NO. 1215 | 1216 | REFERENCES_RELATION = NO 1217 | 1218 | # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set 1219 | # to YES then the hyperlinks from functions in REFERENCES_RELATION and 1220 | # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will 1221 | # link to the documentation. 1222 | # The default value is: YES. 1223 | 1224 | REFERENCES_LINK_SOURCE = YES 1225 | 1226 | # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the 1227 | # source code will show a tooltip with additional information such as prototype, 1228 | # brief description and links to the definition and documentation. Since this 1229 | # will make the HTML file larger and loading of large files a bit slower, you 1230 | # can opt to disable this feature. 1231 | # The default value is: YES. 1232 | # This tag requires that the tag SOURCE_BROWSER is set to YES. 1233 | 1234 | SOURCE_TOOLTIPS = YES 1235 | 1236 | # If the USE_HTAGS tag is set to YES then the references to source code will 1237 | # point to the HTML generated by the htags(1) tool instead of doxygen built-in 1238 | # source browser. The htags tool is part of GNU's global source tagging system 1239 | # (see https://www.gnu.org/software/global/global.html). You will need version 1240 | # 4.8.6 or higher. 1241 | # 1242 | # To use it do the following: 1243 | # - Install the latest version of global 1244 | # - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file 1245 | # - Make sure the INPUT points to the root of the source tree 1246 | # - Run doxygen as normal 1247 | # 1248 | # Doxygen will invoke htags (and that will in turn invoke gtags), so these 1249 | # tools must be available from the command line (i.e. in the search path). 1250 | # 1251 | # The result: instead of the source browser generated by doxygen, the links to 1252 | # source code will now point to the output of htags. 1253 | # The default value is: NO. 1254 | # This tag requires that the tag SOURCE_BROWSER is set to YES. 1255 | 1256 | USE_HTAGS = NO 1257 | 1258 | # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a 1259 | # verbatim copy of the header file for each class for which an include is 1260 | # specified. Set to NO to disable this. 1261 | # See also: Section \class. 1262 | # The default value is: YES. 1263 | 1264 | VERBATIM_HEADERS = YES 1265 | 1266 | #--------------------------------------------------------------------------- 1267 | # Configuration options related to the alphabetical class index 1268 | #--------------------------------------------------------------------------- 1269 | 1270 | # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all 1271 | # compounds will be generated. Enable this if the project contains a lot of 1272 | # classes, structs, unions or interfaces. 1273 | # The default value is: YES. 1274 | 1275 | ALPHABETICAL_INDEX = YES 1276 | 1277 | # The IGNORE_PREFIX tag can be used to specify a prefix (or a list of prefixes) 1278 | # that should be ignored while generating the index headers. The IGNORE_PREFIX 1279 | # tag works for classes, function and member names. The entity will be placed in 1280 | # the alphabetical list under the first letter of the entity name that remains 1281 | # after removing the prefix. 1282 | # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1283 | 1284 | IGNORE_PREFIX = 1285 | 1286 | #--------------------------------------------------------------------------- 1287 | # Configuration options related to the HTML output 1288 | #--------------------------------------------------------------------------- 1289 | 1290 | # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output 1291 | # The default value is: YES. 1292 | 1293 | GENERATE_HTML = YES 1294 | 1295 | # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a 1296 | # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1297 | # it. 1298 | # The default directory is: html. 1299 | # This tag requires that the tag GENERATE_HTML is set to YES. 1300 | 1301 | HTML_OUTPUT = . 1302 | 1303 | # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each 1304 | # generated HTML page (for example: .htm, .php, .asp). 1305 | # The default value is: .html. 1306 | # This tag requires that the tag GENERATE_HTML is set to YES. 1307 | 1308 | HTML_FILE_EXTENSION = .html 1309 | 1310 | # The HTML_HEADER tag can be used to specify a user-defined HTML header file for 1311 | # each generated HTML page. If the tag is left blank doxygen will generate a 1312 | # standard header. 1313 | # 1314 | # To get valid HTML the header file that includes any scripts and style sheets 1315 | # that doxygen needs, which is dependent on the configuration options used (e.g. 1316 | # the setting GENERATE_TREEVIEW). It is highly recommended to start with a 1317 | # default header using 1318 | # doxygen -w html new_header.html new_footer.html new_stylesheet.css 1319 | # YourConfigFile 1320 | # and then modify the file new_header.html. See also section "Doxygen usage" 1321 | # for information on how to generate the default header that doxygen normally 1322 | # uses. 1323 | # Note: The header is subject to change so you typically have to regenerate the 1324 | # default header when upgrading to a newer version of doxygen. For a description 1325 | # of the possible markers and block names see the documentation. 1326 | # This tag requires that the tag GENERATE_HTML is set to YES. 1327 | 1328 | HTML_HEADER = 1329 | 1330 | # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each 1331 | # generated HTML page. If the tag is left blank doxygen will generate a standard 1332 | # footer. See HTML_HEADER for more information on how to generate a default 1333 | # footer and what special commands can be used inside the footer. See also 1334 | # section "Doxygen usage" for information on how to generate the default footer 1335 | # that doxygen normally uses. 1336 | # This tag requires that the tag GENERATE_HTML is set to YES. 1337 | 1338 | HTML_FOOTER = 1339 | 1340 | # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style 1341 | # sheet that is used by each HTML page. It can be used to fine-tune the look of 1342 | # the HTML output. If left blank doxygen will generate a default style sheet. 1343 | # See also section "Doxygen usage" for information on how to generate the style 1344 | # sheet that doxygen normally uses. 1345 | # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as 1346 | # it is more robust and this tag (HTML_STYLESHEET) will in the future become 1347 | # obsolete. 1348 | # This tag requires that the tag GENERATE_HTML is set to YES. 1349 | 1350 | HTML_STYLESHEET = 1351 | 1352 | # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined 1353 | # cascading style sheets that are included after the standard style sheets 1354 | # created by doxygen. Using this option one can overrule certain style aspects. 1355 | # This is preferred over using HTML_STYLESHEET since it does not replace the 1356 | # standard style sheet and is therefore more robust against future updates. 1357 | # Doxygen will copy the style sheet files to the output directory. 1358 | # Note: The order of the extra style sheet files is of importance (e.g. the last 1359 | # style sheet in the list overrules the setting of the previous ones in the 1360 | # list). 1361 | # Note: Since the styling of scrollbars can currently not be overruled in 1362 | # Webkit/Chromium, the styling will be left out of the default doxygen.css if 1363 | # one or more extra stylesheets have been specified. So if scrollbar 1364 | # customization is desired it has to be added explicitly. For an example see the 1365 | # documentation. 1366 | # This tag requires that the tag GENERATE_HTML is set to YES. 1367 | 1368 | HTML_EXTRA_STYLESHEET = 1369 | 1370 | # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or 1371 | # other source files which should be copied to the HTML output directory. Note 1372 | # that these files will be copied to the base HTML output directory. Use the 1373 | # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these 1374 | # files. In the HTML_STYLESHEET file, use the file name only. Also note that the 1375 | # files will be copied as-is; there are no commands or markers available. 1376 | # This tag requires that the tag GENERATE_HTML is set to YES. 1377 | 1378 | HTML_EXTRA_FILES = 1379 | 1380 | # The HTML_COLORSTYLE tag can be used to specify if the generated HTML output 1381 | # should be rendered with a dark or light theme. 1382 | # Possible values are: LIGHT always generate light mode output, DARK always 1383 | # generate dark mode output, AUTO_LIGHT automatically set the mode according to 1384 | # the user preference, use light mode if no preference is set (the default), 1385 | # AUTO_DARK automatically set the mode according to the user preference, use 1386 | # dark mode if no preference is set and TOGGLE allow to user to switch between 1387 | # light and dark mode via a button. 1388 | # The default value is: AUTO_LIGHT. 1389 | # This tag requires that the tag GENERATE_HTML is set to YES. 1390 | 1391 | HTML_COLORSTYLE = AUTO_LIGHT 1392 | 1393 | # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen 1394 | # will adjust the colors in the style sheet and background images according to 1395 | # this color. Hue is specified as an angle on a color-wheel, see 1396 | # https://en.wikipedia.org/wiki/Hue for more information. For instance the value 1397 | # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 1398 | # purple, and 360 is red again. 1399 | # Minimum value: 0, maximum value: 359, default value: 220. 1400 | # This tag requires that the tag GENERATE_HTML is set to YES. 1401 | 1402 | HTML_COLORSTYLE_HUE = 220 1403 | 1404 | # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors 1405 | # in the HTML output. For a value of 0 the output will use gray-scales only. A 1406 | # value of 255 will produce the most vivid colors. 1407 | # Minimum value: 0, maximum value: 255, default value: 100. 1408 | # This tag requires that the tag GENERATE_HTML is set to YES. 1409 | 1410 | HTML_COLORSTYLE_SAT = 100 1411 | 1412 | # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the 1413 | # luminance component of the colors in the HTML output. Values below 100 1414 | # gradually make the output lighter, whereas values above 100 make the output 1415 | # darker. The value divided by 100 is the actual gamma applied, so 80 represents 1416 | # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not 1417 | # change the gamma. 1418 | # Minimum value: 40, maximum value: 240, default value: 80. 1419 | # This tag requires that the tag GENERATE_HTML is set to YES. 1420 | 1421 | HTML_COLORSTYLE_GAMMA = 80 1422 | 1423 | # If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML 1424 | # documentation will contain a main index with vertical navigation menus that 1425 | # are dynamically created via JavaScript. If disabled, the navigation index will 1426 | # consists of multiple levels of tabs that are statically embedded in every HTML 1427 | # page. Disable this option to support browsers that do not have JavaScript, 1428 | # like the Qt help browser. 1429 | # The default value is: YES. 1430 | # This tag requires that the tag GENERATE_HTML is set to YES. 1431 | 1432 | HTML_DYNAMIC_MENUS = YES 1433 | 1434 | # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 1435 | # documentation will contain sections that can be hidden and shown after the 1436 | # page has loaded. 1437 | # The default value is: NO. 1438 | # This tag requires that the tag GENERATE_HTML is set to YES. 1439 | 1440 | HTML_DYNAMIC_SECTIONS = NO 1441 | 1442 | # If the HTML_CODE_FOLDING tag is set to YES then classes and functions can be 1443 | # dynamically folded and expanded in the generated HTML source code. 1444 | # The default value is: YES. 1445 | # This tag requires that the tag GENERATE_HTML is set to YES. 1446 | 1447 | HTML_CODE_FOLDING = YES 1448 | 1449 | # If the HTML_COPY_CLIPBOARD tag is set to YES then doxygen will show an icon in 1450 | # the top right corner of code and text fragments that allows the user to copy 1451 | # its content to the clipboard. Note this only works if supported by the browser 1452 | # and the web page is served via a secure context (see: 1453 | # https://www.w3.org/TR/secure-contexts/), i.e. using the https: or file: 1454 | # protocol. 1455 | # The default value is: YES. 1456 | # This tag requires that the tag GENERATE_HTML is set to YES. 1457 | 1458 | HTML_COPY_CLIPBOARD = YES 1459 | 1460 | # Doxygen stores a couple of settings persistently in the browser (via e.g. 1461 | # cookies). By default these settings apply to all HTML pages generated by 1462 | # doxygen across all projects. The HTML_PROJECT_COOKIE tag can be used to store 1463 | # the settings under a project specific key, such that the user preferences will 1464 | # be stored separately. 1465 | # This tag requires that the tag GENERATE_HTML is set to YES. 1466 | 1467 | HTML_PROJECT_COOKIE = 1468 | 1469 | # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries 1470 | # shown in the various tree structured indices initially; the user can expand 1471 | # and collapse entries dynamically later on. Doxygen will expand the tree to 1472 | # such a level that at most the specified number of entries are visible (unless 1473 | # a fully collapsed tree already exceeds this amount). So setting the number of 1474 | # entries 1 will produce a full collapsed tree by default. 0 is a special value 1475 | # representing an infinite number of entries and will result in a full expanded 1476 | # tree by default. 1477 | # Minimum value: 0, maximum value: 9999, default value: 100. 1478 | # This tag requires that the tag GENERATE_HTML is set to YES. 1479 | 1480 | HTML_INDEX_NUM_ENTRIES = 100 1481 | 1482 | # If the GENERATE_DOCSET tag is set to YES, additional index files will be 1483 | # generated that can be used as input for Apple's Xcode 3 integrated development 1484 | # environment (see: 1485 | # https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To 1486 | # create a documentation set, doxygen will generate a Makefile in the HTML 1487 | # output directory. Running make will produce the docset in that directory and 1488 | # running make install will install the docset in 1489 | # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at 1490 | # startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy 1491 | # genXcode/_index.html for more information. 1492 | # The default value is: NO. 1493 | # This tag requires that the tag GENERATE_HTML is set to YES. 1494 | 1495 | GENERATE_DOCSET = NO 1496 | 1497 | # This tag determines the name of the docset feed. A documentation feed provides 1498 | # an umbrella under which multiple documentation sets from a single provider 1499 | # (such as a company or product suite) can be grouped. 1500 | # The default value is: Doxygen generated docs. 1501 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1502 | 1503 | DOCSET_FEEDNAME = "Doxygen generated docs" 1504 | 1505 | # This tag determines the URL of the docset feed. A documentation feed provides 1506 | # an umbrella under which multiple documentation sets from a single provider 1507 | # (such as a company or product suite) can be grouped. 1508 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1509 | 1510 | DOCSET_FEEDURL = 1511 | 1512 | # This tag specifies a string that should uniquely identify the documentation 1513 | # set bundle. This should be a reverse domain-name style string, e.g. 1514 | # com.mycompany.MyDocSet. Doxygen will append .docset to the name. 1515 | # The default value is: org.doxygen.Project. 1516 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1517 | 1518 | DOCSET_BUNDLE_ID = org.doxygen.Project 1519 | 1520 | # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify 1521 | # the documentation publisher. This should be a reverse domain-name style 1522 | # string, e.g. com.mycompany.MyDocSet.documentation. 1523 | # The default value is: org.doxygen.Publisher. 1524 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1525 | 1526 | DOCSET_PUBLISHER_ID = org.doxygen.Publisher 1527 | 1528 | # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. 1529 | # The default value is: Publisher. 1530 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1531 | 1532 | DOCSET_PUBLISHER_NAME = Publisher 1533 | 1534 | # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three 1535 | # additional HTML index files: index.hhp, index.hhc, and index.hhk. The 1536 | # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop 1537 | # on Windows. In the beginning of 2021 Microsoft took the original page, with 1538 | # a.o. the download links, offline the HTML help workshop was already many years 1539 | # in maintenance mode). You can download the HTML help workshop from the web 1540 | # archives at Installation executable (see: 1541 | # http://web.archive.org/web/20160201063255/http://download.microsoft.com/downlo 1542 | # ad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe). 1543 | # 1544 | # The HTML Help Workshop contains a compiler that can convert all HTML output 1545 | # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML 1546 | # files are now used as the Windows 98 help format, and will replace the old 1547 | # Windows help format (.hlp) on all Windows platforms in the future. Compressed 1548 | # HTML files also contain an index, a table of contents, and you can search for 1549 | # words in the documentation. The HTML workshop also contains a viewer for 1550 | # compressed HTML files. 1551 | # The default value is: NO. 1552 | # This tag requires that the tag GENERATE_HTML is set to YES. 1553 | 1554 | GENERATE_HTMLHELP = NO 1555 | 1556 | # The CHM_FILE tag can be used to specify the file name of the resulting .chm 1557 | # file. You can add a path in front of the file if the result should not be 1558 | # written to the html output directory. 1559 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1560 | 1561 | CHM_FILE = 1562 | 1563 | # The HHC_LOCATION tag can be used to specify the location (absolute path 1564 | # including file name) of the HTML help compiler (hhc.exe). If non-empty, 1565 | # doxygen will try to run the HTML help compiler on the generated index.hhp. 1566 | # The file has to be specified with full path. 1567 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1568 | 1569 | HHC_LOCATION = 1570 | 1571 | # The GENERATE_CHI flag controls if a separate .chi index file is generated 1572 | # (YES) or that it should be included in the main .chm file (NO). 1573 | # The default value is: NO. 1574 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1575 | 1576 | GENERATE_CHI = NO 1577 | 1578 | # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) 1579 | # and project file content. 1580 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1581 | 1582 | CHM_INDEX_ENCODING = 1583 | 1584 | # The BINARY_TOC flag controls whether a binary table of contents is generated 1585 | # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it 1586 | # enables the Previous and Next buttons. 1587 | # The default value is: NO. 1588 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1589 | 1590 | BINARY_TOC = NO 1591 | 1592 | # The TOC_EXPAND flag can be set to YES to add extra items for group members to 1593 | # the table of contents of the HTML help documentation and to the tree view. 1594 | # The default value is: NO. 1595 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1596 | 1597 | TOC_EXPAND = NO 1598 | 1599 | # The SITEMAP_URL tag is used to specify the full URL of the place where the 1600 | # generated documentation will be placed on the server by the user during the 1601 | # deployment of the documentation. The generated sitemap is called sitemap.xml 1602 | # and placed on the directory specified by HTML_OUTPUT. In case no SITEMAP_URL 1603 | # is specified no sitemap is generated. For information about the sitemap 1604 | # protocol see https://www.sitemaps.org 1605 | # This tag requires that the tag GENERATE_HTML is set to YES. 1606 | 1607 | SITEMAP_URL = 1608 | 1609 | # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and 1610 | # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that 1611 | # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help 1612 | # (.qch) of the generated HTML documentation. 1613 | # The default value is: NO. 1614 | # This tag requires that the tag GENERATE_HTML is set to YES. 1615 | 1616 | GENERATE_QHP = NO 1617 | 1618 | # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify 1619 | # the file name of the resulting .qch file. The path specified is relative to 1620 | # the HTML output folder. 1621 | # This tag requires that the tag GENERATE_QHP is set to YES. 1622 | 1623 | QCH_FILE = 1624 | 1625 | # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help 1626 | # Project output. For more information please see Qt Help Project / Namespace 1627 | # (see: 1628 | # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). 1629 | # The default value is: org.doxygen.Project. 1630 | # This tag requires that the tag GENERATE_QHP is set to YES. 1631 | 1632 | QHP_NAMESPACE = org.doxygen.Project 1633 | 1634 | # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt 1635 | # Help Project output. For more information please see Qt Help Project / Virtual 1636 | # Folders (see: 1637 | # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders). 1638 | # The default value is: doc. 1639 | # This tag requires that the tag GENERATE_QHP is set to YES. 1640 | 1641 | QHP_VIRTUAL_FOLDER = doc 1642 | 1643 | # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom 1644 | # filter to add. For more information please see Qt Help Project / Custom 1645 | # Filters (see: 1646 | # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). 1647 | # This tag requires that the tag GENERATE_QHP is set to YES. 1648 | 1649 | QHP_CUST_FILTER_NAME = 1650 | 1651 | # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the 1652 | # custom filter to add. For more information please see Qt Help Project / Custom 1653 | # Filters (see: 1654 | # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). 1655 | # This tag requires that the tag GENERATE_QHP is set to YES. 1656 | 1657 | QHP_CUST_FILTER_ATTRS = 1658 | 1659 | # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this 1660 | # project's filter section matches. Qt Help Project / Filter Attributes (see: 1661 | # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). 1662 | # This tag requires that the tag GENERATE_QHP is set to YES. 1663 | 1664 | QHP_SECT_FILTER_ATTRS = 1665 | 1666 | # The QHG_LOCATION tag can be used to specify the location (absolute path 1667 | # including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to 1668 | # run qhelpgenerator on the generated .qhp file. 1669 | # This tag requires that the tag GENERATE_QHP is set to YES. 1670 | 1671 | QHG_LOCATION = 1672 | 1673 | # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be 1674 | # generated, together with the HTML files, they form an Eclipse help plugin. To 1675 | # install this plugin and make it available under the help contents menu in 1676 | # Eclipse, the contents of the directory containing the HTML and XML files needs 1677 | # to be copied into the plugins directory of eclipse. The name of the directory 1678 | # within the plugins directory should be the same as the ECLIPSE_DOC_ID value. 1679 | # After copying Eclipse needs to be restarted before the help appears. 1680 | # The default value is: NO. 1681 | # This tag requires that the tag GENERATE_HTML is set to YES. 1682 | 1683 | GENERATE_ECLIPSEHELP = NO 1684 | 1685 | # A unique identifier for the Eclipse help plugin. When installing the plugin 1686 | # the directory name containing the HTML and XML files should also have this 1687 | # name. Each documentation set should have its own identifier. 1688 | # The default value is: org.doxygen.Project. 1689 | # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. 1690 | 1691 | ECLIPSE_DOC_ID = org.doxygen.Project 1692 | 1693 | # If you want full control over the layout of the generated HTML pages it might 1694 | # be necessary to disable the index and replace it with your own. The 1695 | # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top 1696 | # of each HTML page. A value of NO enables the index and the value YES disables 1697 | # it. Since the tabs in the index contain the same information as the navigation 1698 | # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. 1699 | # The default value is: NO. 1700 | # This tag requires that the tag GENERATE_HTML is set to YES. 1701 | 1702 | DISABLE_INDEX = NO 1703 | 1704 | # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 1705 | # structure should be generated to display hierarchical information. If the tag 1706 | # value is set to YES, a side panel will be generated containing a tree-like 1707 | # index structure (just like the one that is generated for HTML Help). For this 1708 | # to work a browser that supports JavaScript, DHTML, CSS and frames is required 1709 | # (i.e. any modern browser). Windows users are probably better off using the 1710 | # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can 1711 | # further fine tune the look of the index (see "Fine-tuning the output"). As an 1712 | # example, the default style sheet generated by doxygen has an example that 1713 | # shows how to put an image at the root of the tree instead of the PROJECT_NAME. 1714 | # Since the tree basically has the same information as the tab index, you could 1715 | # consider setting DISABLE_INDEX to YES when enabling this option. 1716 | # The default value is: NO. 1717 | # This tag requires that the tag GENERATE_HTML is set to YES. 1718 | 1719 | GENERATE_TREEVIEW = NO 1720 | 1721 | # When both GENERATE_TREEVIEW and DISABLE_INDEX are set to YES, then the 1722 | # FULL_SIDEBAR option determines if the side bar is limited to only the treeview 1723 | # area (value NO) or if it should extend to the full height of the window (value 1724 | # YES). Setting this to YES gives a layout similar to 1725 | # https://docs.readthedocs.io with more room for contents, but less room for the 1726 | # project logo, title, and description. If either GENERATE_TREEVIEW or 1727 | # DISABLE_INDEX is set to NO, this option has no effect. 1728 | # The default value is: NO. 1729 | # This tag requires that the tag GENERATE_HTML is set to YES. 1730 | 1731 | FULL_SIDEBAR = NO 1732 | 1733 | # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that 1734 | # doxygen will group on one line in the generated HTML documentation. 1735 | # 1736 | # Note that a value of 0 will completely suppress the enum values from appearing 1737 | # in the overview section. 1738 | # Minimum value: 0, maximum value: 20, default value: 4. 1739 | # This tag requires that the tag GENERATE_HTML is set to YES. 1740 | 1741 | ENUM_VALUES_PER_LINE = 4 1742 | 1743 | # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used 1744 | # to set the initial width (in pixels) of the frame in which the tree is shown. 1745 | # Minimum value: 0, maximum value: 1500, default value: 250. 1746 | # This tag requires that the tag GENERATE_HTML is set to YES. 1747 | 1748 | TREEVIEW_WIDTH = 250 1749 | 1750 | # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to 1751 | # external symbols imported via tag files in a separate window. 1752 | # The default value is: NO. 1753 | # This tag requires that the tag GENERATE_HTML is set to YES. 1754 | 1755 | EXT_LINKS_IN_WINDOW = NO 1756 | 1757 | # If the OBFUSCATE_EMAILS tag is set to YES, doxygen will obfuscate email 1758 | # addresses. 1759 | # The default value is: YES. 1760 | # This tag requires that the tag GENERATE_HTML is set to YES. 1761 | 1762 | OBFUSCATE_EMAILS = YES 1763 | 1764 | # If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg 1765 | # tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see 1766 | # https://inkscape.org) to generate formulas as SVG images instead of PNGs for 1767 | # the HTML output. These images will generally look nicer at scaled resolutions. 1768 | # Possible values are: png (the default) and svg (looks nicer but requires the 1769 | # pdf2svg or inkscape tool). 1770 | # The default value is: png. 1771 | # This tag requires that the tag GENERATE_HTML is set to YES. 1772 | 1773 | HTML_FORMULA_FORMAT = png 1774 | 1775 | # Use this tag to change the font size of LaTeX formulas included as images in 1776 | # the HTML documentation. When you change the font size after a successful 1777 | # doxygen run you need to manually remove any form_*.png images from the HTML 1778 | # output directory to force them to be regenerated. 1779 | # Minimum value: 8, maximum value: 50, default value: 10. 1780 | # This tag requires that the tag GENERATE_HTML is set to YES. 1781 | 1782 | FORMULA_FONTSIZE = 10 1783 | 1784 | # The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands 1785 | # to create new LaTeX commands to be used in formulas as building blocks. See 1786 | # the section "Including formulas" for details. 1787 | 1788 | FORMULA_MACROFILE = 1789 | 1790 | # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see 1791 | # https://www.mathjax.org) which uses client side JavaScript for the rendering 1792 | # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX 1793 | # installed or if you want to formulas look prettier in the HTML output. When 1794 | # enabled you may also need to install MathJax separately and configure the path 1795 | # to it using the MATHJAX_RELPATH option. 1796 | # The default value is: NO. 1797 | # This tag requires that the tag GENERATE_HTML is set to YES. 1798 | 1799 | USE_MATHJAX = NO 1800 | 1801 | # With MATHJAX_VERSION it is possible to specify the MathJax version to be used. 1802 | # Note that the different versions of MathJax have different requirements with 1803 | # regards to the different settings, so it is possible that also other MathJax 1804 | # settings have to be changed when switching between the different MathJax 1805 | # versions. 1806 | # Possible values are: MathJax_2 and MathJax_3. 1807 | # The default value is: MathJax_2. 1808 | # This tag requires that the tag USE_MATHJAX is set to YES. 1809 | 1810 | MATHJAX_VERSION = MathJax_2 1811 | 1812 | # When MathJax is enabled you can set the default output format to be used for 1813 | # the MathJax output. For more details about the output format see MathJax 1814 | # version 2 (see: 1815 | # http://docs.mathjax.org/en/v2.7-latest/output.html) and MathJax version 3 1816 | # (see: 1817 | # http://docs.mathjax.org/en/latest/web/components/output.html). 1818 | # Possible values are: HTML-CSS (which is slower, but has the best 1819 | # compatibility. This is the name for Mathjax version 2, for MathJax version 3 1820 | # this will be translated into chtml), NativeMML (i.e. MathML. Only supported 1821 | # for NathJax 2. For MathJax version 3 chtml will be used instead.), chtml (This 1822 | # is the name for Mathjax version 3, for MathJax version 2 this will be 1823 | # translated into HTML-CSS) and SVG. 1824 | # The default value is: HTML-CSS. 1825 | # This tag requires that the tag USE_MATHJAX is set to YES. 1826 | 1827 | MATHJAX_FORMAT = HTML-CSS 1828 | 1829 | # When MathJax is enabled you need to specify the location relative to the HTML 1830 | # output directory using the MATHJAX_RELPATH option. The destination directory 1831 | # should contain the MathJax.js script. For instance, if the mathjax directory 1832 | # is located at the same level as the HTML output directory, then 1833 | # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax 1834 | # Content Delivery Network so you can quickly see the result without installing 1835 | # MathJax. However, it is strongly recommended to install a local copy of 1836 | # MathJax from https://www.mathjax.org before deployment. The default value is: 1837 | # - in case of MathJax version 2: https://cdn.jsdelivr.net/npm/mathjax@2 1838 | # - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3 1839 | # This tag requires that the tag USE_MATHJAX is set to YES. 1840 | 1841 | MATHJAX_RELPATH = 1842 | 1843 | # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax 1844 | # extension names that should be enabled during MathJax rendering. For example 1845 | # for MathJax version 2 (see 1846 | # https://docs.mathjax.org/en/v2.7-latest/tex.html#tex-and-latex-extensions): 1847 | # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols 1848 | # For example for MathJax version 3 (see 1849 | # http://docs.mathjax.org/en/latest/input/tex/extensions/index.html): 1850 | # MATHJAX_EXTENSIONS = ams 1851 | # This tag requires that the tag USE_MATHJAX is set to YES. 1852 | 1853 | MATHJAX_EXTENSIONS = 1854 | 1855 | # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces 1856 | # of code that will be used on startup of the MathJax code. See the MathJax site 1857 | # (see: 1858 | # http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an 1859 | # example see the documentation. 1860 | # This tag requires that the tag USE_MATHJAX is set to YES. 1861 | 1862 | MATHJAX_CODEFILE = 1863 | 1864 | # When the SEARCHENGINE tag is enabled doxygen will generate a search box for 1865 | # the HTML output. The underlying search engine uses javascript and DHTML and 1866 | # should work on any modern browser. Note that when using HTML help 1867 | # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) 1868 | # there is already a search function so this one should typically be disabled. 1869 | # For large projects the javascript based search engine can be slow, then 1870 | # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to 1871 | # search using the keyboard; to jump to the search box use + S 1872 | # (what the is depends on the OS and browser, but it is typically 1873 | # , /