├── .appveyor.yml ├── .gitignore ├── .travis.yml ├── LICENSE.md ├── README.md ├── addon_config.mk ├── docs └── Doxyfile ├── example ├── addons.make └── src │ ├── SimpleCountingTask.cpp │ ├── SimpleCountingTask.h │ ├── SimpleTaskProgress.cpp │ ├── SimpleTaskProgress.h │ ├── main.cpp │ ├── ofApp.cpp │ └── ofApp.h ├── example_simple ├── addons.make └── src │ ├── SimpleCountingTask.cpp │ ├── SimpleCountingTask.h │ ├── main.cpp │ ├── ofApp.cpp │ └── ofApp.h ├── libs └── ofxTaskQueue │ └── include │ └── ofx │ ├── TaskQueue.h │ └── TaskQueueEvents.h ├── ofxaddons_thumbnail.png ├── scripts └── ci │ └── install.sh └── src └── ofxTaskQueue.h /.appveyor.yml: -------------------------------------------------------------------------------- 1 | version: 1.0.{build} 2 | os: Visual Studio 2015 RC 3 | 4 | environment: 5 | global: 6 | APPVEYOR_OS_NAME: windows 7 | matrix: 8 | #MSYS2 Building 9 | - platform: x86 10 | BUILDER: MSYS2 11 | 12 | #VisualStudio Building 13 | - platform: x86 14 | BUILDER : VS 15 | BITS: 32 16 | - platform: x64 17 | BUILDER : VS 18 | BITS: 64 19 | 20 | configuration: Debug 21 | shallow_clone: true 22 | clone_depth: 10 23 | init: 24 | - set MAKEFLAGS=-s 25 | - set MSYS2_PATH=c:\msys64 26 | - set CHERE_INVOKING=1 27 | - if "%BUILDER%_%PLATFORM%"=="MSYS2_x86" set MSYSTEM=MINGW32 28 | - if "%BUILDER%_%PLATFORM%"=="MSYS2_x64" set MSYSTEM=MINGW64 29 | - if "%BUILDER%"=="VS" set PATH=C:\Program Files (x86)\MSBuild\14.0\Bin;%PATH% 30 | - cd %APPVEYOR_BUILD_FOLDER%\..\ 31 | - set OF_ROOT=%CD%\openFrameworks 32 | - set OF_ADDON_NAME=%APPVEYOR_PROJECT_NAME% 33 | install: 34 | - git clone --depth=1 --branch=CI-TESTS https://github.com/bakercp/openFrameworks %OF_ROOT% 35 | - cd %OF_ROOT% 36 | - call scripts\ci\addons\install.cmd 37 | build_script: 38 | - cd %OF_ROOT% 39 | - call scripts\ci\addons\build.cmd 40 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | docs/html 2 | docs/tagfile.xml 3 | docs/*.tag 4 | 5 | raw/ 6 | 7 | Project.xcconfig 8 | *.xcodeproj 9 | *.plist 10 | 11 | *.sln 12 | *.vcxproj 13 | *.vcxproj.filters 14 | icon.rc 15 | 16 | *.mode1v3 17 | 18 | # xcode 19 | *.pbxuser 20 | *.perspectivev3 21 | xcuserdata 22 | build 23 | *.app 24 | #*.a 25 | 26 | # OSX 27 | .DS_Store 28 | .AppleDouble 29 | 30 | # codeblocks 31 | *.layout 32 | example/obj 33 | 34 | # Win 35 | *.exe 36 | *.dll 37 | ## Ignore Visual Studio temporary files, build results, and 38 | ## files generated by popular Visual Studio add-ons. 39 | 40 | # User-specific files 41 | *.suo 42 | *.user 43 | *.sln.docstates 44 | 45 | # Build results 46 | 47 | [Dd]ebug/ 48 | [Rr]elease/ 49 | x64/ 50 | build/ 51 | [Bb]in/ 52 | [Oo]bj/ 53 | 54 | # Enable "build/" folder in the NuGet Packages folder since NuGet packages use it for MSBuild targets 55 | !packages/*/build/ 56 | 57 | # MSTest test Results 58 | [Tt]est[Rr]esult*/ 59 | [Bb]uild[Ll]og.* 60 | 61 | *_i.c 62 | *_p.c 63 | *.ilk 64 | *.meta 65 | *.obj 66 | *.pch 67 | *.pdb 68 | *.pgc 69 | *.pgd 70 | *.rsp 71 | *.sbr 72 | *.tlb 73 | *.tli 74 | *.tlh 75 | *.tmp 76 | *.tmp_proj 77 | *.log 78 | *.vspscc 79 | *.vssscc 80 | .builds 81 | *.pidb 82 | *.log 83 | *.scc 84 | 85 | # Visual C++ cache files 86 | ipch/ 87 | *.aps 88 | *.ncb 89 | *.opensdf 90 | *.sdf 91 | *.cachefile 92 | 93 | # Visual Studio profiler 94 | *.psess 95 | *.vsp 96 | *.vspx 97 | 98 | # Guidance Automation Toolkit 99 | *.gpState 100 | 101 | # ReSharper is a .NET coding add-in 102 | _ReSharper*/ 103 | *.[Rr]e[Ss]harper 104 | 105 | # TeamCity is a build add-in 106 | _TeamCity* 107 | 108 | # DotCover is a Code Coverage Tool 109 | *.dotCover 110 | 111 | # NCrunch 112 | *.ncrunch* 113 | .*crunch*.local.xml 114 | 115 | # Installshield output folder 116 | [Ee]xpress/ 117 | 118 | # DocProject is a documentation generator add-in 119 | DocProject/buildhelp/ 120 | DocProject/Help/*.HxT 121 | DocProject/Help/*.HxC 122 | DocProject/Help/*.hhc 123 | DocProject/Help/*.hhk 124 | DocProject/Help/*.hhp 125 | DocProject/Help/Html2 126 | DocProject/Help/html 127 | 128 | # Click-Once directory 129 | publish/ 130 | 131 | # Publish Web Output 132 | *.Publish.xml 133 | *.pubxml 134 | 135 | # NuGet Packages Directory 136 | ## TODO: If you have NuGet Package Restore enabled, uncomment the next line 137 | #packages/ 138 | 139 | # Windows Azure Build Output 140 | csx 141 | *.build.csdef 142 | 143 | # Windows Store app package directory 144 | AppPackages/ 145 | 146 | # Others 147 | sql/ 148 | *.Cache 149 | ClientBin/ 150 | [Ss]tyle[Cc]op.* 151 | ~$* 152 | *~ 153 | *.dbmdl 154 | *.[Pp]ublish.xml 155 | *.pfx 156 | *.publishsettings 157 | 158 | # RIA/Silverlight projects 159 | Generated_Code/ 160 | 161 | # Backup & report files from converting an old project file to a newer 162 | # Visual Studio version. Backup files are not needed, because we have git ;-) 163 | _UpgradeReport_Files/ 164 | Backup*/ 165 | UpgradeLog*.XML 166 | UpgradeLog*.htm 167 | 168 | # SQL Server files 169 | App_Data/*.mdf 170 | App_Data/*.ldf 171 | 172 | # ========================= 173 | # Windows detritus 174 | # ========================= 175 | 176 | # Windows image file caches 177 | Thumbs.db 178 | ehthumbs.db 179 | 180 | # Folder config file 181 | Desktop.ini 182 | 183 | # Recycle Bin used on file shares 184 | $RECYCLE.BIN/ 185 | 186 | # Mac crap 187 | .DS_Store 188 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: c++ 2 | compiler: gcc 3 | sudo: true 4 | matrix: 5 | include: 6 | # fully specify builds, include can't dynamically expand matrix entries 7 | # relative order of sudo and env is important so that addons: is recognized 8 | 9 | # Linux 64bit, OF master 10 | - os: linux 11 | dist: trusty 12 | sudo: required 13 | env: TARGET="linux64" OF_BRANCH="master" 14 | addons: 15 | apt: 16 | sources: 17 | - ubuntu-toolchain-r-test 18 | packages: 19 | - doxygen 20 | - realpath 21 | - gcc-4.9 22 | - g++-4.9 23 | - gdb 24 | 25 | # OSX, OF master 26 | - os: osx 27 | # osx_image: xcode10.1 28 | compiler: clang 29 | env: TARGET="osx" OF_BRANCH="master" 30 | addons: 31 | homebrew: 32 | packages: 33 | - doxygen 34 | update: true 35 | 36 | # before_install: 37 | install: 38 | - git clone --depth=1 --branch=master https://github.com/openFrameworks/openFrameworks.git ~/openFrameworks 39 | - /usr/bin/env bash ~/openFrameworks/scripts/ci/addons/install.sh 40 | - git clone https://github.com/bakercp/ofx.git ~/openFrameworks/scripts/ofx 41 | script: 42 | - /usr/bin/env bash ~/openFrameworks/scripts/ofx/ofx ci script ${TRAVIS_REPO_SLUG#*/} 43 | # after_script: 44 | # after_success: 45 | # after_failure: 46 | 47 | git: 48 | depth: 1 49 | quiet: true 50 | -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2017 Christopher Baker 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | 23 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ofxTaskQueue 2 | ============ 3 | 4 | ## Description 5 | 6 | TaskQueue executes and manages tasks in a multi-threaded environment. 7 | 8 | ## Features 9 | 10 | The `TaskQueue` wraps a `Poco::TaskManager`, `Poco::NotificationQueue` and a `Poco::ThreadPool` to simplify the process of multi-threaded task execution. A "Task" extends `Poco::Task` and is best suited for relatively short-lived 11 | tasks. That said, it simplifies the execution of long-running tasks by coalescing all thread callbacks into a notification queue that is distributed in FIFO order during the `update()` method, thus placing it in the main openFrameworks execution thread. 12 | 13 | The `TaskQueue` makes effort to simplify the process of multi-threaded task execution by placing all Task event notifications within the main operating thread. This prevents the user from worrying about mutexes, thread locking and the associated complexities of accessing shared data from multiple threads. Additionally, by situating all event notifications in the main thread, the `TaskQueue` can be used to complete tasks that require execution in the primary execution thread (e.g. OpenGL calls, texture upload, etc). 14 | 15 | When returning data in a custom event, the user is encouraged to design a system wherein a final piece of process is delivered, ready to be quickly consumed by the listener. For example, if the user schedules web-tasks, the socket stream should be consumed, parsed and packaged before delivery in order keep the main thread moving quickly. Passing "work" back to the main thread defeats the purpose of a multi-threaded queue. 16 | 17 | `TaskQueue` has events for standard task callbacks, starting, cancellation, exceptions, progress and finishing. Additionally the user can define a custom "Data" callback that can be called at any time during thread execution. The user specifies the `DataType` class as a template parameter when creating the `TaskQueue`. This can be a base class. The user is responsible for handling special subclass behaviors. 18 | 19 | Additionally, by overriding `handleUserNotifications` and adding additional events that extend BaseTaskEventArgs (just as TaskDataEventArgs currently does), users can handle an unlimited number of custom data types. 20 | 21 | ## Getting Started 22 | 23 | To get started, generate the example project files using the openFrameworks [Project Generator](http://openframeworks.cc/learning/01_basics/how_to_add_addon_to_project/). 24 | 25 | ## Documentation 26 | 27 | API documentation can be found here. 28 | 29 | ## Build Status 30 | 31 | Linux, macOS [![Build Status](https://travis-ci.org/bakercp/ofxTaskQueue.svg?branch=master)](https://travis-ci.org/bakercp/ofxTaskQueue) 32 | 33 | Visual Studio, MSYS [![Build status](https://ci.appveyor.com/api/projects/status/m85qm425sp177t5p/branch/master?svg=true)](https://ci.appveyor.com/project/bakercp/ofxtaskqueue/branch/master) 34 | 35 | ## Compatibility 36 | 37 | The `stable` branch of this repository is meant to be compatible with the openFrameworks [stable branch](https://github.com/openframeworks/openFrameworks/tree/stable), which corresponds to the latest official openFrameworks release. 38 | 39 | The `master` branch of this repository is meant to be compatible with the openFrameworks [master branch](https://github.com/openframeworks/openFrameworks/tree/master). 40 | 41 | Some past openFrameworks releases are supported via tagged versions, but only `stable` and `master` branches are actively supported. 42 | 43 | ## Versioning 44 | 45 | This project uses Semantic Versioning, although strict adherence will only come into effect at version 1.0.0. 46 | 47 | ## Licensing 48 | 49 | See `LICENSE.md`. 50 | 51 | ## Contributing 52 | 53 | Pull Requests are always welcome, so if you make any improvements please feel free to float them back upstream :) 54 | 55 | 1. Fork this repository. 56 | 2. Create your feature branch (`git checkout -b my-new-feature`). 57 | 3. Commit your changes (`git commit -am 'Add some feature'`). 58 | 4. Push to the branch (`git push origin my-new-feature`). 59 | 5. Create new Pull Request. 60 | -------------------------------------------------------------------------------- /addon_config.mk: -------------------------------------------------------------------------------- 1 | meta: 2 | ADDON_NAME = ofxTaskQueue 3 | ADDON_DESCRIPTION = A multi-threaded task management system. 4 | ADDON_AUTHOR = bakercp 5 | ADDON_TAGS = "threads" "tasks" "taskmanager" 6 | ADDON_URL = http://github.com/bakercp/ofxTaskQueue 7 | common: 8 | ADDON_DEPENDENCIES = ofxPoco 9 | -------------------------------------------------------------------------------- /docs/Doxyfile: -------------------------------------------------------------------------------- 1 | # Doxyfile 1.8.7 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 config file 21 | # that follow. The default is UTF-8 which is also the encoding used for all text 22 | # before the first occurrence of this tag. Doxygen uses libiconv (or the iconv 23 | # built into libc) for the transcoding. See http://www.gnu.org/software/libiconv 24 | # 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 = ofxTaskQueue 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 = 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 = "A multi-threaded task management system." 48 | 49 | # With the PROJECT_LOGO tag one can specify an logo or icon that is included in 50 | # the documentation. The maximum height of the logo should not exceed 55 pixels 51 | # and the maximum width should not exceed 200 pixels. Doxygen will copy the logo 52 | # 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 | # If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member 97 | # descriptions after the members that are listed in the file and class 98 | # documentation (similar to Javadoc). Set to NO to disable this. 99 | # The default value is: YES. 100 | 101 | BRIEF_MEMBER_DESC = YES 102 | 103 | # If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief 104 | # description of a member or function before the detailed description 105 | # 106 | # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 107 | # brief descriptions will be completely suppressed. 108 | # The default value is: YES. 109 | 110 | REPEAT_BRIEF = YES 111 | 112 | # This tag implements a quasi-intelligent brief description abbreviator that is 113 | # used to form the text in various listings. Each string in this list, if found 114 | # as the leading text of the brief description, will be stripped from the text 115 | # and the result, after processing the whole list, is used as the annotated 116 | # text. Otherwise, the brief description is used as-is. If left blank, the 117 | # following values are used ($name is automatically replaced with the name of 118 | # the entity):The $name class, The $name widget, The $name file, is, provides, 119 | # specifies, contains, represents, a, an and the. 120 | 121 | ABBREVIATE_BRIEF = "The $name class" \ 122 | "The $name widget" \ 123 | "The $name file" \ 124 | is \ 125 | provides \ 126 | specifies \ 127 | contains \ 128 | represents \ 129 | a \ 130 | an \ 131 | the 132 | 133 | # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 134 | # doxygen will generate a detailed section even if there is only a brief 135 | # description. 136 | # The default value is: NO. 137 | 138 | ALWAYS_DETAILED_SEC = NO 139 | 140 | # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 141 | # inherited members of a class in the documentation of that class as if those 142 | # members were ordinary class members. Constructors, destructors and assignment 143 | # operators of the base classes will not be shown. 144 | # The default value is: NO. 145 | 146 | INLINE_INHERITED_MEMB = NO 147 | 148 | # If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path 149 | # before files name in the file list and in the header files. If set to NO the 150 | # shortest path that makes the file name unique will be used 151 | # The default value is: YES. 152 | 153 | FULL_PATH_NAMES = NO 154 | 155 | # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. 156 | # Stripping is only done if one of the specified strings matches the left-hand 157 | # part of the path. The tag can be used to show relative paths in the file list. 158 | # If left blank the directory from which doxygen is run is used as the path to 159 | # strip. 160 | # 161 | # Note that you can specify absolute paths here, but also relative paths, which 162 | # will be relative from the directory where doxygen is started. 163 | # This tag requires that the tag FULL_PATH_NAMES is set to YES. 164 | 165 | STRIP_FROM_PATH = 166 | 167 | # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the 168 | # path mentioned in the documentation of a class, which tells the reader which 169 | # header file to include in order to use a class. If left blank only the name of 170 | # the header file containing the class definition is used. Otherwise one should 171 | # specify the list of include paths that are normally passed to the compiler 172 | # using the -I flag. 173 | 174 | STRIP_FROM_INC_PATH = 175 | 176 | # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but 177 | # less readable) file names. This can be useful is your file systems doesn't 178 | # support long names like on DOS, Mac, or CD-ROM. 179 | # The default value is: NO. 180 | 181 | SHORT_NAMES = NO 182 | 183 | # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the 184 | # first line (until the first dot) of a Javadoc-style comment as the brief 185 | # description. If set to NO, the Javadoc-style will behave just like regular Qt- 186 | # style comments (thus requiring an explicit @brief command for a brief 187 | # description.) 188 | # The default value is: NO. 189 | 190 | JAVADOC_AUTOBRIEF = NO 191 | 192 | # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first 193 | # line (until the first dot) of a Qt-style comment as the brief description. If 194 | # set to NO, the Qt-style will behave just like regular Qt-style comments (thus 195 | # requiring an explicit \brief command for a brief description.) 196 | # The default value is: NO. 197 | 198 | QT_AUTOBRIEF = NO 199 | 200 | # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a 201 | # multi-line C++ special comment block (i.e. a block of //! or /// comments) as 202 | # a brief description. This used to be the default behavior. The new default is 203 | # to treat a multi-line C++ comment block as a detailed description. Set this 204 | # tag to YES if you prefer the old behavior instead. 205 | # 206 | # Note that setting this tag to YES also means that rational rose comments are 207 | # not recognized any more. 208 | # The default value is: NO. 209 | 210 | MULTILINE_CPP_IS_BRIEF = NO 211 | 212 | # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the 213 | # documentation from any documented member that it re-implements. 214 | # The default value is: YES. 215 | 216 | INHERIT_DOCS = YES 217 | 218 | # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a 219 | # new page for each member. If set to NO, the documentation of a member will be 220 | # part of the file/class/namespace that contains it. 221 | # The default value is: NO. 222 | 223 | SEPARATE_MEMBER_PAGES = NO 224 | 225 | # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen 226 | # uses this value to replace tabs by spaces in code fragments. 227 | # Minimum value: 1, maximum value: 16, default value: 4. 228 | 229 | TAB_SIZE = 4 230 | 231 | # This tag can be used to specify a number of aliases that act as commands in 232 | # the documentation. An alias has the form: 233 | # name=value 234 | # For example adding 235 | # "sideeffect=@par Side Effects:\n" 236 | # will allow you to put the command \sideeffect (or @sideeffect) in the 237 | # documentation, which will result in a user-defined paragraph with heading 238 | # "Side Effects:". You can put \n's in the value part of an alias to insert 239 | # newlines. 240 | 241 | ALIASES = 242 | 243 | # This tag can be used to specify a number of word-keyword mappings (TCL only). 244 | # A mapping has the form "name=value". For example adding "class=itcl::class" 245 | # will allow you to use the command class in the itcl::class meaning. 246 | 247 | TCL_SUBST = 248 | 249 | # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources 250 | # only. Doxygen will then generate output that is more tailored for C. For 251 | # instance, some of the names that are used will be different. The list of all 252 | # members will be omitted, etc. 253 | # The default value is: NO. 254 | 255 | OPTIMIZE_OUTPUT_FOR_C = NO 256 | 257 | # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or 258 | # Python sources only. Doxygen will then generate output that is more tailored 259 | # for that language. For instance, namespaces will be presented as packages, 260 | # qualified scopes will look different, etc. 261 | # The default value is: NO. 262 | 263 | OPTIMIZE_OUTPUT_JAVA = NO 264 | 265 | # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 266 | # sources. Doxygen will then generate output that is tailored for Fortran. 267 | # The default value is: NO. 268 | 269 | OPTIMIZE_FOR_FORTRAN = NO 270 | 271 | # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 272 | # sources. Doxygen will then generate output that is tailored for VHDL. 273 | # The default value is: NO. 274 | 275 | OPTIMIZE_OUTPUT_VHDL = NO 276 | 277 | # Doxygen selects the parser to use depending on the extension of the files it 278 | # parses. With this tag you can assign which parser to use for a given 279 | # extension. Doxygen has a built-in mapping, but you can override or extend it 280 | # using this tag. The format is ext=language, where ext is a file extension, and 281 | # language is one of the parsers supported by doxygen: IDL, Java, Javascript, 282 | # C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: 283 | # FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: 284 | # Fortran. In the later case the parser tries to guess whether the code is fixed 285 | # or free formatted code, this is the default for Fortran type files), VHDL. For 286 | # instance to make doxygen treat .inc files as Fortran files (default is PHP), 287 | # and .f files as C (default is Fortran), use: inc=Fortran f=C. 288 | # 289 | # Note For files without extension you can use no_extension as a placeholder. 290 | # 291 | # Note that for custom extensions you also need to set FILE_PATTERNS otherwise 292 | # the files are not read by doxygen. 293 | 294 | EXTENSION_MAPPING = 295 | 296 | # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments 297 | # according to the Markdown format, which allows for more readable 298 | # documentation. See http://daringfireball.net/projects/markdown/ for details. 299 | # The output of markdown processing is further processed by doxygen, so you can 300 | # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in 301 | # case of backward compatibilities issues. 302 | # The default value is: YES. 303 | 304 | MARKDOWN_SUPPORT = YES 305 | 306 | # When enabled doxygen tries to link words that correspond to documented 307 | # classes, or namespaces to their corresponding documentation. Such a link can 308 | # be prevented in individual cases by by putting a % sign in front of the word 309 | # or globally by setting AUTOLINK_SUPPORT to NO. 310 | # The default value is: YES. 311 | 312 | AUTOLINK_SUPPORT = YES 313 | 314 | # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 315 | # to include (a tag file for) the STL sources as input, then you should set this 316 | # tag to YES in order to let doxygen match functions declarations and 317 | # definitions whose arguments contain STL classes (e.g. func(std::string); 318 | # versus func(std::string) {}). This also make the inheritance and collaboration 319 | # diagrams that involve STL classes more complete and accurate. 320 | # The default value is: NO. 321 | 322 | BUILTIN_STL_SUPPORT = NO 323 | 324 | # If you use Microsoft's C++/CLI language, you should set this option to YES to 325 | # enable parsing support. 326 | # The default value is: NO. 327 | 328 | CPP_CLI_SUPPORT = NO 329 | 330 | # Set the SIP_SUPPORT tag to YES if your project consists of sip (see: 331 | # http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen 332 | # will parse them like normal C++ but will assume all classes use public instead 333 | # of private inheritance when no explicit protection keyword is present. 334 | # The default value is: NO. 335 | 336 | SIP_SUPPORT = NO 337 | 338 | # For Microsoft's IDL there are propget and propput attributes to indicate 339 | # getter and setter methods for a property. Setting this option to YES will make 340 | # doxygen to replace the get and set methods by a property in the documentation. 341 | # This will only work if the methods are indeed getting or setting a simple 342 | # type. If this is not the case, or you want to show the methods anyway, you 343 | # should set this option to NO. 344 | # The default value is: YES. 345 | 346 | IDL_PROPERTY_SUPPORT = YES 347 | 348 | # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 349 | # tag is set to YES, then doxygen will reuse the documentation of the first 350 | # member in the group (if any) for the other members of the group. By default 351 | # all members of a group must be documented explicitly. 352 | # The default value is: NO. 353 | 354 | DISTRIBUTE_GROUP_DOC = NO 355 | 356 | # Set the SUBGROUPING tag to YES to allow class member groups of the same type 357 | # (for instance a group of public functions) to be put as a subgroup of that 358 | # type (e.g. under the Public Functions section). Set it to NO to prevent 359 | # subgrouping. Alternatively, this can be done per class using the 360 | # \nosubgrouping command. 361 | # The default value is: YES. 362 | 363 | SUBGROUPING = YES 364 | 365 | # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions 366 | # are shown inside the group in which they are included (e.g. using \ingroup) 367 | # instead of on a separate page (for HTML and Man pages) or section (for LaTeX 368 | # and RTF). 369 | # 370 | # Note that this feature does not work in combination with 371 | # SEPARATE_MEMBER_PAGES. 372 | # The default value is: NO. 373 | 374 | INLINE_GROUPED_CLASSES = NO 375 | 376 | # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions 377 | # with only public data fields or simple typedef fields will be shown inline in 378 | # the documentation of the scope in which they are defined (i.e. file, 379 | # namespace, or group documentation), provided this scope is documented. If set 380 | # to NO, structs, classes, and unions are shown on a separate page (for HTML and 381 | # Man pages) or section (for LaTeX and RTF). 382 | # The default value is: NO. 383 | 384 | INLINE_SIMPLE_STRUCTS = NO 385 | 386 | # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or 387 | # enum is documented as struct, union, or enum with the name of the typedef. So 388 | # typedef struct TypeS {} TypeT, will appear in the documentation as a struct 389 | # with name TypeT. When disabled the typedef will appear as a member of a file, 390 | # namespace, or class. And the struct will be named TypeS. This can typically be 391 | # useful for C code in case the coding convention dictates that all compound 392 | # types are typedef'ed and only the typedef is referenced, never the tag name. 393 | # The default value is: NO. 394 | 395 | TYPEDEF_HIDES_STRUCT = NO 396 | 397 | # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This 398 | # cache is used to resolve symbols given their name and scope. Since this can be 399 | # an expensive process and often the same symbol appears multiple times in the 400 | # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small 401 | # doxygen will become slower. If the cache is too large, memory is wasted. The 402 | # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range 403 | # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 404 | # symbols. At the end of a run doxygen will report the cache usage and suggest 405 | # the optimal cache size from a speed point of view. 406 | # Minimum value: 0, maximum value: 9, default value: 0. 407 | 408 | LOOKUP_CACHE_SIZE = 0 409 | 410 | #--------------------------------------------------------------------------- 411 | # Build related configuration options 412 | #--------------------------------------------------------------------------- 413 | 414 | # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 415 | # documentation are documented, even if no documentation was available. Private 416 | # class members and static file members will be hidden unless the 417 | # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. 418 | # Note: This will also disable the warnings about undocumented members that are 419 | # normally produced when WARNINGS is set to YES. 420 | # The default value is: NO. 421 | 422 | EXTRACT_ALL = NO 423 | 424 | # If the EXTRACT_PRIVATE tag is set to YES all private members of a class will 425 | # be included in the documentation. 426 | # The default value is: NO. 427 | 428 | EXTRACT_PRIVATE = NO 429 | 430 | # If the EXTRACT_PACKAGE tag is set to YES all members with package or internal 431 | # scope will be included in the documentation. 432 | # The default value is: NO. 433 | 434 | EXTRACT_PACKAGE = NO 435 | 436 | # If the EXTRACT_STATIC tag is set to YES all static members of a file will be 437 | # included in the documentation. 438 | # The default value is: NO. 439 | 440 | EXTRACT_STATIC = NO 441 | 442 | # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined 443 | # locally in source files will be included in the documentation. If set to NO 444 | # only classes defined in header files are included. Does not have any effect 445 | # for Java sources. 446 | # The default value is: YES. 447 | 448 | EXTRACT_LOCAL_CLASSES = YES 449 | 450 | # This flag is only useful for Objective-C code. When set to YES local methods, 451 | # which are defined in the implementation section but not in the interface are 452 | # included in the documentation. If set to NO only methods in the interface are 453 | # included. 454 | # The default value is: NO. 455 | 456 | EXTRACT_LOCAL_METHODS = NO 457 | 458 | # If this flag is set to YES, the members of anonymous namespaces will be 459 | # extracted and appear in the documentation as a namespace called 460 | # 'anonymous_namespace{file}', where file will be replaced with the base name of 461 | # the file that contains the anonymous namespace. By default anonymous namespace 462 | # are hidden. 463 | # The default value is: NO. 464 | 465 | EXTRACT_ANON_NSPACES = NO 466 | 467 | # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all 468 | # undocumented members inside documented classes or files. If set to NO these 469 | # members will be included in the various overviews, but no documentation 470 | # section is generated. This option has no effect if EXTRACT_ALL is enabled. 471 | # The default value is: NO. 472 | 473 | HIDE_UNDOC_MEMBERS = NO 474 | 475 | # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all 476 | # undocumented classes that are normally visible in the class hierarchy. If set 477 | # to NO these classes will be included in the various overviews. This option has 478 | # no effect if EXTRACT_ALL is enabled. 479 | # The default value is: NO. 480 | 481 | HIDE_UNDOC_CLASSES = NO 482 | 483 | # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend 484 | # (class|struct|union) declarations. If set to NO these declarations will be 485 | # included in the documentation. 486 | # The default value is: NO. 487 | 488 | HIDE_FRIEND_COMPOUNDS = NO 489 | 490 | # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any 491 | # documentation blocks found inside the body of a function. If set to NO these 492 | # blocks will be appended to the function's detailed documentation block. 493 | # The default value is: NO. 494 | 495 | HIDE_IN_BODY_DOCS = NO 496 | 497 | # The INTERNAL_DOCS tag determines if documentation that is typed after a 498 | # \internal command is included. If the tag is set to NO then the documentation 499 | # will be excluded. Set it to YES to include the internal documentation. 500 | # The default value is: NO. 501 | 502 | INTERNAL_DOCS = NO 503 | 504 | # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file 505 | # names in lower-case letters. If set to YES upper-case letters are also 506 | # allowed. This is useful if you have classes or files whose names only differ 507 | # in case and if your file system supports case sensitive file names. Windows 508 | # and Mac users are advised to set this option to NO. 509 | # The default value is: system dependent. 510 | 511 | CASE_SENSE_NAMES = NO 512 | 513 | # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with 514 | # their full class and namespace scopes in the documentation. If set to YES the 515 | # scope will be hidden. 516 | # The default value is: NO. 517 | 518 | HIDE_SCOPE_NAMES = NO 519 | 520 | # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of 521 | # the files that are included by a file in the documentation of that file. 522 | # The default value is: YES. 523 | 524 | SHOW_INCLUDE_FILES = YES 525 | 526 | # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each 527 | # grouped member an include statement to the documentation, telling the reader 528 | # which file to include in order to use the member. 529 | # The default value is: NO. 530 | 531 | SHOW_GROUPED_MEMB_INC = NO 532 | 533 | # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include 534 | # files with double quotes in the documentation rather than with sharp brackets. 535 | # The default value is: NO. 536 | 537 | FORCE_LOCAL_INCLUDES = NO 538 | 539 | # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the 540 | # documentation for inline members. 541 | # The default value is: YES. 542 | 543 | INLINE_INFO = YES 544 | 545 | # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the 546 | # (detailed) documentation of file and class members alphabetically by member 547 | # name. If set to NO the members will appear in declaration order. 548 | # The default value is: YES. 549 | 550 | SORT_MEMBER_DOCS = YES 551 | 552 | # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief 553 | # descriptions of file, namespace and class members alphabetically by member 554 | # name. If set to NO the members will appear in declaration order. Note that 555 | # this will also influence the order of the classes in the class list. 556 | # The default value is: NO. 557 | 558 | SORT_BRIEF_DOCS = NO 559 | 560 | # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the 561 | # (brief and detailed) documentation of class members so that constructors and 562 | # destructors are listed first. If set to NO the constructors will appear in the 563 | # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. 564 | # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief 565 | # member documentation. 566 | # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting 567 | # detailed member documentation. 568 | # The default value is: NO. 569 | 570 | SORT_MEMBERS_CTORS_1ST = NO 571 | 572 | # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy 573 | # of group names into alphabetical order. If set to NO the group names will 574 | # appear in their defined order. 575 | # The default value is: NO. 576 | 577 | SORT_GROUP_NAMES = NO 578 | 579 | # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by 580 | # fully-qualified names, including namespaces. If set to NO, the class list will 581 | # be sorted only by class name, not including the namespace part. 582 | # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 583 | # Note: This option applies only to the class list, not to the alphabetical 584 | # list. 585 | # The default value is: NO. 586 | 587 | SORT_BY_SCOPE_NAME = NO 588 | 589 | # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper 590 | # type resolution of all parameters of a function it will reject a match between 591 | # the prototype and the implementation of a member function even if there is 592 | # only one candidate or it is obvious which candidate to choose by doing a 593 | # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still 594 | # accept a match between prototype and implementation in such cases. 595 | # The default value is: NO. 596 | 597 | STRICT_PROTO_MATCHING = NO 598 | 599 | # The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the 600 | # todo list. This list is created by putting \todo commands in the 601 | # documentation. 602 | # The default value is: YES. 603 | 604 | GENERATE_TODOLIST = YES 605 | 606 | # The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the 607 | # test list. This list is created by putting \test commands in the 608 | # documentation. 609 | # The default value is: YES. 610 | 611 | GENERATE_TESTLIST = YES 612 | 613 | # The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug 614 | # list. This list is created by putting \bug commands in the documentation. 615 | # The default value is: YES. 616 | 617 | GENERATE_BUGLIST = YES 618 | 619 | # The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO) 620 | # the deprecated list. This list is created by putting \deprecated commands in 621 | # the documentation. 622 | # The default value is: YES. 623 | 624 | GENERATE_DEPRECATEDLIST= YES 625 | 626 | # The ENABLED_SECTIONS tag can be used to enable conditional documentation 627 | # sections, marked by \if ... \endif and \cond 628 | # ... \endcond blocks. 629 | 630 | ENABLED_SECTIONS = 631 | 632 | # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the 633 | # initial value of a variable or macro / define can have for it to appear in the 634 | # documentation. If the initializer consists of more lines than specified here 635 | # it will be hidden. Use a value of 0 to hide initializers completely. The 636 | # appearance of the value of individual variables and macros / defines can be 637 | # controlled using \showinitializer or \hideinitializer command in the 638 | # documentation regardless of this setting. 639 | # Minimum value: 0, maximum value: 10000, default value: 30. 640 | 641 | MAX_INITIALIZER_LINES = 30 642 | 643 | # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at 644 | # the bottom of the documentation of classes and structs. If set to YES the list 645 | # will mention the files that were used to generate the documentation. 646 | # The default value is: YES. 647 | 648 | SHOW_USED_FILES = YES 649 | 650 | # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This 651 | # will remove the Files entry from the Quick Index and from the Folder Tree View 652 | # (if specified). 653 | # The default value is: YES. 654 | 655 | SHOW_FILES = YES 656 | 657 | # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces 658 | # page. This will remove the Namespaces entry from the Quick Index and from the 659 | # Folder Tree View (if specified). 660 | # The default value is: YES. 661 | 662 | SHOW_NAMESPACES = YES 663 | 664 | # The FILE_VERSION_FILTER tag can be used to specify a program or script that 665 | # doxygen should invoke to get the current version for each file (typically from 666 | # the version control system). Doxygen will invoke the program by executing (via 667 | # popen()) the command command input-file, where command is the value of the 668 | # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided 669 | # by doxygen. Whatever the program writes to standard output is used as the file 670 | # version. For an example see the documentation. 671 | 672 | FILE_VERSION_FILTER = 673 | 674 | # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed 675 | # by doxygen. The layout file controls the global structure of the generated 676 | # output files in an output format independent way. To create the layout file 677 | # that represents doxygen's defaults, run doxygen with the -l option. You can 678 | # optionally specify a file name after the option, if omitted DoxygenLayout.xml 679 | # will be used as the name of the layout file. 680 | # 681 | # Note that if you run doxygen from a directory containing a file called 682 | # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE 683 | # tag is left empty. 684 | 685 | LAYOUT_FILE = 686 | 687 | # The CITE_BIB_FILES tag can be used to specify one or more bib files containing 688 | # the reference definitions. This must be a list of .bib files. The .bib 689 | # extension is automatically appended if omitted. This requires the bibtex tool 690 | # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. 691 | # For LaTeX the style of the bibliography can be controlled using 692 | # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the 693 | # search path. Do not use file names with spaces, bibtex cannot handle them. See 694 | # also \cite for info how to create references. 695 | 696 | CITE_BIB_FILES = 697 | 698 | #--------------------------------------------------------------------------- 699 | # Configuration options related to warning and progress messages 700 | #--------------------------------------------------------------------------- 701 | 702 | # The QUIET tag can be used to turn on/off the messages that are generated to 703 | # standard output by doxygen. If QUIET is set to YES this implies that the 704 | # messages are off. 705 | # The default value is: NO. 706 | 707 | QUIET = NO 708 | 709 | # The WARNINGS tag can be used to turn on/off the warning messages that are 710 | # generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES 711 | # this implies that the warnings are on. 712 | # 713 | # Tip: Turn warnings on while writing the documentation. 714 | # The default value is: YES. 715 | 716 | WARNINGS = YES 717 | 718 | # If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate 719 | # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag 720 | # will automatically be disabled. 721 | # The default value is: YES. 722 | 723 | WARN_IF_UNDOCUMENTED = YES 724 | 725 | # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for 726 | # potential errors in the documentation, such as not documenting some parameters 727 | # in a documented function, or documenting parameters that don't exist or using 728 | # markup commands wrongly. 729 | # The default value is: YES. 730 | 731 | WARN_IF_DOC_ERROR = YES 732 | 733 | # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that 734 | # are documented, but have no documentation for their parameters or return 735 | # value. If set to NO doxygen will only warn about wrong or incomplete parameter 736 | # documentation, but not about the absence of documentation. 737 | # The default value is: NO. 738 | 739 | WARN_NO_PARAMDOC = NO 740 | 741 | # The WARN_FORMAT tag determines the format of the warning messages that doxygen 742 | # can produce. The string should contain the $file, $line, and $text tags, which 743 | # will be replaced by the file and line number from which the warning originated 744 | # and the warning text. Optionally the format may contain $version, which will 745 | # be replaced by the version of the file (if it could be obtained via 746 | # FILE_VERSION_FILTER) 747 | # The default value is: $file:$line: $text. 748 | 749 | WARN_FORMAT = "$file:$line: $text" 750 | 751 | # The WARN_LOGFILE tag can be used to specify a file to which warning and error 752 | # messages should be written. If left blank the output is written to standard 753 | # error (stderr). 754 | 755 | WARN_LOGFILE = 756 | 757 | #--------------------------------------------------------------------------- 758 | # Configuration options related to the input files 759 | #--------------------------------------------------------------------------- 760 | 761 | # The INPUT tag is used to specify the files and/or directories that contain 762 | # documented source files. You may enter file names like myfile.cpp or 763 | # directories like /usr/src/myproject. Separate the files or directories with 764 | # spaces. 765 | # Note: If this tag is empty the current directory is searched. 766 | 767 | INPUT = ../libs \ 768 | ../src \ 769 | ../README.md 770 | 771 | # This tag can be used to specify the character encoding of the source files 772 | # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses 773 | # libiconv (or the iconv built into libc) for the transcoding. See the libiconv 774 | # documentation (see: http://www.gnu.org/software/libiconv) for the list of 775 | # possible encodings. 776 | # The default value is: UTF-8. 777 | 778 | INPUT_ENCODING = UTF-8 779 | 780 | # If the value of the INPUT tag contains directories, you can use the 781 | # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and 782 | # *.h) to filter out the source-files in the directories. If left blank the 783 | # following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii, 784 | # *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, 785 | # *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, 786 | # *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, 787 | # *.qsf, *.as and *.js. 788 | 789 | FILE_PATTERNS = *.c \ 790 | *.cc \ 791 | *.cxx \ 792 | *.cpp \ 793 | *.c++ \ 794 | *.java \ 795 | *.ii \ 796 | *.ixx \ 797 | *.ipp \ 798 | *.i++ \ 799 | *.inl \ 800 | *.idl \ 801 | *.ddl \ 802 | *.odl \ 803 | *.h \ 804 | *.hh \ 805 | *.hxx \ 806 | *.hpp \ 807 | *.h++ \ 808 | *.cs \ 809 | *.d \ 810 | *.php \ 811 | *.php4 \ 812 | *.php5 \ 813 | *.phtml \ 814 | *.inc \ 815 | *.m \ 816 | *.markdown \ 817 | *.md \ 818 | *.mm \ 819 | *.dox \ 820 | *.py \ 821 | *.f90 \ 822 | *.f \ 823 | *.for \ 824 | *.tcl \ 825 | *.vhd \ 826 | *.vhdl \ 827 | *.ucf \ 828 | *.qsf \ 829 | *.as \ 830 | *.js 831 | 832 | # The RECURSIVE tag can be used to specify whether or not subdirectories should 833 | # be searched for input files as well. 834 | # The default value is: NO. 835 | 836 | RECURSIVE = YES 837 | 838 | # The EXCLUDE tag can be used to specify files and/or directories that should be 839 | # excluded from the INPUT source files. This way you can easily exclude a 840 | # subdirectory from a directory tree whose root is specified with the INPUT tag. 841 | # 842 | # Note that relative paths are relative to the directory from which doxygen is 843 | # run. 844 | 845 | EXCLUDE = 846 | 847 | # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or 848 | # directories that are symbolic links (a Unix file system feature) are excluded 849 | # from the input. 850 | # The default value is: NO. 851 | 852 | EXCLUDE_SYMLINKS = NO 853 | 854 | # If the value of the INPUT tag contains directories, you can use the 855 | # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 856 | # certain files from those directories. 857 | # 858 | # Note that the wildcards are matched against the file with absolute path, so to 859 | # exclude all test directories for example use the pattern */test/* 860 | 861 | EXCLUDE_PATTERNS = 862 | 863 | # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 864 | # (namespaces, classes, functions, etc.) that should be excluded from the 865 | # output. The symbol name can be a fully qualified name, a word, or if the 866 | # wildcard * is used, a substring. Examples: ANamespace, AClass, 867 | # AClass::ANamespace, ANamespace::*Test 868 | # 869 | # Note that the wildcards are matched against the file with absolute path, so to 870 | # exclude all test directories use the pattern */test/* 871 | 872 | EXCLUDE_SYMBOLS = 873 | 874 | # The EXAMPLE_PATH tag can be used to specify one or more files or directories 875 | # that contain example code fragments that are included (see the \include 876 | # command). 877 | 878 | EXAMPLE_PATH = 879 | 880 | # If the value of the EXAMPLE_PATH tag contains directories, you can use the 881 | # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and 882 | # *.h) to filter out the source-files in the directories. If left blank all 883 | # files are included. 884 | 885 | EXAMPLE_PATTERNS = * 886 | 887 | # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 888 | # searched for input files to be used with the \include or \dontinclude commands 889 | # irrespective of the value of the RECURSIVE tag. 890 | # The default value is: NO. 891 | 892 | EXAMPLE_RECURSIVE = NO 893 | 894 | # The IMAGE_PATH tag can be used to specify one or more files or directories 895 | # that contain images that are to be included in the documentation (see the 896 | # \image command). 897 | 898 | IMAGE_PATH = 899 | 900 | # The INPUT_FILTER tag can be used to specify a program that doxygen should 901 | # invoke to filter for each input file. Doxygen will invoke the filter program 902 | # by executing (via popen()) the command: 903 | # 904 | # 905 | # 906 | # where is the value of the INPUT_FILTER tag, and is the 907 | # name of an input file. Doxygen will then use the output that the filter 908 | # program writes to standard output. If FILTER_PATTERNS is specified, this tag 909 | # will be ignored. 910 | # 911 | # Note that the filter must not add or remove lines; it is applied before the 912 | # code is scanned, but not when the output code is generated. If lines are added 913 | # or removed, the anchors will not be placed correctly. 914 | 915 | INPUT_FILTER = 916 | 917 | # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 918 | # basis. Doxygen will compare the file name with each pattern and apply the 919 | # filter if there is a match. The filters are a list of the form: pattern=filter 920 | # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how 921 | # filters are used. If the FILTER_PATTERNS tag is empty or if none of the 922 | # patterns match the file name, INPUT_FILTER is applied. 923 | 924 | FILTER_PATTERNS = 925 | 926 | # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 927 | # INPUT_FILTER ) will also be used to filter the input files that are used for 928 | # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). 929 | # The default value is: NO. 930 | 931 | FILTER_SOURCE_FILES = NO 932 | 933 | # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file 934 | # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and 935 | # it is also possible to disable source filtering for a specific pattern using 936 | # *.ext= (so without naming a filter). 937 | # This tag requires that the tag FILTER_SOURCE_FILES is set to YES. 938 | 939 | FILTER_SOURCE_PATTERNS = 940 | 941 | # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that 942 | # is part of the input, its contents will be placed on the main page 943 | # (index.html). This can be useful if you have a project on for instance GitHub 944 | # and want to reuse the introduction page also for the doxygen output. 945 | 946 | USE_MDFILE_AS_MAINPAGE = README.md 947 | 948 | #--------------------------------------------------------------------------- 949 | # Configuration options related to source browsing 950 | #--------------------------------------------------------------------------- 951 | 952 | # If the SOURCE_BROWSER tag is set to YES then a list of source files will be 953 | # generated. Documented entities will be cross-referenced with these sources. 954 | # 955 | # Note: To get rid of all source code in the generated output, make sure that 956 | # also VERBATIM_HEADERS is set to NO. 957 | # The default value is: NO. 958 | 959 | SOURCE_BROWSER = NO 960 | 961 | # Setting the INLINE_SOURCES tag to YES will include the body of functions, 962 | # classes and enums directly into the documentation. 963 | # The default value is: NO. 964 | 965 | INLINE_SOURCES = NO 966 | 967 | # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any 968 | # special comment blocks from generated source code fragments. Normal C, C++ and 969 | # Fortran comments will always remain visible. 970 | # The default value is: YES. 971 | 972 | STRIP_CODE_COMMENTS = YES 973 | 974 | # If the REFERENCED_BY_RELATION tag is set to YES then for each documented 975 | # function all documented functions referencing it will be listed. 976 | # The default value is: NO. 977 | 978 | REFERENCED_BY_RELATION = NO 979 | 980 | # If the REFERENCES_RELATION tag is set to YES then for each documented function 981 | # all documented entities called/used by that function will be listed. 982 | # The default value is: NO. 983 | 984 | REFERENCES_RELATION = NO 985 | 986 | # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set 987 | # to YES, then the hyperlinks from functions in REFERENCES_RELATION and 988 | # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will 989 | # link to the documentation. 990 | # The default value is: YES. 991 | 992 | REFERENCES_LINK_SOURCE = YES 993 | 994 | # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the 995 | # source code will show a tooltip with additional information such as prototype, 996 | # brief description and links to the definition and documentation. Since this 997 | # will make the HTML file larger and loading of large files a bit slower, you 998 | # can opt to disable this feature. 999 | # The default value is: YES. 1000 | # This tag requires that the tag SOURCE_BROWSER is set to YES. 1001 | 1002 | SOURCE_TOOLTIPS = YES 1003 | 1004 | # If the USE_HTAGS tag is set to YES then the references to source code will 1005 | # point to the HTML generated by the htags(1) tool instead of doxygen built-in 1006 | # source browser. The htags tool is part of GNU's global source tagging system 1007 | # (see http://www.gnu.org/software/global/global.html). You will need version 1008 | # 4.8.6 or higher. 1009 | # 1010 | # To use it do the following: 1011 | # - Install the latest version of global 1012 | # - Enable SOURCE_BROWSER and USE_HTAGS in the config file 1013 | # - Make sure the INPUT points to the root of the source tree 1014 | # - Run doxygen as normal 1015 | # 1016 | # Doxygen will invoke htags (and that will in turn invoke gtags), so these 1017 | # tools must be available from the command line (i.e. in the search path). 1018 | # 1019 | # The result: instead of the source browser generated by doxygen, the links to 1020 | # source code will now point to the output of htags. 1021 | # The default value is: NO. 1022 | # This tag requires that the tag SOURCE_BROWSER is set to YES. 1023 | 1024 | USE_HTAGS = NO 1025 | 1026 | # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a 1027 | # verbatim copy of the header file for each class for which an include is 1028 | # specified. Set to NO to disable this. 1029 | # See also: Section \class. 1030 | # The default value is: YES. 1031 | 1032 | VERBATIM_HEADERS = YES 1033 | 1034 | # If the CLANG_ASSISTED_PARSING tag is set to YES, then doxygen will use the 1035 | # clang parser (see: http://clang.llvm.org/) for more accurate parsing at the 1036 | # cost of reduced performance. This can be particularly helpful with template 1037 | # rich C++ code for which doxygen's built-in parser lacks the necessary type 1038 | # information. 1039 | # Note: The availability of this option depends on whether or not doxygen was 1040 | # compiled with the --with-libclang option. 1041 | # The default value is: NO. 1042 | 1043 | CLANG_ASSISTED_PARSING = NO 1044 | 1045 | # If clang assisted parsing is enabled you can provide the compiler with command 1046 | # line options that you would normally use when invoking the compiler. Note that 1047 | # the include paths will already be set by doxygen for the files and directories 1048 | # specified with INPUT and INCLUDE_PATH. 1049 | # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. 1050 | 1051 | CLANG_OPTIONS = 1052 | 1053 | #--------------------------------------------------------------------------- 1054 | # Configuration options related to the alphabetical class index 1055 | #--------------------------------------------------------------------------- 1056 | 1057 | # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all 1058 | # compounds will be generated. Enable this if the project contains a lot of 1059 | # classes, structs, unions or interfaces. 1060 | # The default value is: YES. 1061 | 1062 | ALPHABETICAL_INDEX = YES 1063 | 1064 | # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in 1065 | # which the alphabetical index list will be split. 1066 | # Minimum value: 1, maximum value: 20, default value: 5. 1067 | # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1068 | 1069 | COLS_IN_ALPHA_INDEX = 5 1070 | 1071 | # In case all classes in a project start with a common prefix, all classes will 1072 | # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag 1073 | # can be used to specify a prefix (or a list of prefixes) that should be ignored 1074 | # while generating the index headers. 1075 | # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1076 | 1077 | IGNORE_PREFIX = 1078 | 1079 | #--------------------------------------------------------------------------- 1080 | # Configuration options related to the HTML output 1081 | #--------------------------------------------------------------------------- 1082 | 1083 | # If the GENERATE_HTML tag is set to YES doxygen will generate HTML output 1084 | # The default value is: YES. 1085 | 1086 | GENERATE_HTML = YES 1087 | 1088 | # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a 1089 | # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1090 | # it. 1091 | # The default directory is: html. 1092 | # This tag requires that the tag GENERATE_HTML is set to YES. 1093 | 1094 | HTML_OUTPUT = html 1095 | 1096 | # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each 1097 | # generated HTML page (for example: .htm, .php, .asp). 1098 | # The default value is: .html. 1099 | # This tag requires that the tag GENERATE_HTML is set to YES. 1100 | 1101 | HTML_FILE_EXTENSION = .html 1102 | 1103 | # The HTML_HEADER tag can be used to specify a user-defined HTML header file for 1104 | # each generated HTML page. If the tag is left blank doxygen will generate a 1105 | # standard header. 1106 | # 1107 | # To get valid HTML the header file that includes any scripts and style sheets 1108 | # that doxygen needs, which is dependent on the configuration options used (e.g. 1109 | # the setting GENERATE_TREEVIEW). It is highly recommended to start with a 1110 | # default header using 1111 | # doxygen -w html new_header.html new_footer.html new_stylesheet.css 1112 | # YourConfigFile 1113 | # and then modify the file new_header.html. See also section "Doxygen usage" 1114 | # for information on how to generate the default header that doxygen normally 1115 | # uses. 1116 | # Note: The header is subject to change so you typically have to regenerate the 1117 | # default header when upgrading to a newer version of doxygen. For a description 1118 | # of the possible markers and block names see the documentation. 1119 | # This tag requires that the tag GENERATE_HTML is set to YES. 1120 | 1121 | HTML_HEADER = 1122 | 1123 | # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each 1124 | # generated HTML page. If the tag is left blank doxygen will generate a standard 1125 | # footer. See HTML_HEADER for more information on how to generate a default 1126 | # footer and what special commands can be used inside the footer. See also 1127 | # section "Doxygen usage" for information on how to generate the default footer 1128 | # that doxygen normally uses. 1129 | # This tag requires that the tag GENERATE_HTML is set to YES. 1130 | 1131 | HTML_FOOTER = 1132 | 1133 | # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style 1134 | # sheet that is used by each HTML page. It can be used to fine-tune the look of 1135 | # the HTML output. If left blank doxygen will generate a default style sheet. 1136 | # See also section "Doxygen usage" for information on how to generate the style 1137 | # sheet that doxygen normally uses. 1138 | # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as 1139 | # it is more robust and this tag (HTML_STYLESHEET) will in the future become 1140 | # obsolete. 1141 | # This tag requires that the tag GENERATE_HTML is set to YES. 1142 | 1143 | HTML_STYLESHEET = 1144 | 1145 | # The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user- 1146 | # defined cascading style sheet that is included after the standard style sheets 1147 | # created by doxygen. Using this option one can overrule certain style aspects. 1148 | # This is preferred over using HTML_STYLESHEET since it does not replace the 1149 | # standard style sheet and is therefor more robust against future updates. 1150 | # Doxygen will copy the style sheet file to the output directory. For an example 1151 | # see the documentation. 1152 | # This tag requires that the tag GENERATE_HTML is set to YES. 1153 | 1154 | HTML_EXTRA_STYLESHEET = 1155 | 1156 | # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or 1157 | # other source files which should be copied to the HTML output directory. Note 1158 | # that these files will be copied to the base HTML output directory. Use the 1159 | # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these 1160 | # files. In the HTML_STYLESHEET file, use the file name only. Also note that the 1161 | # files will be copied as-is; there are no commands or markers available. 1162 | # This tag requires that the tag GENERATE_HTML is set to YES. 1163 | 1164 | HTML_EXTRA_FILES = 1165 | 1166 | # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen 1167 | # will adjust the colors in the stylesheet and background images according to 1168 | # this color. Hue is specified as an angle on a colorwheel, see 1169 | # http://en.wikipedia.org/wiki/Hue for more information. For instance the value 1170 | # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 1171 | # purple, and 360 is red again. 1172 | # Minimum value: 0, maximum value: 359, default value: 220. 1173 | # This tag requires that the tag GENERATE_HTML is set to YES. 1174 | 1175 | HTML_COLORSTYLE_HUE = 220 1176 | 1177 | # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors 1178 | # in the HTML output. For a value of 0 the output will use grayscales only. A 1179 | # value of 255 will produce the most vivid colors. 1180 | # Minimum value: 0, maximum value: 255, default value: 100. 1181 | # This tag requires that the tag GENERATE_HTML is set to YES. 1182 | 1183 | HTML_COLORSTYLE_SAT = 100 1184 | 1185 | # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the 1186 | # luminance component of the colors in the HTML output. Values below 100 1187 | # gradually make the output lighter, whereas values above 100 make the output 1188 | # darker. The value divided by 100 is the actual gamma applied, so 80 represents 1189 | # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not 1190 | # change the gamma. 1191 | # Minimum value: 40, maximum value: 240, default value: 80. 1192 | # This tag requires that the tag GENERATE_HTML is set to YES. 1193 | 1194 | HTML_COLORSTYLE_GAMMA = 80 1195 | 1196 | # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML 1197 | # page will contain the date and time when the page was generated. Setting this 1198 | # to NO can help when comparing the output of multiple runs. 1199 | # The default value is: YES. 1200 | # This tag requires that the tag GENERATE_HTML is set to YES. 1201 | 1202 | HTML_TIMESTAMP = YES 1203 | 1204 | # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 1205 | # documentation will contain sections that can be hidden and shown after the 1206 | # page has loaded. 1207 | # The default value is: NO. 1208 | # This tag requires that the tag GENERATE_HTML is set to YES. 1209 | 1210 | HTML_DYNAMIC_SECTIONS = NO 1211 | 1212 | # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries 1213 | # shown in the various tree structured indices initially; the user can expand 1214 | # and collapse entries dynamically later on. Doxygen will expand the tree to 1215 | # such a level that at most the specified number of entries are visible (unless 1216 | # a fully collapsed tree already exceeds this amount). So setting the number of 1217 | # entries 1 will produce a full collapsed tree by default. 0 is a special value 1218 | # representing an infinite number of entries and will result in a full expanded 1219 | # tree by default. 1220 | # Minimum value: 0, maximum value: 9999, default value: 100. 1221 | # This tag requires that the tag GENERATE_HTML is set to YES. 1222 | 1223 | HTML_INDEX_NUM_ENTRIES = 100 1224 | 1225 | # If the GENERATE_DOCSET tag is set to YES, additional index files will be 1226 | # generated that can be used as input for Apple's Xcode 3 integrated development 1227 | # environment (see: http://developer.apple.com/tools/xcode/), introduced with 1228 | # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a 1229 | # Makefile in the HTML output directory. Running make will produce the docset in 1230 | # that directory and running make install will install the docset in 1231 | # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at 1232 | # startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html 1233 | # for more information. 1234 | # The default value is: NO. 1235 | # This tag requires that the tag GENERATE_HTML is set to YES. 1236 | 1237 | GENERATE_DOCSET = NO 1238 | 1239 | # This tag determines the name of the docset feed. A documentation feed provides 1240 | # an umbrella under which multiple documentation sets from a single provider 1241 | # (such as a company or product suite) can be grouped. 1242 | # The default value is: Doxygen generated docs. 1243 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1244 | 1245 | DOCSET_FEEDNAME = "Doxygen generated docs" 1246 | 1247 | # This tag specifies a string that should uniquely identify the documentation 1248 | # set bundle. This should be a reverse domain-name style string, e.g. 1249 | # com.mycompany.MyDocSet. Doxygen will append .docset to the name. 1250 | # The default value is: org.doxygen.Project. 1251 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1252 | 1253 | DOCSET_BUNDLE_ID = org.doxygen.Project 1254 | 1255 | # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify 1256 | # the documentation publisher. This should be a reverse domain-name style 1257 | # string, e.g. com.mycompany.MyDocSet.documentation. 1258 | # The default value is: org.doxygen.Publisher. 1259 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1260 | 1261 | DOCSET_PUBLISHER_ID = org.doxygen.Publisher 1262 | 1263 | # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. 1264 | # The default value is: Publisher. 1265 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1266 | 1267 | DOCSET_PUBLISHER_NAME = Publisher 1268 | 1269 | # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three 1270 | # additional HTML index files: index.hhp, index.hhc, and index.hhk. The 1271 | # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop 1272 | # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on 1273 | # Windows. 1274 | # 1275 | # The HTML Help Workshop contains a compiler that can convert all HTML output 1276 | # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML 1277 | # files are now used as the Windows 98 help format, and will replace the old 1278 | # Windows help format (.hlp) on all Windows platforms in the future. Compressed 1279 | # HTML files also contain an index, a table of contents, and you can search for 1280 | # words in the documentation. The HTML workshop also contains a viewer for 1281 | # compressed HTML files. 1282 | # The default value is: NO. 1283 | # This tag requires that the tag GENERATE_HTML is set to YES. 1284 | 1285 | GENERATE_HTMLHELP = NO 1286 | 1287 | # The CHM_FILE tag can be used to specify the file name of the resulting .chm 1288 | # file. You can add a path in front of the file if the result should not be 1289 | # written to the html output directory. 1290 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1291 | 1292 | CHM_FILE = 1293 | 1294 | # The HHC_LOCATION tag can be used to specify the location (absolute path 1295 | # including file name) of the HTML help compiler ( hhc.exe). If non-empty 1296 | # doxygen will try to run the HTML help compiler on the generated index.hhp. 1297 | # The file has to be specified with full path. 1298 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1299 | 1300 | HHC_LOCATION = 1301 | 1302 | # The GENERATE_CHI flag controls if a separate .chi index file is generated ( 1303 | # YES) or that it should be included in the master .chm file ( NO). 1304 | # The default value is: NO. 1305 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1306 | 1307 | GENERATE_CHI = NO 1308 | 1309 | # The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc) 1310 | # and project file content. 1311 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1312 | 1313 | CHM_INDEX_ENCODING = 1314 | 1315 | # The BINARY_TOC flag controls whether a binary table of contents is generated ( 1316 | # YES) or a normal table of contents ( NO) in the .chm file. Furthermore it 1317 | # enables the Previous and Next buttons. 1318 | # The default value is: NO. 1319 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1320 | 1321 | BINARY_TOC = NO 1322 | 1323 | # The TOC_EXPAND flag can be set to YES to add extra items for group members to 1324 | # the table of contents of the HTML help documentation and to the tree view. 1325 | # The default value is: NO. 1326 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1327 | 1328 | TOC_EXPAND = NO 1329 | 1330 | # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and 1331 | # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that 1332 | # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help 1333 | # (.qch) of the generated HTML documentation. 1334 | # The default value is: NO. 1335 | # This tag requires that the tag GENERATE_HTML is set to YES. 1336 | 1337 | GENERATE_QHP = NO 1338 | 1339 | # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify 1340 | # the file name of the resulting .qch file. The path specified is relative to 1341 | # the HTML output folder. 1342 | # This tag requires that the tag GENERATE_QHP is set to YES. 1343 | 1344 | QCH_FILE = 1345 | 1346 | # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help 1347 | # Project output. For more information please see Qt Help Project / Namespace 1348 | # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). 1349 | # The default value is: org.doxygen.Project. 1350 | # This tag requires that the tag GENERATE_QHP is set to YES. 1351 | 1352 | QHP_NAMESPACE = org.doxygen.Project 1353 | 1354 | # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt 1355 | # Help Project output. For more information please see Qt Help Project / Virtual 1356 | # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- 1357 | # folders). 1358 | # The default value is: doc. 1359 | # This tag requires that the tag GENERATE_QHP is set to YES. 1360 | 1361 | QHP_VIRTUAL_FOLDER = doc 1362 | 1363 | # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom 1364 | # filter to add. For more information please see Qt Help Project / Custom 1365 | # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- 1366 | # filters). 1367 | # This tag requires that the tag GENERATE_QHP is set to YES. 1368 | 1369 | QHP_CUST_FILTER_NAME = 1370 | 1371 | # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the 1372 | # custom filter to add. For more information please see Qt Help Project / Custom 1373 | # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- 1374 | # filters). 1375 | # This tag requires that the tag GENERATE_QHP is set to YES. 1376 | 1377 | QHP_CUST_FILTER_ATTRS = 1378 | 1379 | # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this 1380 | # project's filter section matches. Qt Help Project / Filter Attributes (see: 1381 | # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). 1382 | # This tag requires that the tag GENERATE_QHP is set to YES. 1383 | 1384 | QHP_SECT_FILTER_ATTRS = 1385 | 1386 | # The QHG_LOCATION tag can be used to specify the location of Qt's 1387 | # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the 1388 | # generated .qhp file. 1389 | # This tag requires that the tag GENERATE_QHP is set to YES. 1390 | 1391 | QHG_LOCATION = 1392 | 1393 | # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be 1394 | # generated, together with the HTML files, they form an Eclipse help plugin. To 1395 | # install this plugin and make it available under the help contents menu in 1396 | # Eclipse, the contents of the directory containing the HTML and XML files needs 1397 | # to be copied into the plugins directory of eclipse. The name of the directory 1398 | # within the plugins directory should be the same as the ECLIPSE_DOC_ID value. 1399 | # After copying Eclipse needs to be restarted before the help appears. 1400 | # The default value is: NO. 1401 | # This tag requires that the tag GENERATE_HTML is set to YES. 1402 | 1403 | GENERATE_ECLIPSEHELP = NO 1404 | 1405 | # A unique identifier for the Eclipse help plugin. When installing the plugin 1406 | # the directory name containing the HTML and XML files should also have this 1407 | # name. Each documentation set should have its own identifier. 1408 | # The default value is: org.doxygen.Project. 1409 | # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. 1410 | 1411 | ECLIPSE_DOC_ID = org.doxygen.Project 1412 | 1413 | # If you want full control over the layout of the generated HTML pages it might 1414 | # be necessary to disable the index and replace it with your own. The 1415 | # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top 1416 | # of each HTML page. A value of NO enables the index and the value YES disables 1417 | # it. Since the tabs in the index contain the same information as the navigation 1418 | # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. 1419 | # The default value is: NO. 1420 | # This tag requires that the tag GENERATE_HTML is set to YES. 1421 | 1422 | DISABLE_INDEX = NO 1423 | 1424 | # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 1425 | # structure should be generated to display hierarchical information. If the tag 1426 | # value is set to YES, a side panel will be generated containing a tree-like 1427 | # index structure (just like the one that is generated for HTML Help). For this 1428 | # to work a browser that supports JavaScript, DHTML, CSS and frames is required 1429 | # (i.e. any modern browser). Windows users are probably better off using the 1430 | # HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can 1431 | # further fine-tune the look of the index. As an example, the default style 1432 | # sheet generated by doxygen has an example that shows how to put an image at 1433 | # the root of the tree instead of the PROJECT_NAME. Since the tree basically has 1434 | # the same information as the tab index, you could consider setting 1435 | # DISABLE_INDEX to YES when enabling this option. 1436 | # The default value is: NO. 1437 | # This tag requires that the tag GENERATE_HTML is set to YES. 1438 | 1439 | GENERATE_TREEVIEW = YES 1440 | 1441 | # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that 1442 | # doxygen will group on one line in the generated HTML documentation. 1443 | # 1444 | # Note that a value of 0 will completely suppress the enum values from appearing 1445 | # in the overview section. 1446 | # Minimum value: 0, maximum value: 20, default value: 4. 1447 | # This tag requires that the tag GENERATE_HTML is set to YES. 1448 | 1449 | ENUM_VALUES_PER_LINE = 4 1450 | 1451 | # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used 1452 | # to set the initial width (in pixels) of the frame in which the tree is shown. 1453 | # Minimum value: 0, maximum value: 1500, default value: 250. 1454 | # This tag requires that the tag GENERATE_HTML is set to YES. 1455 | 1456 | TREEVIEW_WIDTH = 250 1457 | 1458 | # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to 1459 | # external symbols imported via tag files in a separate window. 1460 | # The default value is: NO. 1461 | # This tag requires that the tag GENERATE_HTML is set to YES. 1462 | 1463 | EXT_LINKS_IN_WINDOW = NO 1464 | 1465 | # Use this tag to change the font size of LaTeX formulas included as images in 1466 | # the HTML documentation. When you change the font size after a successful 1467 | # doxygen run you need to manually remove any form_*.png images from the HTML 1468 | # output directory to force them to be regenerated. 1469 | # Minimum value: 8, maximum value: 50, default value: 10. 1470 | # This tag requires that the tag GENERATE_HTML is set to YES. 1471 | 1472 | FORMULA_FONTSIZE = 10 1473 | 1474 | # Use the FORMULA_TRANPARENT tag to determine whether or not the images 1475 | # generated for formulas are transparent PNGs. Transparent PNGs are not 1476 | # supported properly for IE 6.0, but are supported on all modern browsers. 1477 | # 1478 | # Note that when changing this option you need to delete any form_*.png files in 1479 | # the HTML output directory before the changes have effect. 1480 | # The default value is: YES. 1481 | # This tag requires that the tag GENERATE_HTML is set to YES. 1482 | 1483 | FORMULA_TRANSPARENT = YES 1484 | 1485 | # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see 1486 | # http://www.mathjax.org) which uses client side Javascript for the rendering 1487 | # instead of using prerendered bitmaps. Use this if you do not have LaTeX 1488 | # installed or if you want to formulas look prettier in the HTML output. When 1489 | # enabled you may also need to install MathJax separately and configure the path 1490 | # to it using the MATHJAX_RELPATH option. 1491 | # The default value is: NO. 1492 | # This tag requires that the tag GENERATE_HTML is set to YES. 1493 | 1494 | USE_MATHJAX = NO 1495 | 1496 | # When MathJax is enabled you can set the default output format to be used for 1497 | # the MathJax output. See the MathJax site (see: 1498 | # http://docs.mathjax.org/en/latest/output.html) for more details. 1499 | # Possible values are: HTML-CSS (which is slower, but has the best 1500 | # compatibility), NativeMML (i.e. MathML) and SVG. 1501 | # The default value is: HTML-CSS. 1502 | # This tag requires that the tag USE_MATHJAX is set to YES. 1503 | 1504 | MATHJAX_FORMAT = HTML-CSS 1505 | 1506 | # When MathJax is enabled you need to specify the location relative to the HTML 1507 | # output directory using the MATHJAX_RELPATH option. The destination directory 1508 | # should contain the MathJax.js script. For instance, if the mathjax directory 1509 | # is located at the same level as the HTML output directory, then 1510 | # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax 1511 | # Content Delivery Network so you can quickly see the result without installing 1512 | # MathJax. However, it is strongly recommended to install a local copy of 1513 | # MathJax from http://www.mathjax.org before deployment. 1514 | # The default value is: http://cdn.mathjax.org/mathjax/latest. 1515 | # This tag requires that the tag USE_MATHJAX is set to YES. 1516 | 1517 | MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest 1518 | 1519 | # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax 1520 | # extension names that should be enabled during MathJax rendering. For example 1521 | # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols 1522 | # This tag requires that the tag USE_MATHJAX is set to YES. 1523 | 1524 | MATHJAX_EXTENSIONS = 1525 | 1526 | # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces 1527 | # of code that will be used on startup of the MathJax code. See the MathJax site 1528 | # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an 1529 | # example see the documentation. 1530 | # This tag requires that the tag USE_MATHJAX is set to YES. 1531 | 1532 | MATHJAX_CODEFILE = 1533 | 1534 | # When the SEARCHENGINE tag is enabled doxygen will generate a search box for 1535 | # the HTML output. The underlying search engine uses javascript and DHTML and 1536 | # should work on any modern browser. Note that when using HTML help 1537 | # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) 1538 | # there is already a search function so this one should typically be disabled. 1539 | # For large projects the javascript based search engine can be slow, then 1540 | # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to 1541 | # search using the keyboard; to jump to the search box use + S 1542 | # (what the is depends on the OS and browser, but it is typically 1543 | # , /