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