├── .clang-format ├── .gitignore ├── .vscode ├── launch.json └── settings.json ├── CMakeLists.txt ├── README.md ├── docs └── doxygen │ └── Doxyfile ├── include └── header.h └── src └── main.cpp /.clang-format: -------------------------------------------------------------------------------- 1 | --- 2 | BasedOnStyle: Microsoft 3 | PointerAlignment: Left 4 | AccessModifierOffset: -4 5 | AlwaysBreakTemplateDeclarations: Yes 6 | AllowShortFunctionsOnASingleLine: Inline 7 | AlignAfterOpenBracket: Align 8 | AllowShortCaseLabelsOnASingleLine: 'true' 9 | BreakConstructorInitializers: 'BeforeComma' 10 | ... 11 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Editors 2 | # .vscode this should be uncommented for real applications 3 | .tags 4 | *.sublime-workspace 5 | *.tmlanguage.cache 6 | *.tmPreferences.cache 7 | *.stTheme.cache 8 | *.vscode-workspace 9 | 10 | # CMake 11 | build/ 12 | CMakeLists.txt.user 13 | CMakeCache.txt 14 | CMakeFiles 15 | CMakeScripts 16 | Testing 17 | Makefile 18 | cmake_install.cmake 19 | install_manifest.txt 20 | compile_commands.json 21 | CTestTestfile.cmake 22 | _deps -------------------------------------------------------------------------------- /.vscode/launch.json: -------------------------------------------------------------------------------- 1 | { 2 | "version": "0.2.0", 3 | "configurations": [ 4 | // MSVC Debugging: 5 | { 6 | "program": "${command:cmake.launchTargetPath}", 7 | "name": "Launch (msvc)", 8 | "request": "launch", 9 | "args": [], 10 | "environment": [], 11 | "stopAtEntry": false, 12 | "cwd": "${workspaceFolder}", 13 | "console": "integratedTerminal", 14 | "internalConsoleOptions": "openOnSessionStart", 15 | "type":"cppvsdbg", 16 | }, 17 | 18 | // GDB Debugging: 19 | { 20 | "program": "${command:cmake.launchTargetPath}", 21 | "name": "Launch (gdb)", 22 | "request": "launch", 23 | "args": [], 24 | "environment": [], 25 | "stopAtEntry": false, 26 | "cwd": "${workspaceFolder}", 27 | "console": "integratedTerminal", 28 | "internalConsoleOptions": "openOnSessionStart", 29 | "type": "cppdbg", 30 | "MIMode": "gdb", 31 | "miDebuggerPath": "gdb", 32 | "setupCommands": [ 33 | { 34 | "description": "Enable pretty-printing for gdb", 35 | "text": "-enable-pretty-printing", 36 | "ignoreFailures": true 37 | } 38 | ] 39 | } 40 | ] 41 | } -------------------------------------------------------------------------------- /.vscode/settings.json: -------------------------------------------------------------------------------- 1 | { 2 | "cmake.buildDirectory": "${workspaceFolder}/build/${buildKit}/${buildType}", 3 | "C_Cpp.default.configurationProvider": "ms-vscode.cmake-tools", 4 | "doxygen_runner.configuration_file_override": "${workspaceFolder}/docs/doxygen/Doxyfile" 5 | } 6 | -------------------------------------------------------------------------------- /CMakeLists.txt: -------------------------------------------------------------------------------- 1 | #################### 2 | # Global # 3 | #################### 4 | 5 | cmake_minimum_required(VERSION 3.12) 6 | set(CMAKE_CXX_STANDARD 17) 7 | 8 | 9 | 10 | ##################### 11 | # Project # 12 | ##################### 13 | 14 | # Project variables 15 | set(LOCAL_PROJECT_NAME "#{ProjectName}") 16 | set(LOCAL_PROJECT_VERSION "0.0.1") 17 | set(LOCAL_PROJECT_DESCRIPTION "Description") 18 | 19 | # Header files (relative to "include" directory) 20 | set(HEADERS 21 | header.h 22 | ) 23 | 24 | # Source files (relative to "src" directory) 25 | set(SOURCES 26 | main.cpp 27 | ) 28 | 29 | # Compiler definitions 30 | set(DEFINES 31 | 32 | ) 33 | 34 | # Compiler options 35 | set(OPTIONS 36 | 37 | ) 38 | 39 | # Project setup 40 | project(${LOCAL_PROJECT_NAME} 41 | VERSION ${LOCAL_PROJECT_VERSION} 42 | DESCRIPTION ${LOCAL_PROJECT_DESCRIPTION} 43 | LANGUAGES CXX) 44 | 45 | add_executable(${LOCAL_PROJECT_NAME}) 46 | 47 | list(TRANSFORM HEADERS PREPEND "include/") 48 | list(TRANSFORM SOURCES PREPEND "src/") 49 | 50 | target_include_directories(${LOCAL_PROJECT_NAME} PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/include) 51 | target_sources(${LOCAL_PROJECT_NAME} PRIVATE ${SOURCES} ${HEADERS}) 52 | target_compile_definitions(${LOCAL_PROJECT_NAME} PRIVATE ${DEFINES}) 53 | target_compile_options(${LOCAL_PROJECT_NAME} PRIVATE ${OPTIONS}) 54 | 55 | set_target_properties(${LOCAL_PROJECT_NAME} PROPERTIES RUNTIME_OUTPUT_DIRECTORY "bin") 56 | 57 | 58 | 59 | #################### 60 | # Dependencies # 61 | #################### -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # CMake-VSCode-Tutorial 2 | 3 | Template and short tutorial on how to setup an integrated environment for VS Code and CMake for C/C++ programming (with Doxygen and ClangFormat ready to use too!) 4 | 5 | 6 | ## 1. Overview 7 | 8 | The following is a CMake C++ Template for use with VS Code. It has been designed around Windows and the MSVC compiler, but would work perfectly with other compilers and on a Linux/Mac installation too (I assume Linux users would know how to e.g. install a compiler and configure their paths correctly). It covers installation for the MSVC and MinGW compilers, extension setup, how to use the template, and some basic CMake fundamentals to help you transition to VS Code and CMake. 9 | 10 | The template requires very little CMake knowledge (as I have little myself!) which makes it great for mimicking an IDE environment such as Visual Studio (which I will use as a "baseline" when setting up the template and configuring settings). In fact, this template is specifically designed for those who are moving from a fully-fledged IDE such as Visual Studio, to VS Code (although this obviously isn't a necessity). It may also help those transitioning from more integrated programming languages such as Python. 11 | 12 | A couple steps need to be followed in order to get C++, CMake and VS Code working smoothly, however I guarantee you that if you follow the instructions below step-by-step, starting from scratch, you'll end up with an awesome build environment to program in C++ in the great editor that is VS Code. The template of course is also configurable and highly modular (see section 7. Further Enhancements). Nevertheless, I hope that this tutorial can be of help to you, and lets get started! 13 | 14 | 15 | ## 2. Prerequisites 16 | 17 | - Install CMake itself from https://cmake.org/, and ensure that its "bin" directory is added to your "Path" environment variable (see https://docs.microsoft.com/en-us/previous-versions/office/developer/sharepoint-2010/ee537574(v=office.14 on how to do so). This may be done directly in the CMake installer. 18 | 19 | - Install the "CMake Tools", "CMake" and "CPP-Tools" extensions from the VS Code marketplace. An optional (but highly recommended) extension is also the "Project Templates" extension. This will allow you to easily create new projects from this template, which actually uses placeholder variables for things such as the project name. A clean install for all of these extensions is also recommended. 20 | - https://marketplace.visualstudio.com/items?itemName=ms-vscode.cmake-tools 21 | - https://marketplace.visualstudio.com/items?itemName=twxs.cmake 22 | - https://marketplace.visualstudio.com/items?itemName=ms-vscode.cpptools 23 | - https://marketplace.visualstudio.com/items?itemName=cantonios.project-templates 24 | 25 | - Install the compiler of your choice: 26 | - MSVC: The easiest way to install the MSVC compiler toolchain is to install the latest version of Visual Studio Community Edition. Ticking the "Desktop development with C++" workload in the installer should download everything required. Make sure to install this in the default location, otherwise you should manually add the relevant directories to the Path environment variable. 27 | - MinGW-w64 (GCC for Windows): Download this compiler from http://winlibs.com/. Ensure to download the latest version (without LLVM). This is because debugging across x86 and x64 versions with the same gdb executable has only recently become supported. You will have to manually add the "bin" directories of this download to your Path environment variable. If you download both the x86 and x64 versions, you should do this for both. 28 | 29 | 30 | ## 3. First-time Setup 31 | 32 | 1. If you have installed the "Project Templates" extension, clone this repository directly into that extension's "Templates Folder" (should be "AppData\Roaming\Code\User\ProjectTemplates" by default, but can find this directory by opening VS Code and running the command "Project: Open Templates Folder".) If you have not installed the extension, clone it somewhere suitable. Rename the repository as you like (I call mine "CPP-Empty" as I also have e.g. a "CPP-QtWidgets" template). In the .gitignore of this repository, remove the comment for .vscode, and delete the README.md file. 33 | 34 | 2. Open VS Code inside a new empty folder which will be used for initial testing and setup. Again, if using the Project Templates extension, run the command "Project: Create Project from Template", choose the template, and enter in the variables for your project (i.e. what you would like for ProjectName). This should copy the template over to the current folder but with the project name filled in. If not using this extension, simple manually copy the folder over and find-and-replace these variables such as "#{ProjectName}" to enter the project name. This process will also be how you will setup new projects in the future. 35 | 36 | 3. I recommend manually editing the names of CMake Tools' "kits" (kits = compiler toolchains). The reason behind this is that the template uses the names of these kits as the names of the subdirectories under the build directory, to allow for multiple toolchains. First, we need to run "CMake: Configure". When the CMake Tools extension asks which kit to use, choose "Scan for kits". If MSVC was installed correctly, or MinGW/bin was added to the Path variable correctly, at least one compiler toolchain or "kit" should be located. Open the command palette, type "Edit User-Local CMake Kits", and hit enter. Now rename the kits to your liking. Note that you can also delete any unnecessary kits, which I have done for MSVC. These can easily be rescanned in later. I recommend the following: 37 | - MSVC: Delete the kits which have a "toolset" variable different to your own computer's architecture i.e. if you are working on a 64-bit computer, delete both kits with "host=x86". I have named mine to "MSVC-2019-x64" and "MSVC-2019-x86" respectively. 38 | - MinGW-w64: I have named my kits "MinGW-9.0.0-x64" and "MinGW-9.0.0-x86" respectively. 39 | 40 | 41 | ## 4. Keyboard Shortcuts and Build Commands 42 | 43 | - We are using CMake Tools to run the necessary CMake commands that generates our MSVC Solution/MinGW makefile, and VS Code to debug our target. Although CMake Tools does offer debugging functionality, it seems the VS Code debugging works perfectly, is slightly more robust and offers more functionality (e.g. debugging using the integrated terminal). I have therefore removed the CMake Tools shortcuts for both debug and run (i.e. "CMake: Debug" and "CMake: Run Without Debugging"). Some shortcuts I have are: 44 | 45 | CMake: Build All Projects ==================== Ctrl + Shift + B 46 | 47 | CMake: Build ============================ Ctrl + B 48 | 49 | CMake: Cancel Build ======================= Ctrl + Backspace 50 | 51 | CMake: Compile Active File ================== Ctrl + F7 52 | 53 | CMake: Debug ========================== not used 54 | 55 | CMake: Run Without Debugging ============== not used 56 | 57 | Debug: Start Debugging =================== F5 58 | 59 | Debug: Stop =========================== Shift + F5 60 | 61 | Project: Create Project from Template =========== Ctrl + Alt + N 62 | 63 | 64 | ## 5. Project Creation Workflow 65 | 66 | After mentioning the above, the following is the typical workflow to create a new project with the template extension: 67 | - Create a new folder and name it MyProjectName 68 | - Open the folder in VS Code 69 | - Call the command "Project: Create Project from Template" and enter MyProjectName 70 | - Run the "CMake: Configure" command, selecting the kit you would like to initially use 71 | - Add code to src/main.cpp 72 | - Run with Debug: Start Debugging and have fun! 73 | 74 | 75 | ## 6. Project structure and CMake Basics 76 | 77 | - With CMake, each project is essentially managed by a CMakeLists.txt file. This file has been set up to be as beginner-friendly and configurable as possible. It contains two lists of files called "SOURCES" and "HEADERS". In this file, you need to manually add the source files and header files each time they are added to your project, as indicated. Although this may seem like a step backwards from IDEs that do this automatically, it is generally how CMake projects are managed, as they are IDE agnostic. The file has also been setup so that you can add definitions, include paths and compiler options, although I recommend vector-of-bool's videos on "How to CMake Good" on YouTube for anything more complicated. 78 | 79 | - Adding CMake depencies can sometimes work, and sometimes not. I have added a section in the CMakeLists.txt file for this at the bottom. The typical way (and how I have set up my environment) is to add an environment variable "CMAKE_PREFIX_PATH" which points to a folder containing all your external libraries. CMake allows you to find these dependencies using a find_package call, which is typically something like find_package(Qt5 COMPONENTS Widgets REQUIRED). You can then also link against these packages once they are found using target_link_libraries(${LOCAL_PROJECT_NAME} ...). This structure differs from library to library. Note that the name of the folder of the library inside CMAKE_PREFIX_PATH matters: CMake will look inside the CMAKE_PREFIX_PATH folder for other directories e.g. starting with "Qt5". Be sure to name your folders appropriately. 80 | 81 | - The relevant build files are produced in a seperate "build tree" which can be considered "parallel" to the source tree. This may be different from IDE setups. The template produces sub-directories's for each kit inside the "build" directory. A further two subdirectories for "debug" and "release" are also generated, and then the general CMake build tree follows from there. This includes a folder for each sub-project, and a "bin" directory in each sub-project with the relevant executable. I am not sure if this layout is standard CMake practice or not, but it prevents rebuilding each time you switch configurations, and is what I consider the "Visual Studio" standard. 82 | 83 | - Although this setup only contains one project, it is fairly easy to create multiple sub-projects and the equivalent of a "Solution" with multiple projects in Visual Studio. This will simply mean adding sub-folders to CMake using add_subdirectory(). These sub-folders will generally have their own CMakeLists.txt file and source files, and the hierarchy can extend as long as you'd like. Again, I'd recommend watching vector-of-bool's videos further before continuing with something like this. 84 | 85 | 86 | ## 7. Things to keep in mind 87 | 88 | It should be noted that, once a project has been created, most of the configurations related to CMake can be made through the toolbar at the bottom of VS Code. This includes whether CMake is building in Debug or Release mode, the current kit being used, the target being built etc. 89 | 90 | It should also be noted that, each time a change has been made to a CMakeLists.txt file, CMake should be re-configured. This should be done automatically through the extension when you save the file. 91 | 92 | Lastly, the launch.json file contains two different launch configurations: one for MSVC and one for GDB. Be sure the launch configuration you have selected in VS Code matches the kit selection in CMake. 93 | 94 | 95 | ## 8. Doxygen and ClangFormat 96 | 97 | This project has been setup to allow for easy creation of documentation files using Doxygen. Although this is a separate tutorial on its own, all one should know is that the "docs" folder contains a file indicating how this documentation should be generated using software Doxygen, which seems to be the industry standard for C++ documentation. This file is referenced in the VS Code settings.json file. This allows for integration with the Doxygen VS Code extension. 98 | 99 | A .clang-format file is also provided. This contains my own personal formatting settings for use with an indentation and code formatter called ClangFormat. This formatter is bundled with the VS Code CPP extension and I highly recommend using it. To use ClangFormat instead of the default formatter, simply change "C_Cpp: Formatting" under preferences in VS Code to clangFormat. Also ensure formatting is enabled for a specific action, such as when you save a file. 100 | 101 | 102 | ## 9. Future Enhancements 103 | 104 | There are plenty enhancements that can be made to this template. The first thing I would like is the ability for source files to be automatically added to the relevent CMakeLists.txt file when they are added to the project. I'm sure this could be accomplish with a simple VS Code extension. I consider this feature to be standard for IDEs and hope to potentially write an extension for it in the future. 105 | 106 | I am sure there are other additions that could be made too, but I believe this template has been refined multiple times and so I hope it has a solid foundation for others to use and build upon. I'm happy for any criticism and suggestions. My email is gvcallen@gmail.com. 107 | 108 | ## 10. Conclusion 109 | 110 | That's it! I hoped you find this useful in some way. As mentioned, if you have any additions, suggestions, or bug-fixes, feel free to message/email me or submit a pull request. 111 | 112 | vector-of-bool also has a github.io at https://vector-of-bool.github.io/docs/vscode-cmake-tools/getting_started.html with more help on the CMake Tools extension, which I definitely recommend reading if you get the chance. 113 | 114 | Happy coding! 115 | -------------------------------------------------------------------------------- /docs/doxygen/Doxyfile: -------------------------------------------------------------------------------- 1 | # Doxyfile 1.9.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 | #--------------------------------------------------------------------------- 17 | # Project related configuration options 18 | #--------------------------------------------------------------------------- 19 | 20 | # This tag specifies the encoding used for all characters in the configuration 21 | # file that follow. The default is UTF-8 which is also the encoding used for all 22 | # text before the first occurrence of this tag. Doxygen uses libiconv (or the 23 | # iconv built into libc) for the transcoding. See 24 | # https://www.gnu.org/software/libiconv/ for the list of possible encodings. 25 | # The default value is: UTF-8. 26 | 27 | DOXYFILE_ENCODING = UTF-8 28 | 29 | # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by 30 | # double-quotes, unless you are using Doxywizard) that should identify the 31 | # project for which the documentation is generated. This name is used in the 32 | # title of most generated pages and in a few other places. 33 | # The default value is: My Project. 34 | 35 | PROJECT_NAME = "#{ProjectName}" 36 | 37 | # The PROJECT_NUMBER tag can be used to enter a project or revision number. This 38 | # could be handy for archiving the generated documentation or if some version 39 | # control system is used. 40 | 41 | PROJECT_NUMBER = 0.0.1 42 | 43 | # Using the PROJECT_BRIEF tag one can provide an optional one line description 44 | # for a project that appears at the top of each page and should give viewer a 45 | # quick idea about the purpose of the project. Keep the description short. 46 | 47 | PROJECT_BRIEF = 48 | 49 | # With the PROJECT_LOGO tag one can specify a logo or an icon that is included 50 | # in the documentation. The maximum height of the logo should not exceed 55 51 | # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy 52 | # the logo to the output directory. 53 | 54 | PROJECT_LOGO = 55 | 56 | # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path 57 | # into which the generated documentation will be written. If a relative path is 58 | # entered, it will be relative to the location where doxygen was started. If 59 | # left blank the current directory will be used. 60 | 61 | OUTPUT_DIRECTORY = ../ 62 | 63 | # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- 64 | # directories (in 2 levels) under the output directory of each output format and 65 | # will distribute the generated files over these directories. Enabling this 66 | # option can be useful when feeding doxygen a huge amount of source files, where 67 | # putting all generated files in the same directory would otherwise causes 68 | # performance problems for the file system. 69 | # The default value is: NO. 70 | 71 | CREATE_SUBDIRS = NO 72 | 73 | # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII 74 | # characters to appear in the names of generated files. If set to NO, non-ASCII 75 | # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode 76 | # U+3044. 77 | # The default value is: NO. 78 | 79 | ALLOW_UNICODE_NAMES = NO 80 | 81 | # The OUTPUT_LANGUAGE tag is used to specify the language in which all 82 | # documentation generated by doxygen is written. Doxygen will use this 83 | # information to generate all constant output in the proper language. 84 | # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, 85 | # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), 86 | # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, 87 | # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), 88 | # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, 89 | # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, 90 | # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, 91 | # Ukrainian and Vietnamese. 92 | # The default value is: English. 93 | 94 | OUTPUT_LANGUAGE = English 95 | 96 | # The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all 97 | # documentation generated by doxygen is written. Doxygen will use this 98 | # information to generate all generated output in the proper direction. 99 | # Possible values are: None, LTR, RTL and Context. 100 | # The default value is: None. 101 | 102 | OUTPUT_TEXT_DIRECTION = None 103 | 104 | # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member 105 | # descriptions after the members that are listed in the file and class 106 | # documentation (similar to Javadoc). Set to NO to disable this. 107 | # The default value is: YES. 108 | 109 | BRIEF_MEMBER_DESC = YES 110 | 111 | # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief 112 | # description of a member or function before the detailed description 113 | # 114 | # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 115 | # brief descriptions will be completely suppressed. 116 | # The default value is: YES. 117 | 118 | REPEAT_BRIEF = YES 119 | 120 | # This tag implements a quasi-intelligent brief description abbreviator that is 121 | # used to form the text in various listings. Each string in this list, if found 122 | # as the leading text of the brief description, will be stripped from the text 123 | # and the result, after processing the whole list, is used as the annotated 124 | # text. Otherwise, the brief description is used as-is. If left blank, the 125 | # following values are used ($name is automatically replaced with the name of 126 | # the entity):The $name class, The $name widget, The $name file, is, provides, 127 | # specifies, contains, represents, a, an and the. 128 | 129 | ABBREVIATE_BRIEF = "The $name class" \ 130 | "The $name widget" \ 131 | "The $name file" \ 132 | is \ 133 | provides \ 134 | specifies \ 135 | contains \ 136 | represents \ 137 | a \ 138 | an \ 139 | the 140 | 141 | # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 142 | # doxygen will generate a detailed section even if there is only a brief 143 | # description. 144 | # The default value is: NO. 145 | 146 | ALWAYS_DETAILED_SEC = NO 147 | 148 | # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 149 | # inherited members of a class in the documentation of that class as if those 150 | # members were ordinary class members. Constructors, destructors and assignment 151 | # operators of the base classes will not be shown. 152 | # The default value is: NO. 153 | 154 | INLINE_INHERITED_MEMB = NO 155 | 156 | # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path 157 | # before files name in the file list and in the header files. If set to NO the 158 | # shortest path that makes the file name unique will be used 159 | # The default value is: YES. 160 | 161 | FULL_PATH_NAMES = YES 162 | 163 | # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. 164 | # Stripping is only done if one of the specified strings matches the left-hand 165 | # part of the path. The tag can be used to show relative paths in the file list. 166 | # If left blank the directory from which doxygen is run is used as the path to 167 | # strip. 168 | # 169 | # Note that you can specify absolute paths here, but also relative paths, which 170 | # will be relative from the directory where doxygen is started. 171 | # This tag requires that the tag FULL_PATH_NAMES is set to YES. 172 | 173 | STRIP_FROM_PATH = 174 | 175 | # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the 176 | # path mentioned in the documentation of a class, which tells the reader which 177 | # header file to include in order to use a class. If left blank only the name of 178 | # the header file containing the class definition is used. Otherwise one should 179 | # specify the list of include paths that are normally passed to the compiler 180 | # using the -I flag. 181 | 182 | STRIP_FROM_INC_PATH = 183 | 184 | # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but 185 | # less readable) file names. This can be useful is your file systems doesn't 186 | # support long names like on DOS, Mac, or CD-ROM. 187 | # The default value is: NO. 188 | 189 | SHORT_NAMES = NO 190 | 191 | # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the 192 | # first line (until the first dot) of a Javadoc-style comment as the brief 193 | # description. If set to NO, the Javadoc-style will behave just like regular Qt- 194 | # style comments (thus requiring an explicit @brief command for a brief 195 | # description.) 196 | # The default value is: NO. 197 | 198 | JAVADOC_AUTOBRIEF = YES 199 | 200 | # If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line 201 | # such as 202 | # /*************** 203 | # as being the beginning of a Javadoc-style comment "banner". If set to NO, the 204 | # Javadoc-style will behave just like regular comments and it will not be 205 | # interpreted by doxygen. 206 | # The default value is: NO. 207 | 208 | JAVADOC_BANNER = NO 209 | 210 | # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first 211 | # line (until the first dot) of a Qt-style comment as the brief description. If 212 | # set to NO, the Qt-style will behave just like regular Qt-style comments (thus 213 | # requiring an explicit \brief command for a brief description.) 214 | # The default value is: NO. 215 | 216 | QT_AUTOBRIEF = NO 217 | 218 | # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a 219 | # multi-line C++ special comment block (i.e. a block of //! or /// comments) as 220 | # a brief description. This used to be the default behavior. The new default is 221 | # to treat a multi-line C++ comment block as a detailed description. Set this 222 | # tag to YES if you prefer the old behavior instead. 223 | # 224 | # Note that setting this tag to YES also means that rational rose comments are 225 | # not recognized any more. 226 | # The default value is: NO. 227 | 228 | MULTILINE_CPP_IS_BRIEF = NO 229 | 230 | # By default Python docstrings are displayed as preformatted text and doxygen's 231 | # special commands cannot be used. By setting PYTHON_DOCSTRING to NO the 232 | # doxygen's special commands can be used and the contents of the docstring 233 | # documentation blocks is shown as doxygen documentation. 234 | # The default value is: YES. 235 | 236 | PYTHON_DOCSTRING = YES 237 | 238 | # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the 239 | # documentation from any documented member that it re-implements. 240 | # The default value is: YES. 241 | 242 | INHERIT_DOCS = YES 243 | 244 | # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new 245 | # page for each member. If set to NO, the documentation of a member will be part 246 | # of the file/class/namespace that contains it. 247 | # The default value is: NO. 248 | 249 | SEPARATE_MEMBER_PAGES = NO 250 | 251 | # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen 252 | # uses this value to replace tabs by spaces in code fragments. 253 | # Minimum value: 1, maximum value: 16, default value: 4. 254 | 255 | TAB_SIZE = 4 256 | 257 | # This tag can be used to specify a number of aliases that act as commands in 258 | # the documentation. An alias has the form: 259 | # name=value 260 | # For example adding 261 | # "sideeffect=@par Side Effects:\n" 262 | # will allow you to put the command \sideeffect (or @sideeffect) in the 263 | # documentation, which will result in a user-defined paragraph with heading 264 | # "Side Effects:". You can put \n's in the value part of an alias to insert 265 | # newlines (in the resulting output). You can put ^^ in the value part of an 266 | # alias to insert a newline as if a physical newline was in the original file. 267 | # When you need a literal { or } or , in the value part of an alias you have to 268 | # escape them by means of a backslash (\), this can lead to conflicts with the 269 | # commands \{ and \} for these it is advised to use the version @{ and @} or use 270 | # a double escape (\\{ and \\}) 271 | 272 | ALIASES = 273 | 274 | # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources 275 | # only. Doxygen will then generate output that is more tailored for C. For 276 | # instance, some of the names that are used will be different. The list of all 277 | # members will be omitted, etc. 278 | # The default value is: NO. 279 | 280 | OPTIMIZE_OUTPUT_FOR_C = NO 281 | 282 | # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or 283 | # Python sources only. Doxygen will then generate output that is more tailored 284 | # for that language. For instance, namespaces will be presented as packages, 285 | # qualified scopes will look different, etc. 286 | # The default value is: NO. 287 | 288 | OPTIMIZE_OUTPUT_JAVA = NO 289 | 290 | # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 291 | # sources. Doxygen will then generate output that is tailored for Fortran. 292 | # The default value is: NO. 293 | 294 | OPTIMIZE_FOR_FORTRAN = NO 295 | 296 | # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 297 | # sources. Doxygen will then generate output that is tailored for VHDL. 298 | # The default value is: NO. 299 | 300 | OPTIMIZE_OUTPUT_VHDL = NO 301 | 302 | # Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice 303 | # sources only. Doxygen will then generate output that is more tailored for that 304 | # language. For instance, namespaces will be presented as modules, types will be 305 | # separated into more groups, etc. 306 | # The default value is: NO. 307 | 308 | OPTIMIZE_OUTPUT_SLICE = NO 309 | 310 | # Doxygen selects the parser to use depending on the extension of the files it 311 | # parses. With this tag you can assign which parser to use for a given 312 | # extension. Doxygen has a built-in mapping, but you can override or extend it 313 | # using this tag. The format is ext=language, where ext is a file extension, and 314 | # language is one of the parsers supported by doxygen: IDL, Java, JavaScript, 315 | # Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice, VHDL, 316 | # Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: 317 | # FortranFree, unknown formatted Fortran: Fortran. In the later case the parser 318 | # tries to guess whether the code is fixed or free formatted code, this is the 319 | # default for Fortran type files). For instance to make doxygen treat .inc files 320 | # as Fortran files (default is PHP), and .f files as C (default is Fortran), 321 | # use: inc=Fortran f=C. 322 | # 323 | # Note: For files without extension you can use no_extension as a placeholder. 324 | # 325 | # Note that for custom extensions you also need to set FILE_PATTERNS otherwise 326 | # the files are not read by doxygen. When specifying no_extension you should add 327 | # * to the FILE_PATTERNS. 328 | # 329 | # Note see also the list of default file extension mappings. 330 | 331 | EXTENSION_MAPPING = 332 | 333 | # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments 334 | # according to the Markdown format, which allows for more readable 335 | # documentation. See https://daringfireball.net/projects/markdown/ for details. 336 | # The output of markdown processing is further processed by doxygen, so you can 337 | # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in 338 | # case of backward compatibilities issues. 339 | # The default value is: YES. 340 | 341 | MARKDOWN_SUPPORT = YES 342 | 343 | # When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up 344 | # to that level are automatically included in the table of contents, even if 345 | # they do not have an id attribute. 346 | # Note: This feature currently applies only to Markdown headings. 347 | # Minimum value: 0, maximum value: 99, default value: 5. 348 | # This tag requires that the tag MARKDOWN_SUPPORT is set to YES. 349 | 350 | TOC_INCLUDE_HEADINGS = 5 351 | 352 | # When enabled doxygen tries to link words that correspond to documented 353 | # classes, or namespaces to their corresponding documentation. Such a link can 354 | # be prevented in individual cases by putting a % sign in front of the word or 355 | # globally by setting AUTOLINK_SUPPORT to NO. 356 | # The default value is: YES. 357 | 358 | AUTOLINK_SUPPORT = YES 359 | 360 | # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 361 | # to include (a tag file for) the STL sources as input, then you should set this 362 | # tag to YES in order to let doxygen match functions declarations and 363 | # definitions whose arguments contain STL classes (e.g. func(std::string); 364 | # versus func(std::string) {}). This also make the inheritance and collaboration 365 | # diagrams that involve STL classes more complete and accurate. 366 | # The default value is: NO. 367 | 368 | BUILTIN_STL_SUPPORT = NO 369 | 370 | # If you use Microsoft's C++/CLI language, you should set this option to YES to 371 | # enable parsing support. 372 | # The default value is: NO. 373 | 374 | CPP_CLI_SUPPORT = NO 375 | 376 | # Set the SIP_SUPPORT tag to YES if your project consists of sip (see: 377 | # https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen 378 | # will parse them like normal C++ but will assume all classes use public instead 379 | # of private inheritance when no explicit protection keyword is present. 380 | # The default value is: NO. 381 | 382 | SIP_SUPPORT = NO 383 | 384 | # For Microsoft's IDL there are propget and propput attributes to indicate 385 | # getter and setter methods for a property. Setting this option to YES will make 386 | # doxygen to replace the get and set methods by a property in the documentation. 387 | # This will only work if the methods are indeed getting or setting a simple 388 | # type. If this is not the case, or you want to show the methods anyway, you 389 | # should set this option to NO. 390 | # The default value is: YES. 391 | 392 | IDL_PROPERTY_SUPPORT = YES 393 | 394 | # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 395 | # tag is set to YES then doxygen will reuse the documentation of the first 396 | # member in the group (if any) for the other members of the group. By default 397 | # all members of a group must be documented explicitly. 398 | # The default value is: NO. 399 | 400 | DISTRIBUTE_GROUP_DOC = NO 401 | 402 | # If one adds a struct or class to a group and this option is enabled, then also 403 | # any nested class or struct is added to the same group. By default this option 404 | # is disabled and one has to add nested compounds explicitly via \ingroup. 405 | # The default value is: NO. 406 | 407 | GROUP_NESTED_COMPOUNDS = NO 408 | 409 | # Set the SUBGROUPING tag to YES to allow class member groups of the same type 410 | # (for instance a group of public functions) to be put as a subgroup of that 411 | # type (e.g. under the Public Functions section). Set it to NO to prevent 412 | # subgrouping. Alternatively, this can be done per class using the 413 | # \nosubgrouping command. 414 | # The default value is: YES. 415 | 416 | SUBGROUPING = YES 417 | 418 | # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions 419 | # are shown inside the group in which they are included (e.g. using \ingroup) 420 | # instead of on a separate page (for HTML and Man pages) or section (for LaTeX 421 | # and RTF). 422 | # 423 | # Note that this feature does not work in combination with 424 | # SEPARATE_MEMBER_PAGES. 425 | # The default value is: NO. 426 | 427 | INLINE_GROUPED_CLASSES = NO 428 | 429 | # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions 430 | # with only public data fields or simple typedef fields will be shown inline in 431 | # the documentation of the scope in which they are defined (i.e. file, 432 | # namespace, or group documentation), provided this scope is documented. If set 433 | # to NO, structs, classes, and unions are shown on a separate page (for HTML and 434 | # Man pages) or section (for LaTeX and RTF). 435 | # The default value is: NO. 436 | 437 | INLINE_SIMPLE_STRUCTS = NO 438 | 439 | # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or 440 | # enum is documented as struct, union, or enum with the name of the typedef. So 441 | # typedef struct TypeS {} TypeT, will appear in the documentation as a struct 442 | # with name TypeT. When disabled the typedef will appear as a member of a file, 443 | # namespace, or class. And the struct will be named TypeS. This can typically be 444 | # useful for C code in case the coding convention dictates that all compound 445 | # types are typedef'ed and only the typedef is referenced, never the tag name. 446 | # The default value is: NO. 447 | 448 | TYPEDEF_HIDES_STRUCT = NO 449 | 450 | # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This 451 | # cache is used to resolve symbols given their name and scope. Since this can be 452 | # an expensive process and often the same symbol appears multiple times in the 453 | # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small 454 | # doxygen will become slower. If the cache is too large, memory is wasted. The 455 | # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range 456 | # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 457 | # symbols. At the end of a run doxygen will report the cache usage and suggest 458 | # the optimal cache size from a speed point of view. 459 | # Minimum value: 0, maximum value: 9, default value: 0. 460 | 461 | LOOKUP_CACHE_SIZE = 0 462 | 463 | # The NUM_PROC_THREADS specifies the number threads doxygen is allowed to use 464 | # during processing. When set to 0 doxygen will based this on the number of 465 | # cores available in the system. You can set it explicitly to a value larger 466 | # than 0 to get more control over the balance between CPU load and processing 467 | # speed. At this moment only the input processing can be done using multiple 468 | # threads. Since this is still an experimental feature the default is set to 1, 469 | # which efficively disables parallel processing. Please report any issues you 470 | # encounter. Generating dot graphs in parallel is controlled by the 471 | # DOT_NUM_THREADS setting. 472 | # Minimum value: 0, maximum value: 32, default value: 1. 473 | 474 | NUM_PROC_THREADS = 1 475 | 476 | #--------------------------------------------------------------------------- 477 | # Build related configuration options 478 | #--------------------------------------------------------------------------- 479 | 480 | # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in 481 | # documentation are documented, even if no documentation was available. Private 482 | # class members and static file members will be hidden unless the 483 | # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. 484 | # Note: This will also disable the warnings about undocumented members that are 485 | # normally produced when WARNINGS is set to YES. 486 | # The default value is: NO. 487 | 488 | EXTRACT_ALL = YES 489 | 490 | # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will 491 | # be included in the documentation. 492 | # The default value is: NO. 493 | 494 | EXTRACT_PRIVATE = NO 495 | 496 | # If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual 497 | # methods of a class will be included in the documentation. 498 | # The default value is: NO. 499 | 500 | EXTRACT_PRIV_VIRTUAL = NO 501 | 502 | # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal 503 | # scope will be included in the documentation. 504 | # The default value is: NO. 505 | 506 | EXTRACT_PACKAGE = NO 507 | 508 | # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be 509 | # included in the documentation. 510 | # The default value is: NO. 511 | 512 | EXTRACT_STATIC = NO 513 | 514 | # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined 515 | # locally in source files will be included in the documentation. If set to NO, 516 | # only classes defined in header files are included. Does not have any effect 517 | # for Java sources. 518 | # The default value is: YES. 519 | 520 | EXTRACT_LOCAL_CLASSES = YES 521 | 522 | # This flag is only useful for Objective-C code. If set to YES, local methods, 523 | # which are defined in the implementation section but not in the interface are 524 | # included in the documentation. If set to NO, only methods in the interface are 525 | # included. 526 | # The default value is: NO. 527 | 528 | EXTRACT_LOCAL_METHODS = NO 529 | 530 | # If this flag is set to YES, the members of anonymous namespaces will be 531 | # extracted and appear in the documentation as a namespace called 532 | # 'anonymous_namespace{file}', where file will be replaced with the base name of 533 | # the file that contains the anonymous namespace. By default anonymous namespace 534 | # are hidden. 535 | # The default value is: NO. 536 | 537 | EXTRACT_ANON_NSPACES = NO 538 | 539 | # If this flag is set to YES, the name of an unnamed parameter in a declaration 540 | # will be determined by the corresponding definition. By default unnamed 541 | # parameters remain unnamed in the output. 542 | # The default value is: YES. 543 | 544 | RESOLVE_UNNAMED_PARAMS = YES 545 | 546 | # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all 547 | # undocumented members inside documented classes or files. If set to NO these 548 | # members will be included in the various overviews, but no documentation 549 | # section is generated. This option has no effect if EXTRACT_ALL is enabled. 550 | # The default value is: NO. 551 | 552 | HIDE_UNDOC_MEMBERS = NO 553 | 554 | # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all 555 | # undocumented classes that are normally visible in the class hierarchy. If set 556 | # to NO, these classes will be included in the various overviews. This option 557 | # has no effect if EXTRACT_ALL is enabled. 558 | # The default value is: NO. 559 | 560 | HIDE_UNDOC_CLASSES = NO 561 | 562 | # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend 563 | # declarations. If set to NO, these declarations will be included in the 564 | # documentation. 565 | # The default value is: NO. 566 | 567 | HIDE_FRIEND_COMPOUNDS = NO 568 | 569 | # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any 570 | # documentation blocks found inside the body of a function. If set to NO, these 571 | # blocks will be appended to the function's detailed documentation block. 572 | # The default value is: NO. 573 | 574 | HIDE_IN_BODY_DOCS = NO 575 | 576 | # The INTERNAL_DOCS tag determines if documentation that is typed after a 577 | # \internal command is included. If the tag is set to NO then the documentation 578 | # will be excluded. Set it to YES to include the internal documentation. 579 | # The default value is: NO. 580 | 581 | INTERNAL_DOCS = NO 582 | 583 | # With the correct setting of option CASE_SENSE_NAMES doxygen will better be 584 | # able to match the capabilities of the underlying filesystem. In case the 585 | # filesystem is case sensitive (i.e. it supports files in the same directory 586 | # whose names only differ in casing), the option must be set to YES to properly 587 | # deal with such files in case they appear in the input. For filesystems that 588 | # are not case sensitive the option should be be set to NO to properly deal with 589 | # output files written for symbols that only differ in casing, such as for two 590 | # classes, one named CLASS and the other named Class, and to also support 591 | # references to files without having to specify the exact matching casing. On 592 | # Windows (including Cygwin) and MacOS, users should typically set this option 593 | # to NO, whereas on Linux or other Unix flavors it should typically be set to 594 | # YES. 595 | # The default value is: system dependent. 596 | 597 | CASE_SENSE_NAMES = NO 598 | 599 | # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with 600 | # their full class and namespace scopes in the documentation. If set to YES, the 601 | # scope will be hidden. 602 | # The default value is: NO. 603 | 604 | HIDE_SCOPE_NAMES = NO 605 | 606 | # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will 607 | # append additional text to a page's title, such as Class Reference. If set to 608 | # YES the compound reference will be hidden. 609 | # The default value is: NO. 610 | 611 | HIDE_COMPOUND_REFERENCE= NO 612 | 613 | # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of 614 | # the files that are included by a file in the documentation of that file. 615 | # The default value is: YES. 616 | 617 | SHOW_INCLUDE_FILES = YES 618 | 619 | # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each 620 | # grouped member an include statement to the documentation, telling the reader 621 | # which file to include in order to use the member. 622 | # The default value is: NO. 623 | 624 | SHOW_GROUPED_MEMB_INC = NO 625 | 626 | # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include 627 | # files with double quotes in the documentation rather than with sharp brackets. 628 | # The default value is: NO. 629 | 630 | FORCE_LOCAL_INCLUDES = NO 631 | 632 | # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the 633 | # documentation for inline members. 634 | # The default value is: YES. 635 | 636 | INLINE_INFO = YES 637 | 638 | # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the 639 | # (detailed) documentation of file and class members alphabetically by member 640 | # name. If set to NO, the members will appear in declaration order. 641 | # The default value is: YES. 642 | 643 | SORT_MEMBER_DOCS = YES 644 | 645 | # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief 646 | # descriptions of file, namespace and class members alphabetically by member 647 | # name. If set to NO, the members will appear in declaration order. Note that 648 | # this will also influence the order of the classes in the class list. 649 | # The default value is: NO. 650 | 651 | SORT_BRIEF_DOCS = NO 652 | 653 | # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the 654 | # (brief and detailed) documentation of class members so that constructors and 655 | # destructors are listed first. If set to NO the constructors will appear in the 656 | # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. 657 | # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief 658 | # member documentation. 659 | # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting 660 | # detailed member documentation. 661 | # The default value is: NO. 662 | 663 | SORT_MEMBERS_CTORS_1ST = NO 664 | 665 | # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy 666 | # of group names into alphabetical order. If set to NO the group names will 667 | # appear in their defined order. 668 | # The default value is: NO. 669 | 670 | SORT_GROUP_NAMES = NO 671 | 672 | # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by 673 | # fully-qualified names, including namespaces. If set to NO, the class list will 674 | # be sorted only by class name, not including the namespace part. 675 | # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 676 | # Note: This option applies only to the class list, not to the alphabetical 677 | # list. 678 | # The default value is: NO. 679 | 680 | SORT_BY_SCOPE_NAME = NO 681 | 682 | # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper 683 | # type resolution of all parameters of a function it will reject a match between 684 | # the prototype and the implementation of a member function even if there is 685 | # only one candidate or it is obvious which candidate to choose by doing a 686 | # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still 687 | # accept a match between prototype and implementation in such cases. 688 | # The default value is: NO. 689 | 690 | STRICT_PROTO_MATCHING = NO 691 | 692 | # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo 693 | # list. This list is created by putting \todo commands in the documentation. 694 | # The default value is: YES. 695 | 696 | GENERATE_TODOLIST = YES 697 | 698 | # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test 699 | # list. This list is created by putting \test commands in the documentation. 700 | # The default value is: YES. 701 | 702 | GENERATE_TESTLIST = YES 703 | 704 | # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug 705 | # list. This list is created by putting \bug commands in the documentation. 706 | # The default value is: YES. 707 | 708 | GENERATE_BUGLIST = YES 709 | 710 | # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) 711 | # the deprecated list. This list is created by putting \deprecated commands in 712 | # the documentation. 713 | # The default value is: YES. 714 | 715 | GENERATE_DEPRECATEDLIST= YES 716 | 717 | # The ENABLED_SECTIONS tag can be used to enable conditional documentation 718 | # sections, marked by \if ... \endif and \cond 719 | # ... \endcond blocks. 720 | 721 | ENABLED_SECTIONS = 722 | 723 | # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the 724 | # initial value of a variable or macro / define can have for it to appear in the 725 | # documentation. If the initializer consists of more lines than specified here 726 | # it will be hidden. Use a value of 0 to hide initializers completely. The 727 | # appearance of the value of individual variables and macros / defines can be 728 | # controlled using \showinitializer or \hideinitializer command in the 729 | # documentation regardless of this setting. 730 | # Minimum value: 0, maximum value: 10000, default value: 30. 731 | 732 | MAX_INITIALIZER_LINES = 30 733 | 734 | # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at 735 | # the bottom of the documentation of classes and structs. If set to YES, the 736 | # list will mention the files that were used to generate the documentation. 737 | # The default value is: YES. 738 | 739 | SHOW_USED_FILES = NO 740 | 741 | # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This 742 | # will remove the Files entry from the Quick Index and from the Folder Tree View 743 | # (if specified). 744 | # The default value is: YES. 745 | 746 | SHOW_FILES = YES 747 | 748 | # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces 749 | # page. This will remove the Namespaces entry from the Quick Index and from the 750 | # Folder Tree View (if specified). 751 | # The default value is: YES. 752 | 753 | SHOW_NAMESPACES = YES 754 | 755 | # The FILE_VERSION_FILTER tag can be used to specify a program or script that 756 | # doxygen should invoke to get the current version for each file (typically from 757 | # the version control system). Doxygen will invoke the program by executing (via 758 | # popen()) the command command input-file, where command is the value of the 759 | # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided 760 | # by doxygen. Whatever the program writes to standard output is used as the file 761 | # version. For an example see the documentation. 762 | 763 | FILE_VERSION_FILTER = 764 | 765 | # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed 766 | # by doxygen. The layout file controls the global structure of the generated 767 | # output files in an output format independent way. To create the layout file 768 | # that represents doxygen's defaults, run doxygen with the -l option. You can 769 | # optionally specify a file name after the option, if omitted DoxygenLayout.xml 770 | # will be used as the name of the layout file. 771 | # 772 | # Note that if you run doxygen from a directory containing a file called 773 | # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE 774 | # tag is left empty. 775 | 776 | LAYOUT_FILE = 777 | 778 | # The CITE_BIB_FILES tag can be used to specify one or more bib files containing 779 | # the reference definitions. This must be a list of .bib files. The .bib 780 | # extension is automatically appended if omitted. This requires the bibtex tool 781 | # to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. 782 | # For LaTeX the style of the bibliography can be controlled using 783 | # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the 784 | # search path. See also \cite for info how to create references. 785 | 786 | CITE_BIB_FILES = 787 | 788 | #--------------------------------------------------------------------------- 789 | # Configuration options related to warning and progress messages 790 | #--------------------------------------------------------------------------- 791 | 792 | # The QUIET tag can be used to turn on/off the messages that are generated to 793 | # standard output by doxygen. If QUIET is set to YES this implies that the 794 | # messages are off. 795 | # The default value is: NO. 796 | 797 | QUIET = NO 798 | 799 | # The WARNINGS tag can be used to turn on/off the warning messages that are 800 | # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES 801 | # this implies that the warnings are on. 802 | # 803 | # Tip: Turn warnings on while writing the documentation. 804 | # The default value is: YES. 805 | 806 | WARNINGS = YES 807 | 808 | # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate 809 | # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag 810 | # will automatically be disabled. 811 | # The default value is: YES. 812 | 813 | WARN_IF_UNDOCUMENTED = YES 814 | 815 | # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for 816 | # potential errors in the documentation, such as not documenting some parameters 817 | # in a documented function, or documenting parameters that don't exist or using 818 | # markup commands wrongly. 819 | # The default value is: YES. 820 | 821 | WARN_IF_DOC_ERROR = YES 822 | 823 | # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that 824 | # are documented, but have no documentation for their parameters or return 825 | # value. If set to NO, doxygen will only warn about wrong or incomplete 826 | # parameter documentation, but not about the absence of documentation. If 827 | # EXTRACT_ALL is set to YES then this flag will automatically be disabled. 828 | # The default value is: NO. 829 | 830 | WARN_NO_PARAMDOC = NO 831 | 832 | # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when 833 | # a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS 834 | # then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but 835 | # at the end of the doxygen process doxygen will return with a non-zero status. 836 | # Possible values are: NO, YES and FAIL_ON_WARNINGS. 837 | # The default value is: NO. 838 | 839 | WARN_AS_ERROR = NO 840 | 841 | # The WARN_FORMAT tag determines the format of the warning messages that doxygen 842 | # can produce. The string should contain the $file, $line, and $text tags, which 843 | # will be replaced by the file and line number from which the warning originated 844 | # and the warning text. Optionally the format may contain $version, which will 845 | # be replaced by the version of the file (if it could be obtained via 846 | # FILE_VERSION_FILTER) 847 | # The default value is: $file:$line: $text. 848 | 849 | WARN_FORMAT = "$file:$line: $text" 850 | 851 | # The WARN_LOGFILE tag can be used to specify a file to which warning and error 852 | # messages should be written. If left blank the output is written to standard 853 | # error (stderr). 854 | 855 | WARN_LOGFILE = 856 | 857 | #--------------------------------------------------------------------------- 858 | # Configuration options related to the input files 859 | #--------------------------------------------------------------------------- 860 | 861 | # The INPUT tag is used to specify the files and/or directories that contain 862 | # documented source files. You may enter file names like myfile.cpp or 863 | # directories like /usr/src/myproject. Separate the files or directories with 864 | # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING 865 | # Note: If this tag is empty the current directory is searched. 866 | 867 | INPUT = ../../include 868 | 869 | # This tag can be used to specify the character encoding of the source files 870 | # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses 871 | # libiconv (or the iconv built into libc) for the transcoding. See the libiconv 872 | # documentation (see: 873 | # https://www.gnu.org/software/libiconv/) for the list of possible encodings. 874 | # The default value is: UTF-8. 875 | 876 | INPUT_ENCODING = UTF-8 877 | 878 | # If the value of the INPUT tag contains directories, you can use the 879 | # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and 880 | # *.h) to filter out the source-files in the directories. 881 | # 882 | # Note that for custom extensions or not directly supported extensions you also 883 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not 884 | # read by doxygen. 885 | # 886 | # Note the list of default checked file patterns might differ from the list of 887 | # default file extension mappings. 888 | # 889 | # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, 890 | # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, 891 | # *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, 892 | # *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C comment), 893 | # *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd, *.vhdl, 894 | # *.ucf, *.qsf and *.ice. 895 | 896 | FILE_PATTERNS = *.c \ 897 | *.cc \ 898 | *.cxx \ 899 | *.cpp \ 900 | *.c++ \ 901 | *.java \ 902 | *.ii \ 903 | *.ixx \ 904 | *.ipp \ 905 | *.i++ \ 906 | *.inl \ 907 | *.idl \ 908 | *.ddl \ 909 | *.odl \ 910 | *.h \ 911 | *.hh \ 912 | *.hxx \ 913 | *.hpp \ 914 | *.h++ \ 915 | *.cs \ 916 | *.d \ 917 | *.php \ 918 | *.php4 \ 919 | *.php5 \ 920 | *.phtml \ 921 | *.inc \ 922 | *.m \ 923 | *.markdown \ 924 | *.md \ 925 | *.mm \ 926 | *.dox \ 927 | *.py \ 928 | *.pyw \ 929 | *.f90 \ 930 | *.f95 \ 931 | *.f03 \ 932 | *.f08 \ 933 | *.f18 \ 934 | *.f \ 935 | *.for \ 936 | *.vhd \ 937 | *.vhdl \ 938 | *.ucf \ 939 | *.qsf \ 940 | *.ice 941 | 942 | # The RECURSIVE tag can be used to specify whether or not subdirectories should 943 | # be searched for input files as well. 944 | # The default value is: NO. 945 | 946 | RECURSIVE = NO 947 | 948 | # The EXCLUDE tag can be used to specify files and/or directories that should be 949 | # excluded from the INPUT source files. This way you can easily exclude a 950 | # subdirectory from a directory tree whose root is specified with the INPUT tag. 951 | # 952 | # Note that relative paths are relative to the directory from which doxygen is 953 | # run. 954 | 955 | EXCLUDE = 956 | 957 | # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or 958 | # directories that are symbolic links (a Unix file system feature) are excluded 959 | # from the input. 960 | # The default value is: NO. 961 | 962 | EXCLUDE_SYMLINKS = NO 963 | 964 | # If the value of the INPUT tag contains directories, you can use the 965 | # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 966 | # certain files from those directories. 967 | # 968 | # Note that the wildcards are matched against the file with absolute path, so to 969 | # exclude all test directories for example use the pattern */test/* 970 | 971 | EXCLUDE_PATTERNS = 972 | 973 | # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 974 | # (namespaces, classes, functions, etc.) that should be excluded from the 975 | # output. The symbol name can be a fully qualified name, a word, or if the 976 | # wildcard * is used, a substring. Examples: ANamespace, AClass, 977 | # AClass::ANamespace, ANamespace::*Test 978 | # 979 | # Note that the wildcards are matched against the file with absolute path, so to 980 | # exclude all test directories use the pattern */test/* 981 | 982 | EXCLUDE_SYMBOLS = 983 | 984 | # The EXAMPLE_PATH tag can be used to specify one or more files or directories 985 | # that contain example code fragments that are included (see the \include 986 | # command). 987 | 988 | EXAMPLE_PATH = 989 | 990 | # If the value of the EXAMPLE_PATH tag contains directories, you can use the 991 | # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and 992 | # *.h) to filter out the source-files in the directories. If left blank all 993 | # files are included. 994 | 995 | EXAMPLE_PATTERNS = * 996 | 997 | # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 998 | # searched for input files to be used with the \include or \dontinclude commands 999 | # irrespective of the value of the RECURSIVE tag. 1000 | # The default value is: NO. 1001 | 1002 | EXAMPLE_RECURSIVE = NO 1003 | 1004 | # The IMAGE_PATH tag can be used to specify one or more files or directories 1005 | # that contain images that are to be included in the documentation (see the 1006 | # \image command). 1007 | 1008 | IMAGE_PATH = 1009 | 1010 | # The INPUT_FILTER tag can be used to specify a program that doxygen should 1011 | # invoke to filter for each input file. Doxygen will invoke the filter program 1012 | # by executing (via popen()) the command: 1013 | # 1014 | # 1015 | # 1016 | # where is the value of the INPUT_FILTER tag, and is the 1017 | # name of an input file. Doxygen will then use the output that the filter 1018 | # program writes to standard output. If FILTER_PATTERNS is specified, this tag 1019 | # will be ignored. 1020 | # 1021 | # Note that the filter must not add or remove lines; it is applied before the 1022 | # code is scanned, but not when the output code is generated. If lines are added 1023 | # or removed, the anchors will not be placed correctly. 1024 | # 1025 | # Note that for custom extensions or not directly supported extensions you also 1026 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not 1027 | # properly processed by doxygen. 1028 | 1029 | INPUT_FILTER = 1030 | 1031 | # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 1032 | # basis. Doxygen will compare the file name with each pattern and apply the 1033 | # filter if there is a match. The filters are a list of the form: pattern=filter 1034 | # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how 1035 | # filters are used. If the FILTER_PATTERNS tag is empty or if none of the 1036 | # patterns match the file name, INPUT_FILTER is applied. 1037 | # 1038 | # Note that for custom extensions or not directly supported extensions you also 1039 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not 1040 | # properly processed by doxygen. 1041 | 1042 | FILTER_PATTERNS = 1043 | 1044 | # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 1045 | # INPUT_FILTER) will also be used to filter the input files that are used for 1046 | # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). 1047 | # The default value is: NO. 1048 | 1049 | FILTER_SOURCE_FILES = NO 1050 | 1051 | # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file 1052 | # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and 1053 | # it is also possible to disable source filtering for a specific pattern using 1054 | # *.ext= (so without naming a filter). 1055 | # This tag requires that the tag FILTER_SOURCE_FILES is set to YES. 1056 | 1057 | FILTER_SOURCE_PATTERNS = 1058 | 1059 | # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that 1060 | # is part of the input, its contents will be placed on the main page 1061 | # (index.html). This can be useful if you have a project on for instance GitHub 1062 | # and want to reuse the introduction page also for the doxygen output. 1063 | 1064 | USE_MDFILE_AS_MAINPAGE = 1065 | 1066 | #--------------------------------------------------------------------------- 1067 | # Configuration options related to source browsing 1068 | #--------------------------------------------------------------------------- 1069 | 1070 | # If the SOURCE_BROWSER tag is set to YES then a list of source files will be 1071 | # generated. Documented entities will be cross-referenced with these sources. 1072 | # 1073 | # Note: To get rid of all source code in the generated output, make sure that 1074 | # also VERBATIM_HEADERS is set to NO. 1075 | # The default value is: NO. 1076 | 1077 | SOURCE_BROWSER = NO 1078 | 1079 | # Setting the INLINE_SOURCES tag to YES will include the body of functions, 1080 | # classes and enums directly into the documentation. 1081 | # The default value is: NO. 1082 | 1083 | INLINE_SOURCES = NO 1084 | 1085 | # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any 1086 | # special comment blocks from generated source code fragments. Normal C, C++ and 1087 | # Fortran comments will always remain visible. 1088 | # The default value is: YES. 1089 | 1090 | STRIP_CODE_COMMENTS = YES 1091 | 1092 | # If the REFERENCED_BY_RELATION tag is set to YES then for each documented 1093 | # entity all documented functions referencing it will be listed. 1094 | # The default value is: NO. 1095 | 1096 | REFERENCED_BY_RELATION = NO 1097 | 1098 | # If the REFERENCES_RELATION tag is set to YES then for each documented function 1099 | # all documented entities called/used by that function will be listed. 1100 | # The default value is: NO. 1101 | 1102 | REFERENCES_RELATION = NO 1103 | 1104 | # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set 1105 | # to YES then the hyperlinks from functions in REFERENCES_RELATION and 1106 | # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will 1107 | # link to the documentation. 1108 | # The default value is: YES. 1109 | 1110 | REFERENCES_LINK_SOURCE = YES 1111 | 1112 | # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the 1113 | # source code will show a tooltip with additional information such as prototype, 1114 | # brief description and links to the definition and documentation. Since this 1115 | # will make the HTML file larger and loading of large files a bit slower, you 1116 | # can opt to disable this feature. 1117 | # The default value is: YES. 1118 | # This tag requires that the tag SOURCE_BROWSER is set to YES. 1119 | 1120 | SOURCE_TOOLTIPS = YES 1121 | 1122 | # If the USE_HTAGS tag is set to YES then the references to source code will 1123 | # point to the HTML generated by the htags(1) tool instead of doxygen built-in 1124 | # source browser. The htags tool is part of GNU's global source tagging system 1125 | # (see https://www.gnu.org/software/global/global.html). You will need version 1126 | # 4.8.6 or higher. 1127 | # 1128 | # To use it do the following: 1129 | # - Install the latest version of global 1130 | # - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file 1131 | # - Make sure the INPUT points to the root of the source tree 1132 | # - Run doxygen as normal 1133 | # 1134 | # Doxygen will invoke htags (and that will in turn invoke gtags), so these 1135 | # tools must be available from the command line (i.e. in the search path). 1136 | # 1137 | # The result: instead of the source browser generated by doxygen, the links to 1138 | # source code will now point to the output of htags. 1139 | # The default value is: NO. 1140 | # This tag requires that the tag SOURCE_BROWSER is set to YES. 1141 | 1142 | USE_HTAGS = NO 1143 | 1144 | # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a 1145 | # verbatim copy of the header file for each class for which an include is 1146 | # specified. Set to NO to disable this. 1147 | # See also: Section \class. 1148 | # The default value is: YES. 1149 | 1150 | VERBATIM_HEADERS = YES 1151 | 1152 | # If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the 1153 | # clang parser (see: 1154 | # http://clang.llvm.org/) for more accurate parsing at the cost of reduced 1155 | # performance. This can be particularly helpful with template rich C++ code for 1156 | # which doxygen's built-in parser lacks the necessary type information. 1157 | # Note: The availability of this option depends on whether or not doxygen was 1158 | # generated with the -Duse_libclang=ON option for CMake. 1159 | # The default value is: NO. 1160 | 1161 | CLANG_ASSISTED_PARSING = NO 1162 | 1163 | # If clang assisted parsing is enabled you can provide the compiler with command 1164 | # line options that you would normally use when invoking the compiler. Note that 1165 | # the include paths will already be set by doxygen for the files and directories 1166 | # specified with INPUT and INCLUDE_PATH. 1167 | # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. 1168 | 1169 | CLANG_OPTIONS = 1170 | 1171 | # If clang assisted parsing is enabled you can provide the clang parser with the 1172 | # path to the directory containing a file called compile_commands.json. This 1173 | # file is the compilation database (see: 1174 | # http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) containing the 1175 | # options used when the source files were built. This is equivalent to 1176 | # specifying the -p option to a clang tool, such as clang-check. These options 1177 | # will then be passed to the parser. Any options specified with CLANG_OPTIONS 1178 | # will be added as well. 1179 | # Note: The availability of this option depends on whether or not doxygen was 1180 | # generated with the -Duse_libclang=ON option for CMake. 1181 | 1182 | CLANG_DATABASE_PATH = 1183 | 1184 | #--------------------------------------------------------------------------- 1185 | # Configuration options related to the alphabetical class index 1186 | #--------------------------------------------------------------------------- 1187 | 1188 | # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all 1189 | # compounds will be generated. Enable this if the project contains a lot of 1190 | # classes, structs, unions or interfaces. 1191 | # The default value is: YES. 1192 | 1193 | ALPHABETICAL_INDEX = YES 1194 | 1195 | # In case all classes in a project start with a common prefix, all classes will 1196 | # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag 1197 | # can be used to specify a prefix (or a list of prefixes) that should be ignored 1198 | # while generating the index headers. 1199 | # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1200 | 1201 | IGNORE_PREFIX = 1202 | 1203 | #--------------------------------------------------------------------------- 1204 | # Configuration options related to the HTML output 1205 | #--------------------------------------------------------------------------- 1206 | 1207 | # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output 1208 | # The default value is: YES. 1209 | 1210 | GENERATE_HTML = YES 1211 | 1212 | # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a 1213 | # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1214 | # it. 1215 | # The default directory is: html. 1216 | # This tag requires that the tag GENERATE_HTML is set to YES. 1217 | 1218 | HTML_OUTPUT = html 1219 | 1220 | # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each 1221 | # generated HTML page (for example: .htm, .php, .asp). 1222 | # The default value is: .html. 1223 | # This tag requires that the tag GENERATE_HTML is set to YES. 1224 | 1225 | HTML_FILE_EXTENSION = .html 1226 | 1227 | # The HTML_HEADER tag can be used to specify a user-defined HTML header file for 1228 | # each generated HTML page. If the tag is left blank doxygen will generate a 1229 | # standard header. 1230 | # 1231 | # To get valid HTML the header file that includes any scripts and style sheets 1232 | # that doxygen needs, which is dependent on the configuration options used (e.g. 1233 | # the setting GENERATE_TREEVIEW). It is highly recommended to start with a 1234 | # default header using 1235 | # doxygen -w html new_header.html new_footer.html new_stylesheet.css 1236 | # YourConfigFile 1237 | # and then modify the file new_header.html. See also section "Doxygen usage" 1238 | # for information on how to generate the default header that doxygen normally 1239 | # uses. 1240 | # Note: The header is subject to change so you typically have to regenerate the 1241 | # default header when upgrading to a newer version of doxygen. For a description 1242 | # of the possible markers and block names see the documentation. 1243 | # This tag requires that the tag GENERATE_HTML is set to YES. 1244 | 1245 | HTML_HEADER = 1246 | 1247 | # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each 1248 | # generated HTML page. If the tag is left blank doxygen will generate a standard 1249 | # footer. See HTML_HEADER for more information on how to generate a default 1250 | # footer and what special commands can be used inside the footer. See also 1251 | # section "Doxygen usage" for information on how to generate the default footer 1252 | # that doxygen normally uses. 1253 | # This tag requires that the tag GENERATE_HTML is set to YES. 1254 | 1255 | HTML_FOOTER = 1256 | 1257 | # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style 1258 | # sheet that is used by each HTML page. It can be used to fine-tune the look of 1259 | # the HTML output. If left blank doxygen will generate a default style sheet. 1260 | # See also section "Doxygen usage" for information on how to generate the style 1261 | # sheet that doxygen normally uses. 1262 | # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as 1263 | # it is more robust and this tag (HTML_STYLESHEET) will in the future become 1264 | # obsolete. 1265 | # This tag requires that the tag GENERATE_HTML is set to YES. 1266 | 1267 | HTML_STYLESHEET = 1268 | 1269 | # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined 1270 | # cascading style sheets that are included after the standard style sheets 1271 | # created by doxygen. Using this option one can overrule certain style aspects. 1272 | # This is preferred over using HTML_STYLESHEET since it does not replace the 1273 | # standard style sheet and is therefore more robust against future updates. 1274 | # Doxygen will copy the style sheet files to the output directory. 1275 | # Note: The order of the extra style sheet files is of importance (e.g. the last 1276 | # style sheet in the list overrules the setting of the previous ones in the 1277 | # list). For an example see the documentation. 1278 | # This tag requires that the tag GENERATE_HTML is set to YES. 1279 | 1280 | HTML_EXTRA_STYLESHEET = 1281 | 1282 | # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or 1283 | # other source files which should be copied to the HTML output directory. Note 1284 | # that these files will be copied to the base HTML output directory. Use the 1285 | # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these 1286 | # files. In the HTML_STYLESHEET file, use the file name only. Also note that the 1287 | # files will be copied as-is; there are no commands or markers available. 1288 | # This tag requires that the tag GENERATE_HTML is set to YES. 1289 | 1290 | HTML_EXTRA_FILES = 1291 | 1292 | # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen 1293 | # will adjust the colors in the style sheet and background images according to 1294 | # this color. Hue is specified as an angle on a colorwheel, see 1295 | # https://en.wikipedia.org/wiki/Hue for more information. For instance the value 1296 | # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 1297 | # purple, and 360 is red again. 1298 | # Minimum value: 0, maximum value: 359, default value: 220. 1299 | # This tag requires that the tag GENERATE_HTML is set to YES. 1300 | 1301 | HTML_COLORSTYLE_HUE = 220 1302 | 1303 | # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors 1304 | # in the HTML output. For a value of 0 the output will use grayscales only. A 1305 | # value of 255 will produce the most vivid colors. 1306 | # Minimum value: 0, maximum value: 255, default value: 100. 1307 | # This tag requires that the tag GENERATE_HTML is set to YES. 1308 | 1309 | HTML_COLORSTYLE_SAT = 100 1310 | 1311 | # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the 1312 | # luminance component of the colors in the HTML output. Values below 100 1313 | # gradually make the output lighter, whereas values above 100 make the output 1314 | # darker. The value divided by 100 is the actual gamma applied, so 80 represents 1315 | # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not 1316 | # change the gamma. 1317 | # Minimum value: 40, maximum value: 240, default value: 80. 1318 | # This tag requires that the tag GENERATE_HTML is set to YES. 1319 | 1320 | HTML_COLORSTYLE_GAMMA = 80 1321 | 1322 | # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML 1323 | # page will contain the date and time when the page was generated. Setting this 1324 | # to YES can help to show when doxygen was last run and thus if the 1325 | # documentation is up to date. 1326 | # The default value is: NO. 1327 | # This tag requires that the tag GENERATE_HTML is set to YES. 1328 | 1329 | HTML_TIMESTAMP = NO 1330 | 1331 | # If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML 1332 | # documentation will contain a main index with vertical navigation menus that 1333 | # are dynamically created via JavaScript. If disabled, the navigation index will 1334 | # consists of multiple levels of tabs that are statically embedded in every HTML 1335 | # page. Disable this option to support browsers that do not have JavaScript, 1336 | # like the Qt help browser. 1337 | # The default value is: YES. 1338 | # This tag requires that the tag GENERATE_HTML is set to YES. 1339 | 1340 | HTML_DYNAMIC_MENUS = YES 1341 | 1342 | # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 1343 | # documentation will contain sections that can be hidden and shown after the 1344 | # page has loaded. 1345 | # The default value is: NO. 1346 | # This tag requires that the tag GENERATE_HTML is set to YES. 1347 | 1348 | HTML_DYNAMIC_SECTIONS = NO 1349 | 1350 | # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries 1351 | # shown in the various tree structured indices initially; the user can expand 1352 | # and collapse entries dynamically later on. Doxygen will expand the tree to 1353 | # such a level that at most the specified number of entries are visible (unless 1354 | # a fully collapsed tree already exceeds this amount). So setting the number of 1355 | # entries 1 will produce a full collapsed tree by default. 0 is a special value 1356 | # representing an infinite number of entries and will result in a full expanded 1357 | # tree by default. 1358 | # Minimum value: 0, maximum value: 9999, default value: 100. 1359 | # This tag requires that the tag GENERATE_HTML is set to YES. 1360 | 1361 | HTML_INDEX_NUM_ENTRIES = 100 1362 | 1363 | # If the GENERATE_DOCSET tag is set to YES, additional index files will be 1364 | # generated that can be used as input for Apple's Xcode 3 integrated development 1365 | # environment (see: 1366 | # https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To 1367 | # create a documentation set, doxygen will generate a Makefile in the HTML 1368 | # output directory. Running make will produce the docset in that directory and 1369 | # running make install will install the docset in 1370 | # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at 1371 | # startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy 1372 | # genXcode/_index.html for more information. 1373 | # The default value is: NO. 1374 | # This tag requires that the tag GENERATE_HTML is set to YES. 1375 | 1376 | GENERATE_DOCSET = NO 1377 | 1378 | # This tag determines the name of the docset feed. A documentation feed provides 1379 | # an umbrella under which multiple documentation sets from a single provider 1380 | # (such as a company or product suite) can be grouped. 1381 | # The default value is: Doxygen generated docs. 1382 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1383 | 1384 | DOCSET_FEEDNAME = "Doxygen generated docs" 1385 | 1386 | # This tag specifies a string that should uniquely identify the documentation 1387 | # set bundle. This should be a reverse domain-name style string, e.g. 1388 | # com.mycompany.MyDocSet. Doxygen will append .docset to the name. 1389 | # The default value is: org.doxygen.Project. 1390 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1391 | 1392 | DOCSET_BUNDLE_ID = org.doxygen.Project 1393 | 1394 | # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify 1395 | # the documentation publisher. This should be a reverse domain-name style 1396 | # string, e.g. com.mycompany.MyDocSet.documentation. 1397 | # The default value is: org.doxygen.Publisher. 1398 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1399 | 1400 | DOCSET_PUBLISHER_ID = org.doxygen.Publisher 1401 | 1402 | # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. 1403 | # The default value is: Publisher. 1404 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1405 | 1406 | DOCSET_PUBLISHER_NAME = Publisher 1407 | 1408 | # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three 1409 | # additional HTML index files: index.hhp, index.hhc, and index.hhk. The 1410 | # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop 1411 | # (see: 1412 | # https://www.microsoft.com/en-us/download/details.aspx?id=21138) on Windows. 1413 | # 1414 | # The HTML Help Workshop contains a compiler that can convert all HTML output 1415 | # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML 1416 | # files are now used as the Windows 98 help format, and will replace the old 1417 | # Windows help format (.hlp) on all Windows platforms in the future. Compressed 1418 | # HTML files also contain an index, a table of contents, and you can search for 1419 | # words in the documentation. The HTML workshop also contains a viewer for 1420 | # compressed HTML files. 1421 | # The default value is: NO. 1422 | # This tag requires that the tag GENERATE_HTML is set to YES. 1423 | 1424 | GENERATE_HTMLHELP = NO 1425 | 1426 | # The CHM_FILE tag can be used to specify the file name of the resulting .chm 1427 | # file. You can add a path in front of the file if the result should not be 1428 | # written to the html output directory. 1429 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1430 | 1431 | CHM_FILE = 1432 | 1433 | # The HHC_LOCATION tag can be used to specify the location (absolute path 1434 | # including file name) of the HTML help compiler (hhc.exe). If non-empty, 1435 | # doxygen will try to run the HTML help compiler on the generated index.hhp. 1436 | # The file has to be specified with full path. 1437 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1438 | 1439 | HHC_LOCATION = 1440 | 1441 | # The GENERATE_CHI flag controls if a separate .chi index file is generated 1442 | # (YES) or that it should be included in the main .chm file (NO). 1443 | # The default value is: NO. 1444 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1445 | 1446 | GENERATE_CHI = NO 1447 | 1448 | # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) 1449 | # and project file content. 1450 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1451 | 1452 | CHM_INDEX_ENCODING = 1453 | 1454 | # The BINARY_TOC flag controls whether a binary table of contents is generated 1455 | # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it 1456 | # enables the Previous and Next buttons. 1457 | # The default value is: NO. 1458 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1459 | 1460 | BINARY_TOC = NO 1461 | 1462 | # The TOC_EXPAND flag can be set to YES to add extra items for group members to 1463 | # the table of contents of the HTML help documentation and to the tree view. 1464 | # The default value is: NO. 1465 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1466 | 1467 | TOC_EXPAND = NO 1468 | 1469 | # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and 1470 | # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that 1471 | # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help 1472 | # (.qch) of the generated HTML documentation. 1473 | # The default value is: NO. 1474 | # This tag requires that the tag GENERATE_HTML is set to YES. 1475 | 1476 | GENERATE_QHP = NO 1477 | 1478 | # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify 1479 | # the file name of the resulting .qch file. The path specified is relative to 1480 | # the HTML output folder. 1481 | # This tag requires that the tag GENERATE_QHP is set to YES. 1482 | 1483 | QCH_FILE = 1484 | 1485 | # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help 1486 | # Project output. For more information please see Qt Help Project / Namespace 1487 | # (see: 1488 | # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). 1489 | # The default value is: org.doxygen.Project. 1490 | # This tag requires that the tag GENERATE_QHP is set to YES. 1491 | 1492 | QHP_NAMESPACE = org.doxygen.Project 1493 | 1494 | # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt 1495 | # Help Project output. For more information please see Qt Help Project / Virtual 1496 | # Folders (see: 1497 | # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders). 1498 | # The default value is: doc. 1499 | # This tag requires that the tag GENERATE_QHP is set to YES. 1500 | 1501 | QHP_VIRTUAL_FOLDER = doc 1502 | 1503 | # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom 1504 | # filter to add. For more information please see Qt Help Project / Custom 1505 | # Filters (see: 1506 | # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). 1507 | # This tag requires that the tag GENERATE_QHP is set to YES. 1508 | 1509 | QHP_CUST_FILTER_NAME = 1510 | 1511 | # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the 1512 | # custom filter to add. For more information please see Qt Help Project / Custom 1513 | # Filters (see: 1514 | # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). 1515 | # This tag requires that the tag GENERATE_QHP is set to YES. 1516 | 1517 | QHP_CUST_FILTER_ATTRS = 1518 | 1519 | # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this 1520 | # project's filter section matches. Qt Help Project / Filter Attributes (see: 1521 | # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). 1522 | # This tag requires that the tag GENERATE_QHP is set to YES. 1523 | 1524 | QHP_SECT_FILTER_ATTRS = 1525 | 1526 | # The QHG_LOCATION tag can be used to specify the location (absolute path 1527 | # including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to 1528 | # run qhelpgenerator on the generated .qhp file. 1529 | # This tag requires that the tag GENERATE_QHP is set to YES. 1530 | 1531 | QHG_LOCATION = 1532 | 1533 | # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be 1534 | # generated, together with the HTML files, they form an Eclipse help plugin. To 1535 | # install this plugin and make it available under the help contents menu in 1536 | # Eclipse, the contents of the directory containing the HTML and XML files needs 1537 | # to be copied into the plugins directory of eclipse. The name of the directory 1538 | # within the plugins directory should be the same as the ECLIPSE_DOC_ID value. 1539 | # After copying Eclipse needs to be restarted before the help appears. 1540 | # The default value is: NO. 1541 | # This tag requires that the tag GENERATE_HTML is set to YES. 1542 | 1543 | GENERATE_ECLIPSEHELP = NO 1544 | 1545 | # A unique identifier for the Eclipse help plugin. When installing the plugin 1546 | # the directory name containing the HTML and XML files should also have this 1547 | # name. Each documentation set should have its own identifier. 1548 | # The default value is: org.doxygen.Project. 1549 | # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. 1550 | 1551 | ECLIPSE_DOC_ID = org.doxygen.Project 1552 | 1553 | # If you want full control over the layout of the generated HTML pages it might 1554 | # be necessary to disable the index and replace it with your own. The 1555 | # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top 1556 | # of each HTML page. A value of NO enables the index and the value YES disables 1557 | # it. Since the tabs in the index contain the same information as the navigation 1558 | # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. 1559 | # The default value is: NO. 1560 | # This tag requires that the tag GENERATE_HTML is set to YES. 1561 | 1562 | DISABLE_INDEX = YES 1563 | 1564 | # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 1565 | # structure should be generated to display hierarchical information. If the tag 1566 | # value is set to YES, a side panel will be generated containing a tree-like 1567 | # index structure (just like the one that is generated for HTML Help). For this 1568 | # to work a browser that supports JavaScript, DHTML, CSS and frames is required 1569 | # (i.e. any modern browser). Windows users are probably better off using the 1570 | # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can 1571 | # further fine-tune the look of the index. As an example, the default style 1572 | # sheet generated by doxygen has an example that shows how to put an image at 1573 | # the root of the tree instead of the PROJECT_NAME. Since the tree basically has 1574 | # the same information as the tab index, you could consider setting 1575 | # DISABLE_INDEX to YES when enabling this option. 1576 | # The default value is: NO. 1577 | # This tag requires that the tag GENERATE_HTML is set to YES. 1578 | 1579 | GENERATE_TREEVIEW = YES 1580 | 1581 | # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that 1582 | # doxygen will group on one line in the generated HTML documentation. 1583 | # 1584 | # Note that a value of 0 will completely suppress the enum values from appearing 1585 | # in the overview section. 1586 | # Minimum value: 0, maximum value: 20, default value: 4. 1587 | # This tag requires that the tag GENERATE_HTML is set to YES. 1588 | 1589 | ENUM_VALUES_PER_LINE = 4 1590 | 1591 | # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used 1592 | # to set the initial width (in pixels) of the frame in which the tree is shown. 1593 | # Minimum value: 0, maximum value: 1500, default value: 250. 1594 | # This tag requires that the tag GENERATE_HTML is set to YES. 1595 | 1596 | TREEVIEW_WIDTH = 250 1597 | 1598 | # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to 1599 | # external symbols imported via tag files in a separate window. 1600 | # The default value is: NO. 1601 | # This tag requires that the tag GENERATE_HTML is set to YES. 1602 | 1603 | EXT_LINKS_IN_WINDOW = NO 1604 | 1605 | # If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg 1606 | # tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see 1607 | # https://inkscape.org) to generate formulas as SVG images instead of PNGs for 1608 | # the HTML output. These images will generally look nicer at scaled resolutions. 1609 | # Possible values are: png (the default) and svg (looks nicer but requires the 1610 | # pdf2svg or inkscape tool). 1611 | # The default value is: png. 1612 | # This tag requires that the tag GENERATE_HTML is set to YES. 1613 | 1614 | HTML_FORMULA_FORMAT = png 1615 | 1616 | # Use this tag to change the font size of LaTeX formulas included as images in 1617 | # the HTML documentation. When you change the font size after a successful 1618 | # doxygen run you need to manually remove any form_*.png images from the HTML 1619 | # output directory to force them to be regenerated. 1620 | # Minimum value: 8, maximum value: 50, default value: 10. 1621 | # This tag requires that the tag GENERATE_HTML is set to YES. 1622 | 1623 | FORMULA_FONTSIZE = 10 1624 | 1625 | # Use the FORMULA_TRANSPARENT tag to determine whether or not the images 1626 | # generated for formulas are transparent PNGs. Transparent PNGs are not 1627 | # supported properly for IE 6.0, but are supported on all modern browsers. 1628 | # 1629 | # Note that when changing this option you need to delete any form_*.png files in 1630 | # the HTML output directory before the changes have effect. 1631 | # The default value is: YES. 1632 | # This tag requires that the tag GENERATE_HTML is set to YES. 1633 | 1634 | FORMULA_TRANSPARENT = YES 1635 | 1636 | # The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands 1637 | # to create new LaTeX commands to be used in formulas as building blocks. See 1638 | # the section "Including formulas" for details. 1639 | 1640 | FORMULA_MACROFILE = 1641 | 1642 | # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see 1643 | # https://www.mathjax.org) which uses client side JavaScript for the rendering 1644 | # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX 1645 | # installed or if you want to formulas look prettier in the HTML output. When 1646 | # enabled you may also need to install MathJax separately and configure the path 1647 | # to it using the MATHJAX_RELPATH option. 1648 | # The default value is: NO. 1649 | # This tag requires that the tag GENERATE_HTML is set to YES. 1650 | 1651 | USE_MATHJAX = NO 1652 | 1653 | # When MathJax is enabled you can set the default output format to be used for 1654 | # the MathJax output. See the MathJax site (see: 1655 | # http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. 1656 | # Possible values are: HTML-CSS (which is slower, but has the best 1657 | # compatibility), NativeMML (i.e. MathML) and SVG. 1658 | # The default value is: HTML-CSS. 1659 | # This tag requires that the tag USE_MATHJAX is set to YES. 1660 | 1661 | MATHJAX_FORMAT = HTML-CSS 1662 | 1663 | # When MathJax is enabled you need to specify the location relative to the HTML 1664 | # output directory using the MATHJAX_RELPATH option. The destination directory 1665 | # should contain the MathJax.js script. For instance, if the mathjax directory 1666 | # is located at the same level as the HTML output directory, then 1667 | # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax 1668 | # Content Delivery Network so you can quickly see the result without installing 1669 | # MathJax. However, it is strongly recommended to install a local copy of 1670 | # MathJax from https://www.mathjax.org before deployment. 1671 | # The default value is: https://cdn.jsdelivr.net/npm/mathjax@2. 1672 | # This tag requires that the tag USE_MATHJAX is set to YES. 1673 | 1674 | MATHJAX_RELPATH = https://cdn.jsdelivr.net/npm/mathjax@2 1675 | 1676 | # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax 1677 | # extension names that should be enabled during MathJax rendering. For example 1678 | # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols 1679 | # This tag requires that the tag USE_MATHJAX is set to YES. 1680 | 1681 | MATHJAX_EXTENSIONS = 1682 | 1683 | # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces 1684 | # of code that will be used on startup of the MathJax code. See the MathJax site 1685 | # (see: 1686 | # http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an 1687 | # example see the documentation. 1688 | # This tag requires that the tag USE_MATHJAX is set to YES. 1689 | 1690 | MATHJAX_CODEFILE = 1691 | 1692 | # When the SEARCHENGINE tag is enabled doxygen will generate a search box for 1693 | # the HTML output. The underlying search engine uses javascript and DHTML and 1694 | # should work on any modern browser. Note that when using HTML help 1695 | # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) 1696 | # there is already a search function so this one should typically be disabled. 1697 | # For large projects the javascript based search engine can be slow, then 1698 | # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to 1699 | # search using the keyboard; to jump to the search box use + S 1700 | # (what the is depends on the OS and browser, but it is typically 1701 | # , /