├── .gitignore ├── .gitmodules ├── docs ├── mainpage.dox └── Doxyfile ├── retroshare-chatserver └── src │ ├── MinimalNotify.h │ ├── MinimalNotify.cpp │ ├── chatserver.pro │ ├── chatserver.h │ ├── main.cpp │ └── chatserver.cpp ├── RetroShare.pro ├── README.md └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | # Compiled Object files 2 | *.slo 3 | *.lo 4 | *.o 5 | 6 | # Compiled Dynamic libraries 7 | *.so 8 | *.dylib 9 | 10 | # Compiled Static libraries 11 | *.lai 12 | *.la 13 | *.a 14 | -------------------------------------------------------------------------------- /.gitmodules: -------------------------------------------------------------------------------- 1 | [submodule "html"] 2 | path = html 3 | url = git@github.com:RetroShare/ChatServer.git 4 | branch = gh-pages 5 | [submodule "retroshare"] 6 | shallow = true 7 | path = retroshare 8 | url = https://github.com/RetroShare/RetroShare.git 9 | -------------------------------------------------------------------------------- /docs/mainpage.dox: -------------------------------------------------------------------------------- 1 | /** 2 | @brief Documentation for the RetroShare Chatserver Sources 3 | @author cave beat 4 | @file 5 | */ 6 | /** @defgroup RetroShare */ 7 | /** 8 | @mainpage RetroShare Chatserver 9 | I am doing this to have some documentation for the chatserver. 10 | How it works, how to setup. 11 | */ 12 | -------------------------------------------------------------------------------- /retroshare-chatserver/src/MinimalNotify.h: -------------------------------------------------------------------------------- 1 | /* 2 | * MinimalNotify.h 3 | * 4 | * Created on: Feb 14, 2013 5 | * Author: klaus 6 | */ 7 | 8 | #ifndef MINIMALNOTIFY_H_ 9 | #define MINIMALNOTIFY_H_ 10 | 11 | #include 12 | #include 13 | #include 14 | 15 | 16 | // discard all notifications, only the "askForPassword" needed for startup 17 | class NotifyTxt : public NotifyClient 18 | { 19 | public: 20 | bool askForPassword(const std::string& title, const std::string&, bool, std::string& password, bool& cancel); 21 | }; 22 | 23 | #endif /* MINIMALNOTIFY_H_ */ 24 | -------------------------------------------------------------------------------- /RetroShare.pro: -------------------------------------------------------------------------------- 1 | !include("retroshare/retroshare.pri"): error("Could not include file retroshare/retroshare.pri") 2 | 3 | TEMPLATE = subdirs 4 | 5 | SUBDIRS += openpgpsdk 6 | openpgpsdk.file = openpgpsdk/src/openpgpsdk.pro 7 | 8 | SUBDIRS += libbitdht 9 | libbitdht.file = libbitdht/src/libbitdht.pro 10 | 11 | SUBDIRS += libretroshare 12 | libretroshare.file = libretroshare/src/libretroshare.pro 13 | libretroshare.depends = openpgpsdk libbitdht 14 | 15 | SUBDIRS += retroshare_chatserver 16 | retroshare_chatserver.file = retroshare-chatserver/src/chatserver.pro 17 | retroshare_chatserver.depends = libretroshare 18 | retroshare_chatserver.target = retroshare_chatserver 19 | -------------------------------------------------------------------------------- /retroshare-chatserver/src/MinimalNotify.cpp: -------------------------------------------------------------------------------- 1 | /* 2 | * MinimalNotify.cpp 3 | * 4 | * Created on: Feb 14, 2013 5 | * Author: klaus 6 | */ 7 | 8 | #include "MinimalNotify.h" 9 | 10 | #include 11 | #include 12 | 13 | 14 | #ifdef WINDOWS_SYS 15 | #include 16 | #include 17 | 18 | #define PASS_MAX 512 19 | 20 | char *getpass (const char *prompt) 21 | { 22 | static char getpassbuf [PASS_MAX + 1]; 23 | size_t i = 0; 24 | int c; 25 | 26 | if (prompt) { 27 | fputs (prompt, stderr); 28 | fflush (stderr); 29 | } 30 | 31 | for (;;) { 32 | c = _getch (); 33 | if (c == '\r') { 34 | getpassbuf [i] = '\0'; 35 | break; 36 | } 37 | else if (i < PASS_MAX) { 38 | getpassbuf[i++] = c; 39 | } 40 | 41 | if (i >= PASS_MAX) { 42 | getpassbuf [i] = '\0'; 43 | break; 44 | } 45 | } 46 | 47 | if (prompt) { 48 | fputs ("\r\n", stderr); 49 | fflush (stderr); 50 | } 51 | 52 | return getpassbuf; 53 | } 54 | #endif 55 | 56 | bool NotifyTxt::askForPassword(const std::string& title, const std::string& /*question*/, bool /*prev_is_bad*/, std::string& password, bool& cancel) 57 | { 58 | char *passwd = getpass(("Please enter GPG password for key " + title + ": ").c_str()) ; 59 | password = passwd; 60 | cancel = false; 61 | return !password.empty(); 62 | } 63 | 64 | 65 | -------------------------------------------------------------------------------- /retroshare-chatserver/src/chatserver.pro: -------------------------------------------------------------------------------- 1 | !include("../../retroshare/retroshare.pri"): error("Could not include file ../../retroshare/retroshare.pri") 2 | 3 | # warning: I have crippled this file, guess it'll work only on Linux 32/64bit now 4 | 5 | TEMPLATE = app 6 | TARGET = retroshare-chatserver 7 | CONFIG += bitdht 8 | 9 | 10 | QMAKE_CXXFLAGS += -std=c++0x 11 | 12 | CONFIG += debug 13 | debug { 14 | QMAKE_CFLAGS -= -O2 15 | QMAKE_CFLAGS += -O0 16 | QMAKE_CFLAGS += -g 17 | 18 | QMAKE_CXXFLAGS -= -O2 19 | QMAKE_CXXFLAGS += -O0 20 | QMAKE_CXXFLAGS += -g 21 | } 22 | 23 | ################################# Linux ########################################## 24 | linux-* { 25 | #CONFIG += version_detail_bash_script 26 | QMAKE_CXXFLAGS *= -D_FILE_OFFSET_BITS=64 27 | 28 | LIBS += ../../libretroshare/src/lib/libretroshare.a 29 | LIBS += ../../openpgpsdk/src/lib/libops.a -lbz2 30 | LIBS += -lssl -lupnp -lixml -lgnome-keyring 31 | LIBS *= -lcrypto -ldl -lz 32 | 33 | SQLCIPHER_OK = $$system(pkg-config --exists sqlcipher && echo yes) 34 | isEmpty(SQLCIPHER_OK) { 35 | # We need a explicit path here, to force using the home version of sqlite3 that really encrypts the database. 36 | 37 | exists(../../../lib/sqlcipher/.libs/libsqlcipher.a) { 38 | 39 | LIBS += ../../../lib/sqlcipher/.libs/libsqlcipher.a 40 | DEPENDPATH += ../../../lib/sqlcipher/src/ 41 | INCLUDEPATH += ../../../lib/sqlcipher/src/ 42 | DEPENDPATH += ../../../lib/sqlcipher/tsrc/ 43 | INCLUDEPATH += ../../../lib/sqlcipher/tsrc/ 44 | } else { 45 | message(libsqlcipher.a not found. Compilation will not use SQLCIPHER. Database will be unencrypted.) 46 | DEFINES *= NO_SQLCIPHER 47 | LIBS *= -lsqlite3 48 | } 49 | 50 | } else { 51 | LIBS += -lsqlcipher 52 | } 53 | } 54 | 55 | linux-g++ { 56 | OBJECTS_DIR = temp/linux-g++/obj 57 | } 58 | 59 | linux-g++-64 { 60 | OBJECTS_DIR = temp/linux-g++-64/obj 61 | } 62 | ############################## Common stuff ###################################### 63 | 64 | # bitdht config 65 | bitdht { 66 | LIBS += ../../libbitdht/src/lib/libbitdht.a 67 | } 68 | 69 | DEPENDPATH += ../../libretroshare/src 70 | 71 | INCLUDEPATH += . ../../libretroshare/src 72 | 73 | # Input 74 | HEADERS += *.h 75 | SOURCES += *.cpp 76 | 77 | 78 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | retroshare-chatserver 2 | ===================== 3 | This is a chat intro server for RetroShare, which (hopefully) deals with 4 | the issues the current one from retroshare-nogui has. 5 | 6 | How the chatserver works: 7 | - adds all certificates in a given, hardcoded directory, after adding it 8 | deletes them 9 | - all added PGP ids are stored in a list, which is saved on disk 10 | (chatserver_temporary_friends.txt) 11 | - if a hardcoded number of friends is reached, the oldest gpgIDs are denied 12 | as friends 13 | - after some startup time, the chatserver looks for visible chatlobbies and 14 | joins them, if he can still see e.g. the lobby "Chatserver DE" 15 | - if the lobbys can't be joined, it creates new ones 16 | 17 | How to setup: 18 | - download the git repo 19 | ```bash 20 | mkdir ~/retroshare-chatserver 21 | cd ~/retroshare-chatserver 22 | git clone https://github.com/RetroShare/ChatServer.git trunk 23 | cd trunk 24 | git submodule update --init 25 | ``` 26 | - change hardcoded constants in chatserver.h to what you want to, compile 27 | with 28 | ```bash 29 | qmake CONFIG+=rs_chatserver && make 30 | ``` 31 | - setup an account with retroshare-gui as usual, perhaps add some friends 32 | which always will be allowed to connect (leeching lobbys and distributing 33 | the chatserver lobbys even more far) 34 | - copy config folder to server 35 | - create the folder certificateFolder and the file chatserver_temporary_friends.txt 36 | (hardcoded in chatserver.h!) 37 | - start with ./retroshare-chatserver -c configfolder 38 | - setup w2c as webinterface, see https://github.com/cavebeat/rs-w2c 39 | - make sure everything is correct with your permissions! 40 | 41 | Paths: 42 | - created Folders in ~/.retroshare 43 | - ~/.retroshare/chatserver This is where the files of chatserver are stored 44 | - ~/.retroshare/chatserver/NEWCERTS This is where www-data is storing entered pgp certificates 45 | - ~/.retroshare/chatserver/STORAGE This is where the serverkey, lobbys and a hyperlink are stored 46 | 47 | Files: 48 | - the file serverkey.txt is stored in ~/.retroshare/chatserver/STORAGE and holds the RetroShare public certificate which is displayed in php frontend 49 | - friendfifo.txt is stored in ~/.retroshare/chatserver/ and holds the FIFO Slots. chatserver reads them and deletes oldes entry from friendlist if there are more than 100 lines. 50 | - PHP Frontend https://github.com/cavebeat/rs-w2c/ stores all new certificates in ~/.retroshare/chatserver/NEWCERTS/ 51 | chatserver reads all new pgp certificates from this directory and adds them to friendlist. And adds a line to ~/.retroshare/chatserver/friendfifo.txt 52 | -------------------------------------------------------------------------------- /retroshare-chatserver/src/chatserver.h: -------------------------------------------------------------------------------- 1 | #ifndef __CHATSERVER_H 2 | #define __CHATSERVER_H 3 | 4 | // directory iteration, linux only! 5 | #include 6 | #include 7 | #include 8 | #include 9 | 10 | #include 11 | #include 12 | #include 13 | #include 14 | #include 15 | #include 16 | #include 17 | #include 18 | #include 19 | 20 | /* 21 | * "certificatePath" needs to be an empty directory 22 | * The web interface puts all incoming certificates into this path. 23 | * this chatserver program reads them, adds them and deletes them afterwards, so check permissions! 24 | * the "temporaryFriendsFile" is only a txt file with gpg-ids in it. 25 | * Don't make temporaryFriendsFile accessible from outside, as it would reveal all current accepted gpg ids. 26 | * if there are more than "maxFriends" gpg ids, the oldest one is removed from the accepted list. 27 | */ 28 | static std::string certificatePath = "~/.retroshare/chatserver/NEWCERTS/"; // must end with a slash ! 29 | static std::string storagePath = "~/.retroshare/chatserver/STORAGE/"; // must end with a slash ! 30 | static std::string temporaryFriendsFile = "~/.retroshare/chatserver/friend_fifo.txt"; 31 | const std::string name = "Chatserver"; 32 | 33 | class Chatserver 34 | { 35 | public: 36 | Chatserver( 37 | RsGxsId id, 38 | const unsigned int checkForNewCertsInterval = 30, 39 | const unsigned int maxFriends = 100, 40 | const unsigned int ticksUntilLobbiesAreCreated = 120); 41 | void tick(); 42 | ~Chatserver(); 43 | protected: 44 | const unsigned int checkForNewCertsInterval; 45 | /** max numbers of friends 46 | this should be limited to 50 - 150 users, 47 | so the load of the chatserver does not get too high because of too much connections. 48 | and the users get kicked from time to time and are forced to create their own meshnet*/ 49 | const unsigned int maxFriends; 50 | const unsigned int ticksUntilLobbiesAreCreated; 51 | unsigned int tickCounter; 52 | const RsGxsId ownId; 53 | 54 | void checkForNewCertificates(); 55 | void removeOldestFriend(); 56 | void removeAllFriends(); 57 | 58 | void deployOwnCert(); 59 | 60 | // called after some startup time, see "ticksUntilLobbysAreCreated" 61 | void createOrRejoinLobbys(); 62 | void createOrRejoinLobby(const std::string lobbyName, const std::string lobbyTopic, const std::vector &publicLobbies); 63 | void createOrRejoinLobby(const std::string lobbyName, const std::string lobbyTopic, const std::string lobbyId, const std::vector &publicLobbies); 64 | 65 | std::list friends; 66 | size_t numberOfFriends() { return friends.size(); } 67 | 68 | void loadChatServerStore(const std::string filename = temporaryFriendsFile); 69 | void saveChatServerStore(const std::string filename = temporaryFriendsFile); 70 | 71 | // stupid helper function 72 | static int getdir(std::string dir, std::vector &files); 73 | static bool removeFile(const std::string &file); // delete a file 74 | }; 75 | 76 | #endif /* __CHATSERVER_H */ 77 | -------------------------------------------------------------------------------- /retroshare-chatserver/src/main.cpp: -------------------------------------------------------------------------------- 1 | #include 2 | #include 3 | #include /* definition of iface */ 4 | #include /* definition of iface */ 5 | #include 6 | #include 7 | 8 | #include "chatserver.h" 9 | #include "MinimalNotify.h" 10 | 11 | #include 12 | #include 13 | #include 14 | #include 15 | 16 | // copied from http://bytes.com/topic/c/answers/584434-check-directory-exists-c 17 | bool DirectoryExists( const char* pzPath ) 18 | { 19 | if ( pzPath == NULL) return false; 20 | 21 | DIR *pDir; 22 | bool bExists = false; 23 | 24 | pDir = opendir (pzPath); 25 | 26 | if (pDir != NULL) 27 | { 28 | bExists = true; 29 | (void) closedir (pDir); 30 | } 31 | 32 | return bExists; 33 | } 34 | 35 | bool file_writable(const char * filename) 36 | { 37 | if (FILE * file = fopen(filename, "a")) 38 | { 39 | fclose(file); 40 | return true; 41 | } 42 | return false; 43 | } 44 | 45 | int generateGxsId(const std::string& name) 46 | { 47 | uint32_t token; 48 | RsIdentityParameters params; 49 | // signing seems not to work from noguis 50 | // if you want to use a signed ID create it by hand 51 | params.isPgpLinked = false; 52 | params.nickname = name; 53 | rsIdentity->createIdentity(token, params); 54 | 55 | // waiting for max. 10 seconds 56 | uint counter = 0; 57 | while (rsIdentity->getTokenService()->requestStatus(token) != RsTokenService::GXS_REQUEST_V2_STATUS_COMPLETE && counter++ < 10) 58 | sleep(1); 59 | 60 | // request fulfilled or timeout? 61 | if(rsIdentity->getTokenService()->requestStatus(token) != RsTokenService::GXS_REQUEST_V2_STATUS_COMPLETE) 62 | { 63 | std::cerr << "Error: can't generate GXS Id" << std::endl; 64 | return 1; 65 | } 66 | return 0; 67 | } 68 | 69 | int main(int argc, char **argv) 70 | { 71 | std::string serverBase = rsAccounts->PathBaseDirectory() + "/chatserver/" ; 72 | if(!RsDirUtil::checkCreateDirectory(serverBase)) 73 | { 74 | std::cerr << "(EE) Cannot create ChatServer Base directory " + serverBase + ". This is not mandatory, but you probably have a permission problem." << std::endl; 75 | return 1; 76 | } 77 | 78 | certificatePath = serverBase + "NEWCERTS/" ; 79 | if(!RsDirUtil::checkCreateDirectory(certificatePath)) 80 | { 81 | std::cerr << "(EE) Cannot create certificatePath directory " + certificatePath + ". This is not mandatory, but you probably have a permission problem." << std::endl; 82 | return 1; 83 | } 84 | 85 | storagePath = serverBase + "STORAGE/" ; 86 | if(!RsDirUtil::checkCreateDirectory(storagePath)) 87 | { 88 | std::cerr << "(EE) Cannot create storagePath directory " + storagePath + ". You probably have a permission problem." << std::endl; 89 | return 1; 90 | } 91 | 92 | temporaryFriendsFile = serverBase + "friend_fifo.txt" ; 93 | if (!file_writable(temporaryFriendsFile.c_str())) 94 | { 95 | std::cout << "(EE) temporary friends file " << temporaryFriendsFile << " isn't writable!" << std::endl; 96 | return 1; 97 | } 98 | 99 | // startup libretroshare 100 | RsInit::InitRsConfig(); 101 | int initResult = RsInit::InitRetroShare(argc, argv, true); 102 | if (initResult < 0) 103 | { 104 | /* Error occured */ 105 | switch (initResult) 106 | { 107 | case RS_INIT_AUTH_FAILED: 108 | std::cerr << "RsInit::InitRetroShare AuthGPG::InitAuth failed" << std::endl; 109 | break; 110 | default: 111 | /* Unexpected return code */ 112 | std::cerr << "RsInit::InitRetroShare unexpected return code " << initResult << std::endl; 113 | break; 114 | }; 115 | return 1; 116 | } 117 | 118 | 119 | RsControl::earlyInitNotificationSystem() ; 120 | NotifyTxt *notify = new NotifyTxt() ; 121 | rsNotify->registerNotifyClient(notify); 122 | 123 | 124 | RsPeerId preferredId; 125 | RsPgpId gpgId; 126 | std::string gpgName, gpgEmail, sslName; 127 | 128 | RsAccounts::GetPreferredAccountId(preferredId); 129 | 130 | if (RsAccounts::GetAccountDetails(preferredId, gpgId, gpgName, gpgEmail, sslName)) 131 | { 132 | rsAccounts->SelectPGPAccount(gpgId); 133 | } 134 | 135 | /* Key + Certificate are loaded into libretroshare */ 136 | 137 | std::string error_string ; 138 | int retVal = RsInit::LockAndLoadCertificates(false,error_string); 139 | switch(retVal) 140 | { 141 | case 0: break; 142 | case 1: std::cerr << "Error: another instance of retroshare is already using this profile" << std::endl; 143 | return 1; 144 | case 2: std::cerr << "An unexpected error occurred while locking the profile" << std::endl; 145 | return 1; 146 | case 3: std::cerr << "An error occurred while login with the profile" << std::endl; 147 | return 1; 148 | default: std::cerr << "Main: Unexpected switch value " << retVal << std::endl; 149 | return 1; 150 | } 151 | 152 | /* Start-up libretroshare server threads */ 153 | RsControl::instance() -> StartupRetroShare(); 154 | 155 | /* Disable all Turtle Routing and tunnel requests */ 156 | rsConfig->setOperatingMode(RS_OPMODE_NOTURTLE); 157 | 158 | // give the core some time to start up fully 159 | // otherwise the GXS IDs might not be setup 160 | sleep(10); 161 | 162 | // get GXS Id 163 | RsGxsId id; 164 | std::list ids; 165 | rsIdentity->getOwnIds(ids); 166 | 167 | 168 | // wait for max. 60 seconds 169 | int16_t counter = 0; 170 | 171 | 172 | if(ids.empty()) { 173 | std::cout << "no GXS ID found -> sleep 5s -> 1st check again" << std::endl; 174 | sleep(5); 175 | rsIdentity->getOwnIds(ids); 176 | } 177 | 178 | while(ids.empty() && counter++ < 12) 179 | { 180 | std::cout << "no GXS ID found -> sleep 5s -> check again" << std::endl; 181 | sleep(5); 182 | rsIdentity->getOwnIds(ids); 183 | } 184 | 185 | if(ids.empty()) { 186 | std::cerr << "Error: unabled to find any GXS ID" << std::endl; 187 | return 1; 188 | } else { 189 | // find gxs id with suitable name 190 | std::list::iterator it; 191 | RsIdentityDetails details; 192 | for(it = ids.begin(); it != ids.end(); ++it) { 193 | // slightly ugly but needed since the details might not be available on the first request 194 | // first request 195 | rsIdentity->getIdDetails(*it, details); 196 | // wait 197 | sleep(1); 198 | // second request 199 | rsIdentity->getIdDetails(*it, details); 200 | std::cout << "GXS ID: " << details.mNickname << std::endl; 201 | if(details.mNickname == name) { 202 | id = *it; 203 | std::cout << "choosing this one: " << id.toStdString() << std::endl; 204 | break; 205 | } 206 | } 207 | } 208 | 209 | 210 | //if(ids.empty()) { 211 | //// generate a new ID 212 | //std::cout << "no GXS ID found -> generating a new one" << std::endl; 213 | 214 | //if(generateGxsId(name) != 0) 215 | //// geneation failed and error was already printed -> just return 216 | //return 1; 217 | 218 | //// pick first ID that is the newly generated one 219 | //rsIdentity->getOwnIds(ids); 220 | //id = ids.front(); 221 | //} else { 222 | 223 | 224 | 225 | 226 | //if(id.isNull()) 227 | //{ 228 | //// assume that a suitable ID isn't generated yet 229 | //std::cout << "no suitable GXS ID found -> generating new one" << std::endl; 230 | 231 | //if(generateGxsId(name) != 0) 232 | //// geneation failed and error was already printed -> just return 233 | //return 1; 234 | 235 | //// pick first ID that is the newly generated one 236 | //rsIdentity->getOwnIds(ids); 237 | //id = ids.front(); 238 | //} 239 | //} 240 | 241 | 242 | // last sanity check - should not occur but you never know ... 243 | if(id.isNull()) 244 | { 245 | std::cerr << "Error: can't find/generate suitable GXS Id" << std::endl; 246 | return 1; 247 | } 248 | 249 | rsMsgs->setDefaultIdentityForChatLobby(id); 250 | 251 | // start chatserver 252 | Chatserver *chatserver = new Chatserver(id); 253 | while (true) 254 | { 255 | sleep(1); 256 | chatserver->tick(); 257 | } 258 | return 0; 259 | } 260 | 261 | -------------------------------------------------------------------------------- /retroshare-chatserver/src/chatserver.cpp: -------------------------------------------------------------------------------- 1 | #include "chatserver.h" 2 | 3 | Chatserver::Chatserver( 4 | RsGxsId id, 5 | const unsigned int _checkForNewCertsInterval, 6 | const unsigned int _maxFriends, 7 | const unsigned int _ticksUntilLobbiesAreCreated) 8 | : checkForNewCertsInterval(_checkForNewCertsInterval), 9 | maxFriends(_maxFriends), 10 | ticksUntilLobbiesAreCreated(_ticksUntilLobbiesAreCreated), 11 | tickCounter(0), 12 | ownId(id), 13 | friends() 14 | { 15 | loadChatServerStore(); 16 | } 17 | 18 | Chatserver::~Chatserver() 19 | { 20 | // this isn't called at all ! 21 | } 22 | 23 | void Chatserver::loadChatServerStore(const std::string filename) 24 | { 25 | std::ifstream ifs(filename); 26 | std::string line; 27 | while (!ifs.eof() && !ifs.fail()) 28 | { 29 | getline(ifs, line); 30 | std::cout << "reading |" << line << "|" << ", length " << line.length() << std::endl; 31 | if (line.length() == 16) 32 | friends.push_back(RsPgpId(line)); 33 | }; 34 | ifs.close(); 35 | } 36 | 37 | void Chatserver::saveChatServerStore(const std::string filename) 38 | { 39 | std::ofstream ofs(filename); 40 | for (std::list::iterator it = friends.begin(); it != friends.end(); ++it) 41 | { 42 | std::cout << "writing |" << *it << "|" << std::endl; 43 | ofs << *it << std::endl; 44 | } 45 | ofs.close(); 46 | } 47 | 48 | void Chatserver::tick() 49 | { 50 | std::cout << "Chatserver::tick(" << ++tickCounter << "), currently " << numberOfFriends() << " friends." << std::endl; 51 | 52 | if (tickCounter % checkForNewCertsInterval == 0) 53 | checkForNewCertificates(); 54 | 55 | //if (tickCounter == 5) 56 | //deployOwnCert(); 57 | 58 | if (tickCounter == ticksUntilLobbiesAreCreated) 59 | { 60 | std::vector dummy; 61 | // called it to trigger that all friends are asked 62 | rsMsgs->getListOfNearbyChatLobbies(dummy); 63 | } 64 | 65 | if (tickCounter == ticksUntilLobbiesAreCreated + 10) 66 | createOrRejoinLobbys(); 67 | 68 | if (numberOfFriends() > maxFriends) 69 | removeOldestFriend(); 70 | } 71 | 72 | void Chatserver::removeOldestFriend() 73 | { 74 | std::cout << "ChatServer::removeOldestFriend()" << std::endl; 75 | 76 | while (numberOfFriends() > maxFriends) 77 | { 78 | if (!rsPeers->removeFriend(friends.front())) 79 | { 80 | std::cout << "FATAL: Could not remove friend with id " << friends.front() << std::endl; 81 | } 82 | friends.pop_front(); 83 | }; 84 | saveChatServerStore(); 85 | } 86 | 87 | void Chatserver::checkForNewCertificates() 88 | { 89 | std::vector newCerts; 90 | if (getdir(certificatePath, newCerts) != 0) 91 | { 92 | std::cout << "ChatServer: reading directory failed" << std::endl; 93 | return; 94 | } 95 | if (newCerts.size() == 0) 96 | { 97 | std::cout << "Chatserver: no new certificates found." << std::endl; 98 | return; 99 | } 100 | 101 | for (std::vector::const_iterator it = newCerts.begin(); it != newCerts.end(); ++it) 102 | { 103 | std::string fileName = certificatePath + (*it); 104 | std::cout << "adding certificate " << fileName << std::endl; 105 | // read file 106 | std::ifstream in(fileName); 107 | std::stringstream buffer; 108 | buffer << in.rdbuf(); 109 | std::string cert(buffer.str()); 110 | 111 | // we need to add "cert" now 112 | std::string errorString; 113 | RsPgpId gpgId; 114 | RsPeerId sslId; 115 | try 116 | { 117 | bool success = rsPeers->loadCertificateFromString(cert, sslId, gpgId, errorString); 118 | if (!success) 119 | { 120 | std::cout << "ERROR: load certificate " << fileName << ", error " << errorString << " discarding it" << std::endl; 121 | removeFile(fileName); 122 | continue; 123 | } 124 | } 125 | catch (uint32_t /*error_code*/) // thrown in RsCertificate::RsCertificate(..) 126 | { 127 | std::cout << "ERROR: caught exception while loading certificate " << fileName << ", discarding it" << std::endl; 128 | removeFile(fileName); 129 | continue; 130 | } 131 | 132 | if (rsPeers->isGPGAccepted(gpgId)) 133 | { 134 | std::cout << "ERROR: peer with gpg id " << gpgId << " is already accepted. Discarding it." << std::endl; 135 | removeFile(fileName); 136 | } 137 | 138 | // TODO: enable discovery or not? 139 | if (!rsPeers->addFriend(sslId, gpgId, RS_NODE_PERM_NONE)) 140 | { 141 | std::cout << "ERROR: could not add friend." << std::endl; 142 | continue; 143 | } 144 | std::cout << "SUCCESS: added friend with gpg_id " << gpgId << std::endl; 145 | // remove all existing gpgids from the friend fifo list before pushing a gpgid to the list 146 | // this is to prevent users from adding them too often to the chatserver and reducing the capacity 147 | // http://www.cplusplus.com/reference/list/list/remove/ 148 | friends.remove(gpgId); 149 | // add the unique ID to the fifo list 150 | friends.push_back(gpgId); 151 | std::cout << "Chatserver: " << (removeFile(fileName) == false ? "couldn't " : "") << "remove " << fileName << std::endl; 152 | saveChatServerStore(); 153 | } 154 | } 155 | 156 | void Chatserver::deployOwnCert() 157 | { 158 | std::string key = rsPeers->GetRetroshareInvite(false); 159 | // std::cout << "%own% " << key << std::endl; 160 | 161 | const std::string filename = storagePath + "serverkey.txt"; 162 | std::ofstream ofs; 163 | ofs.open(filename); 164 | ofs << key << std::endl; 165 | ofs.flush(); 166 | ofs.close(); 167 | } 168 | 169 | void Chatserver::createOrRejoinLobbys() 170 | { 171 | std::cout << "ChatServer::createOrRejoinLobbys()" << std::endl; 172 | 173 | std::vector publicLobbies; 174 | rsMsgs->getListOfNearbyChatLobbies(publicLobbies); 175 | std::cout << "ChatServer: found " << publicLobbies.size() << " public lobbies." << std::endl; 176 | 177 | // name, topic, id (optional), publicLobbies 178 | createOrRejoinLobby("Chatserver EN", "Welcome!", publicLobbies); 179 | createOrRejoinLobby("Chatserver DE", "Willkommen!", publicLobbies); 180 | createOrRejoinLobby("Chatserver ES", "Hola!", publicLobbies); 181 | createOrRejoinLobby("Chatserver FR", "Bonjour!", publicLobbies); 182 | /* 183 | createOrRejoinLobby("PirateParty", "Arrrrr, http://antiprism.eu/", publicLobbies); 184 | createOrRejoinLobby("RetroShare on IRC", "This Lobby is bridged to #retroshare on Freenode IRC. Connect with IRC WebChat http://webchat.freenode.net/?channels=retroshare", publicLobbies); 185 | */ 186 | } 187 | 188 | void inline Chatserver::createOrRejoinLobby(const std::string lobbyName, const std::string lobbyTopic, const std::vector &publicLobbies) 189 | { 190 | createOrRejoinLobby(lobbyName, lobbyTopic, "", publicLobbies); 191 | } 192 | 193 | void Chatserver::createOrRejoinLobby(const std::string lobbyName, const std::string lobbyTopic, const std::string lobbyId, const std::vector &publicLobbies) 194 | { 195 | // convert string to ChatLobbyId 196 | ChatLobbyId lid = 0; 197 | if(lobbyId != "") 198 | lid = strtoull(lobbyId.c_str(), NULL, 16); 199 | 200 | std::cout << "createOrRejoinLobby: " << std::endl; 201 | std::cout << "-- searching for name='" << lobbyName << "'"; 202 | if(lobbyId != "") 203 | std::cout << " id=" << lobbyId; 204 | std::cout << std::endl; 205 | 206 | std::cout << "Chatserver is seeing:" << std::endl; 207 | // range based for would be nicer, but don't want to use C++11 only for that 208 | for (std::vector::const_iterator it = publicLobbies.begin(); it != publicLobbies.end(); ++it) 209 | { 210 | std::cout << std::hex << "-- " << it->lobby_id << std::dec << ", " << it->lobby_name << ", " << it->lobby_topic << std::endl; 211 | if ((lobbyId != "" && it->lobby_id == lid) || // id based 212 | (lobbyId == "" && it->lobby_name == lobbyName)) // name based 213 | { 214 | // rejoin 215 | std::cout << "Chatserver: rejoined lobby " + lobbyName << std::endl; 216 | rsMsgs->joinVisibleChatLobby(it->lobby_id, ownId); 217 | return; 218 | } 219 | } 220 | 221 | // when we reach this part of the code we didn't find a lobby to join --> create new 222 | const std::set emptyList = std::set(); 223 | std::cout << "Chatserver: creating new lobby " + lobbyName << std::endl; 224 | rsMsgs->createChatLobby(lobbyName, ownId, lobbyTopic, emptyList, RS_CHAT_LOBBY_FLAGS_PUBLIC); 225 | 226 | } 227 | 228 | int Chatserver::getdir (std::string dir, std::vector &files) 229 | { 230 | // copied from: http://www.linuxquestions.org/questions/programming-9/c-list-files-in-directory-379323/ 231 | DIR *dp; 232 | struct dirent *dirp; 233 | if((dp = opendir(dir.c_str())) == NULL) 234 | { 235 | std::cout << "Error(" << errno << ") opening " << dir << std::endl; 236 | return errno; 237 | } 238 | 239 | while ((dirp = readdir(dp)) != NULL) 240 | { 241 | std::string fileName(dirp->d_name); 242 | if (fileName == ".") continue; 243 | if (fileName == "..") continue; 244 | if (fileName == ".svn") continue; 245 | files.push_back(std::string(dirp->d_name)); 246 | }; 247 | closedir(dp); 248 | return 0; 249 | } 250 | 251 | void Chatserver::removeAllFriends() 252 | { 253 | while (! friends.empty()) 254 | { 255 | if (!rsPeers->removeFriend(friends.front())) 256 | { 257 | std::cout << "ERROR: Could not remove friend with id " << friends.front() << std::endl; 258 | break; 259 | } 260 | friends.pop_front(); 261 | } 262 | saveChatServerStore(); 263 | } 264 | 265 | bool Chatserver::removeFile(const std::string &file) 266 | { 267 | return (remove(file.c_str()) == 0); 268 | } 269 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | 3 | Version 3, 29 June 2007 4 | 5 | Copyright © 2007 Free Software Foundation, Inc. 6 | 7 | Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for software and other kinds of works. 11 | 12 | The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too. 13 | 14 | When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things. 15 | 16 | To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others. 17 | 18 | For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. 19 | 20 | Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it. 21 | 22 | For the developers' and authors' protection, the GPL clearly explains that there is no warranty for this free software. For both users' and authors' sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions. 23 | 24 | Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users' freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users. 25 | 26 | Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free. 27 | 28 | The precise terms and conditions for copying, distribution and modification follow. 29 | TERMS AND CONDITIONS 30 | 0. Definitions. 31 | 32 | “This License” refers to version 3 of the GNU General Public License. 33 | 34 | “Copyright” also means copyright-like laws that apply to other kinds of works, such as semiconductor masks. 35 | 36 | “The Program” refers to any copyrightable work licensed under this License. Each licensee is addressed as “you”. “Licensees” and “recipients” may be individuals or organizations. 37 | 38 | To “modify” a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a “modified version” of the earlier work or a work “based on” the earlier work. 39 | 40 | A “covered work” means either the unmodified Program or a work based on the Program. 41 | 42 | To “propagate” a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well. 43 | 44 | To “convey” a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying. 45 | 46 | An interactive user interface displays “Appropriate Legal Notices” to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion. 47 | 1. Source Code. 48 | 49 | The “source code” for a work means the preferred form of the work for making modifications to it. “Object code” means any non-source form of a work. 50 | 51 | A “Standard Interface” means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language. 52 | 53 | The “System Libraries” of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A “Major Component”, in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it. 54 | 55 | The “Corresponding Source” for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work. 56 | 57 | The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source. 58 | 59 | The Corresponding Source for a work in source code form is that same work. 60 | 2. Basic Permissions. 61 | 62 | All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law. 63 | 64 | You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you. 65 | 66 | Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary. 67 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 68 | 69 | No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures. 70 | 71 | When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures. 72 | 4. Conveying Verbatim Copies. 73 | 74 | You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program. 75 | 76 | You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee. 77 | 5. Conveying Modified Source Versions. 78 | 79 | You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions: 80 | 81 | a) The work must carry prominent notices stating that you modified it, and giving a relevant date. 82 | b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to “keep intact all notices”. 83 | c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it. 84 | d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so. 85 | 86 | A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an “aggregate” if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate. 87 | 6. Conveying Non-Source Forms. 88 | 89 | You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways: 90 | 91 | a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange. 92 | b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge. 93 | c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b. 94 | d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements. 95 | e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d. 96 | 97 | A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work. 98 | 99 | A “User Product” is either (1) a “consumer product”, which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, “normally used” refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product. 100 | 101 | “Installation Information” for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made. 102 | 103 | If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM). 104 | 105 | The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network. 106 | 107 | Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying. 108 | 7. Additional Terms. 109 | 110 | “Additional permissions” are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions. 111 | 112 | When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission. 113 | 114 | Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms: 115 | 116 | a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or 117 | b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or 118 | c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or 119 | d) Limiting the use for publicity purposes of names of licensors or authors of the material; or 120 | e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or 121 | f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors. 122 | 123 | All other non-permissive additional terms are considered “further restrictions” within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying. 124 | 125 | If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms. 126 | 127 | Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way. 128 | 8. Termination. 129 | 130 | You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11). 131 | 132 | However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation. 133 | 134 | Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice. 135 | 136 | Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10. 137 | 9. Acceptance Not Required for Having Copies. 138 | 139 | You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so. 140 | 10. Automatic Licensing of Downstream Recipients. 141 | 142 | Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License. 143 | 144 | An “entity transaction” is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts. 145 | 146 | You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it. 147 | 11. Patents. 148 | 149 | A “contributor” is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's “contributor version”. 150 | 151 | A contributor's “essential patent claims” are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, “control” includes the right to grant patent sublicenses in a manner consistent with the requirements of this License. 152 | 153 | Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version. 154 | 155 | In the following three paragraphs, a “patent license” is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To “grant” such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party. 156 | 157 | If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. “Knowingly relying” means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid. 158 | 159 | If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it. 160 | 161 | A patent license is “discriminatory” if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007. 162 | 163 | Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law. 164 | 12. No Surrender of Others' Freedom. 165 | 166 | If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program. 167 | 13. Use with the GNU Affero General Public License. 168 | 169 | Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such. 170 | 14. Revised Versions of this License. 171 | 172 | The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. 173 | 174 | Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License “or any later version” applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation. 175 | 176 | If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program. 177 | 178 | Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version. 179 | 15. Disclaimer of Warranty. 180 | 181 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 182 | 16. Limitation of Liability. 183 | 184 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 185 | 17. Interpretation of Sections 15 and 16. 186 | 187 | If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee. 188 | 189 | END OF TERMS AND CONDITIONS 190 | How to Apply These Terms to Your New Programs 191 | 192 | If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. 193 | 194 | To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the “copyright” line and a pointer to where the full notice is found. 195 | 196 | 197 | Copyright (C) 198 | 199 | This program is free software: you can redistribute it and/or modify 200 | it under the terms of the GNU General Public License as published by 201 | the Free Software Foundation, either version 3 of the License, or 202 | (at your option) any later version. 203 | 204 | This program is distributed in the hope that it will be useful, 205 | but WITHOUT ANY WARRANTY; without even the implied warranty of 206 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 207 | GNU General Public License for more details. 208 | 209 | You should have received a copy of the GNU General Public License 210 | along with this program. If not, see . 211 | 212 | Also add information on how to contact you by electronic and paper mail. 213 | 214 | If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode: 215 | 216 | Copyright (C) 217 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 218 | This is free software, and you are welcome to redistribute it 219 | under certain conditions; type `show c' for details. 220 | 221 | The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, your program's commands might be different; for a GUI interface, you would use an “about box”. 222 | 223 | You should also get your employer (if you work as a programmer) or school, if any, to sign a “copyright disclaimer” for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see . 224 | 225 | The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read . 226 | 227 | -------------------------------------------------------------------------------- /docs/Doxyfile: -------------------------------------------------------------------------------- 1 | # Doxyfile 1.8.5 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 = "RetroShare Chatserver" 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 = 48 | 49 | # With the PROJECT_LOGO tag one can specify an logo or icon that is included in 50 | # the documentation. The maximum height of the logo should not exceed 55 pixels 51 | # and the maximum width should not exceed 200 pixels. Doxygen will copy the logo 52 | # to the output directory. 53 | 54 | PROJECT_LOGO = 55 | 56 | # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path 57 | # into which the generated documentation will be written. If a relative path is 58 | # entered, it will be relative to the location where doxygen was started. If 59 | # left blank the current directory will be used. 60 | 61 | OUTPUT_DIRECTORY = 62 | 63 | # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub- 64 | # directories (in 2 levels) under the output directory of each output format and 65 | # will distribute the generated files over these directories. Enabling this 66 | # option can be useful when feeding doxygen a huge amount of source files, where 67 | # putting all generated files in the same directory would otherwise causes 68 | # performance problems for the file system. 69 | # The default value is: NO. 70 | 71 | CREATE_SUBDIRS = NO 72 | 73 | # The OUTPUT_LANGUAGE tag is used to specify the language in which all 74 | # documentation generated by doxygen is written. Doxygen will use this 75 | # information to generate all constant output in the proper language. 76 | # Possible values are: Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese- 77 | # Traditional, Croatian, Czech, Danish, Dutch, English, Esperanto, Farsi, 78 | # Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en, 79 | # Korean, Korean-en, Latvian, Norwegian, Macedonian, Persian, Polish, 80 | # Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, 81 | # Turkish, Ukrainian and Vietnamese. 82 | # The default value is: English. 83 | 84 | OUTPUT_LANGUAGE = English 85 | 86 | # If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member 87 | # descriptions after the members that are listed in the file and class 88 | # documentation (similar to Javadoc). Set to NO to disable this. 89 | # The default value is: YES. 90 | 91 | BRIEF_MEMBER_DESC = YES 92 | 93 | # If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief 94 | # description of a member or function before the detailed description 95 | # 96 | # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 97 | # brief descriptions will be completely suppressed. 98 | # The default value is: YES. 99 | 100 | REPEAT_BRIEF = YES 101 | 102 | # This tag implements a quasi-intelligent brief description abbreviator that is 103 | # used to form the text in various listings. Each string in this list, if found 104 | # as the leading text of the brief description, will be stripped from the text 105 | # and the result, after processing the whole list, is used as the annotated 106 | # text. Otherwise, the brief description is used as-is. If left blank, the 107 | # following values are used ($name is automatically replaced with the name of 108 | # the entity):The $name class, The $name widget, The $name file, is, provides, 109 | # specifies, contains, represents, a, an and the. 110 | 111 | ABBREVIATE_BRIEF = 112 | 113 | # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 114 | # doxygen will generate a detailed section even if there is only a brief 115 | # description. 116 | # The default value is: NO. 117 | 118 | ALWAYS_DETAILED_SEC = NO 119 | 120 | # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 121 | # inherited members of a class in the documentation of that class as if those 122 | # members were ordinary class members. Constructors, destructors and assignment 123 | # operators of the base classes will not be shown. 124 | # The default value is: NO. 125 | 126 | INLINE_INHERITED_MEMB = NO 127 | 128 | # If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path 129 | # before files name in the file list and in the header files. If set to NO the 130 | # shortest path that makes the file name unique will be used 131 | # The default value is: YES. 132 | 133 | FULL_PATH_NAMES = YES 134 | 135 | # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. 136 | # Stripping is only done if one of the specified strings matches the left-hand 137 | # part of the path. The tag can be used to show relative paths in the file list. 138 | # If left blank the directory from which doxygen is run is used as the path to 139 | # strip. 140 | # 141 | # Note that you can specify absolute paths here, but also relative paths, which 142 | # will be relative from the directory where doxygen is started. 143 | # This tag requires that the tag FULL_PATH_NAMES is set to YES. 144 | 145 | STRIP_FROM_PATH = 146 | 147 | # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the 148 | # path mentioned in the documentation of a class, which tells the reader which 149 | # header file to include in order to use a class. If left blank only the name of 150 | # the header file containing the class definition is used. Otherwise one should 151 | # specify the list of include paths that are normally passed to the compiler 152 | # using the -I flag. 153 | 154 | STRIP_FROM_INC_PATH = 155 | 156 | # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but 157 | # less readable) file names. This can be useful is your file systems doesn't 158 | # support long names like on DOS, Mac, or CD-ROM. 159 | # The default value is: NO. 160 | 161 | SHORT_NAMES = NO 162 | 163 | # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the 164 | # first line (until the first dot) of a Javadoc-style comment as the brief 165 | # description. If set to NO, the Javadoc-style will behave just like regular Qt- 166 | # style comments (thus requiring an explicit @brief command for a brief 167 | # description.) 168 | # The default value is: NO. 169 | 170 | JAVADOC_AUTOBRIEF = NO 171 | 172 | # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first 173 | # line (until the first dot) of a Qt-style comment as the brief description. If 174 | # set to NO, the Qt-style will behave just like regular Qt-style comments (thus 175 | # requiring an explicit \brief command for a brief description.) 176 | # The default value is: NO. 177 | 178 | QT_AUTOBRIEF = NO 179 | 180 | # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a 181 | # multi-line C++ special comment block (i.e. a block of //! or /// comments) as 182 | # a brief description. This used to be the default behavior. The new default is 183 | # to treat a multi-line C++ comment block as a detailed description. Set this 184 | # tag to YES if you prefer the old behavior instead. 185 | # 186 | # Note that setting this tag to YES also means that rational rose comments are 187 | # not recognized any more. 188 | # The default value is: NO. 189 | 190 | MULTILINE_CPP_IS_BRIEF = NO 191 | 192 | # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the 193 | # documentation from any documented member that it re-implements. 194 | # The default value is: YES. 195 | 196 | INHERIT_DOCS = YES 197 | 198 | # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a 199 | # new page for each member. If set to NO, the documentation of a member will be 200 | # part of the file/class/namespace that contains it. 201 | # The default value is: NO. 202 | 203 | SEPARATE_MEMBER_PAGES = NO 204 | 205 | # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen 206 | # uses this value to replace tabs by spaces in code fragments. 207 | # Minimum value: 1, maximum value: 16, default value: 4. 208 | 209 | TAB_SIZE = 4 210 | 211 | # This tag can be used to specify a number of aliases that act as commands in 212 | # the documentation. An alias has the form: 213 | # name=value 214 | # For example adding 215 | # "sideeffect=@par Side Effects:\n" 216 | # will allow you to put the command \sideeffect (or @sideeffect) in the 217 | # documentation, which will result in a user-defined paragraph with heading 218 | # "Side Effects:". You can put \n's in the value part of an alias to insert 219 | # newlines. 220 | 221 | ALIASES = 222 | 223 | # This tag can be used to specify a number of word-keyword mappings (TCL only). 224 | # A mapping has the form "name=value". For example adding "class=itcl::class" 225 | # will allow you to use the command class in the itcl::class meaning. 226 | 227 | TCL_SUBST = 228 | 229 | # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources 230 | # only. Doxygen will then generate output that is more tailored for C. For 231 | # instance, some of the names that are used will be different. The list of all 232 | # members will be omitted, etc. 233 | # The default value is: NO. 234 | 235 | OPTIMIZE_OUTPUT_FOR_C = NO 236 | 237 | # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or 238 | # Python sources only. Doxygen will then generate output that is more tailored 239 | # for that language. For instance, namespaces will be presented as packages, 240 | # qualified scopes will look different, etc. 241 | # The default value is: NO. 242 | 243 | OPTIMIZE_OUTPUT_JAVA = NO 244 | 245 | # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 246 | # sources. Doxygen will then generate output that is tailored for Fortran. 247 | # The default value is: NO. 248 | 249 | OPTIMIZE_FOR_FORTRAN = NO 250 | 251 | # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 252 | # sources. Doxygen will then generate output that is tailored for VHDL. 253 | # The default value is: NO. 254 | 255 | OPTIMIZE_OUTPUT_VHDL = NO 256 | 257 | # Doxygen selects the parser to use depending on the extension of the files it 258 | # parses. With this tag you can assign which parser to use for a given 259 | # extension. Doxygen has a built-in mapping, but you can override or extend it 260 | # using this tag. The format is ext=language, where ext is a file extension, and 261 | # language is one of the parsers supported by doxygen: IDL, Java, Javascript, 262 | # C#, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL. For instance to make 263 | # doxygen treat .inc files as Fortran files (default is PHP), and .f files as C 264 | # (default is Fortran), use: inc=Fortran f=C. 265 | # 266 | # Note For files without extension you can use no_extension as a placeholder. 267 | # 268 | # Note that for custom extensions you also need to set FILE_PATTERNS otherwise 269 | # the files are not read by doxygen. 270 | 271 | EXTENSION_MAPPING = 272 | 273 | # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments 274 | # according to the Markdown format, which allows for more readable 275 | # documentation. See http://daringfireball.net/projects/markdown/ for details. 276 | # The output of markdown processing is further processed by doxygen, so you can 277 | # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in 278 | # case of backward compatibilities issues. 279 | # The default value is: YES. 280 | 281 | MARKDOWN_SUPPORT = YES 282 | 283 | # When enabled doxygen tries to link words that correspond to documented 284 | # classes, or namespaces to their corresponding documentation. Such a link can 285 | # be prevented in individual cases by by putting a % sign in front of the word 286 | # or globally by setting AUTOLINK_SUPPORT to NO. 287 | # The default value is: YES. 288 | 289 | AUTOLINK_SUPPORT = YES 290 | 291 | # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 292 | # to include (a tag file for) the STL sources as input, then you should set this 293 | # tag to YES in order to let doxygen match functions declarations and 294 | # definitions whose arguments contain STL classes (e.g. func(std::string); 295 | # versus func(std::string) {}). This also make the inheritance and collaboration 296 | # diagrams that involve STL classes more complete and accurate. 297 | # The default value is: NO. 298 | 299 | BUILTIN_STL_SUPPORT = NO 300 | 301 | # If you use Microsoft's C++/CLI language, you should set this option to YES to 302 | # enable parsing support. 303 | # The default value is: NO. 304 | 305 | CPP_CLI_SUPPORT = NO 306 | 307 | # Set the SIP_SUPPORT tag to YES if your project consists of sip (see: 308 | # http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen 309 | # will parse them like normal C++ but will assume all classes use public instead 310 | # of private inheritance when no explicit protection keyword is present. 311 | # The default value is: NO. 312 | 313 | SIP_SUPPORT = NO 314 | 315 | # For Microsoft's IDL there are propget and propput attributes to indicate 316 | # getter and setter methods for a property. Setting this option to YES will make 317 | # doxygen to replace the get and set methods by a property in the documentation. 318 | # This will only work if the methods are indeed getting or setting a simple 319 | # type. If this is not the case, or you want to show the methods anyway, you 320 | # should set this option to NO. 321 | # The default value is: YES. 322 | 323 | IDL_PROPERTY_SUPPORT = YES 324 | 325 | # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 326 | # tag is set to YES, then doxygen will reuse the documentation of the first 327 | # member in the group (if any) for the other members of the group. By default 328 | # all members of a group must be documented explicitly. 329 | # The default value is: NO. 330 | 331 | DISTRIBUTE_GROUP_DOC = NO 332 | 333 | # Set the SUBGROUPING tag to YES to allow class member groups of the same type 334 | # (for instance a group of public functions) to be put as a subgroup of that 335 | # type (e.g. under the Public Functions section). Set it to NO to prevent 336 | # subgrouping. Alternatively, this can be done per class using the 337 | # \nosubgrouping command. 338 | # The default value is: YES. 339 | 340 | SUBGROUPING = YES 341 | 342 | # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions 343 | # are shown inside the group in which they are included (e.g. using \ingroup) 344 | # instead of on a separate page (for HTML and Man pages) or section (for LaTeX 345 | # and RTF). 346 | # 347 | # Note that this feature does not work in combination with 348 | # SEPARATE_MEMBER_PAGES. 349 | # The default value is: NO. 350 | 351 | INLINE_GROUPED_CLASSES = NO 352 | 353 | # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions 354 | # with only public data fields or simple typedef fields will be shown inline in 355 | # the documentation of the scope in which they are defined (i.e. file, 356 | # namespace, or group documentation), provided this scope is documented. If set 357 | # to NO, structs, classes, and unions are shown on a separate page (for HTML and 358 | # Man pages) or section (for LaTeX and RTF). 359 | # The default value is: NO. 360 | 361 | INLINE_SIMPLE_STRUCTS = NO 362 | 363 | # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or 364 | # enum is documented as struct, union, or enum with the name of the typedef. So 365 | # typedef struct TypeS {} TypeT, will appear in the documentation as a struct 366 | # with name TypeT. When disabled the typedef will appear as a member of a file, 367 | # namespace, or class. And the struct will be named TypeS. This can typically be 368 | # useful for C code in case the coding convention dictates that all compound 369 | # types are typedef'ed and only the typedef is referenced, never the tag name. 370 | # The default value is: NO. 371 | 372 | TYPEDEF_HIDES_STRUCT = NO 373 | 374 | # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This 375 | # cache is used to resolve symbols given their name and scope. Since this can be 376 | # an expensive process and often the same symbol appears multiple times in the 377 | # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small 378 | # doxygen will become slower. If the cache is too large, memory is wasted. The 379 | # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range 380 | # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 381 | # symbols. At the end of a run doxygen will report the cache usage and suggest 382 | # the optimal cache size from a speed point of view. 383 | # Minimum value: 0, maximum value: 9, default value: 0. 384 | 385 | LOOKUP_CACHE_SIZE = 0 386 | 387 | #--------------------------------------------------------------------------- 388 | # Build related configuration options 389 | #--------------------------------------------------------------------------- 390 | 391 | # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 392 | # documentation are documented, even if no documentation was available. Private 393 | # class members and static file members will be hidden unless the 394 | # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. 395 | # Note: This will also disable the warnings about undocumented members that are 396 | # normally produced when WARNINGS is set to YES. 397 | # The default value is: NO. 398 | 399 | EXTRACT_ALL = NO 400 | 401 | # If the EXTRACT_PRIVATE tag is set to YES all private members of a class will 402 | # be included in the documentation. 403 | # The default value is: NO. 404 | 405 | EXTRACT_PRIVATE = NO 406 | 407 | # If the EXTRACT_PACKAGE tag is set to YES all members with package or internal 408 | # scope will be included in the documentation. 409 | # The default value is: NO. 410 | 411 | EXTRACT_PACKAGE = NO 412 | 413 | # If the EXTRACT_STATIC tag is set to YES all static members of a file will be 414 | # included in the documentation. 415 | # The default value is: NO. 416 | 417 | EXTRACT_STATIC = NO 418 | 419 | # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined 420 | # locally in source files will be included in the documentation. If set to NO 421 | # only classes defined in header files are included. Does not have any effect 422 | # for Java sources. 423 | # The default value is: YES. 424 | 425 | EXTRACT_LOCAL_CLASSES = YES 426 | 427 | # This flag is only useful for Objective-C code. When set to YES local methods, 428 | # which are defined in the implementation section but not in the interface are 429 | # included in the documentation. If set to NO only methods in the interface are 430 | # included. 431 | # The default value is: NO. 432 | 433 | EXTRACT_LOCAL_METHODS = NO 434 | 435 | # If this flag is set to YES, the members of anonymous namespaces will be 436 | # extracted and appear in the documentation as a namespace called 437 | # 'anonymous_namespace{file}', where file will be replaced with the base name of 438 | # the file that contains the anonymous namespace. By default anonymous namespace 439 | # are hidden. 440 | # The default value is: NO. 441 | 442 | EXTRACT_ANON_NSPACES = NO 443 | 444 | # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all 445 | # undocumented members inside documented classes or files. If set to NO these 446 | # members will be included in the various overviews, but no documentation 447 | # section is generated. This option has no effect if EXTRACT_ALL is enabled. 448 | # The default value is: NO. 449 | 450 | HIDE_UNDOC_MEMBERS = NO 451 | 452 | # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all 453 | # undocumented classes that are normally visible in the class hierarchy. If set 454 | # to NO these classes will be included in the various overviews. This option has 455 | # no effect if EXTRACT_ALL is enabled. 456 | # The default value is: NO. 457 | 458 | HIDE_UNDOC_CLASSES = NO 459 | 460 | # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend 461 | # (class|struct|union) declarations. If set to NO these declarations will be 462 | # included in the documentation. 463 | # The default value is: NO. 464 | 465 | HIDE_FRIEND_COMPOUNDS = NO 466 | 467 | # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any 468 | # documentation blocks found inside the body of a function. If set to NO these 469 | # blocks will be appended to the function's detailed documentation block. 470 | # The default value is: NO. 471 | 472 | HIDE_IN_BODY_DOCS = NO 473 | 474 | # The INTERNAL_DOCS tag determines if documentation that is typed after a 475 | # \internal command is included. If the tag is set to NO then the documentation 476 | # will be excluded. Set it to YES to include the internal documentation. 477 | # The default value is: NO. 478 | 479 | INTERNAL_DOCS = NO 480 | 481 | # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file 482 | # names in lower-case letters. If set to YES upper-case letters are also 483 | # allowed. This is useful if you have classes or files whose names only differ 484 | # in case and if your file system supports case sensitive file names. Windows 485 | # and Mac users are advised to set this option to NO. 486 | # The default value is: system dependent. 487 | 488 | CASE_SENSE_NAMES = YES 489 | 490 | # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with 491 | # their full class and namespace scopes in the documentation. If set to YES the 492 | # scope will be hidden. 493 | # The default value is: NO. 494 | 495 | HIDE_SCOPE_NAMES = NO 496 | 497 | # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of 498 | # the files that are included by a file in the documentation of that file. 499 | # The default value is: YES. 500 | 501 | SHOW_INCLUDE_FILES = YES 502 | 503 | # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include 504 | # files with double quotes in the documentation rather than with sharp brackets. 505 | # The default value is: NO. 506 | 507 | FORCE_LOCAL_INCLUDES = NO 508 | 509 | # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the 510 | # documentation for inline members. 511 | # The default value is: YES. 512 | 513 | INLINE_INFO = YES 514 | 515 | # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the 516 | # (detailed) documentation of file and class members alphabetically by member 517 | # name. If set to NO the members will appear in declaration order. 518 | # The default value is: YES. 519 | 520 | SORT_MEMBER_DOCS = YES 521 | 522 | # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief 523 | # descriptions of file, namespace and class members alphabetically by member 524 | # name. If set to NO the members will appear in declaration order. 525 | # The default value is: NO. 526 | 527 | SORT_BRIEF_DOCS = NO 528 | 529 | # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the 530 | # (brief and detailed) documentation of class members so that constructors and 531 | # destructors are listed first. If set to NO the constructors will appear in the 532 | # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. 533 | # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief 534 | # member documentation. 535 | # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting 536 | # detailed member documentation. 537 | # The default value is: NO. 538 | 539 | SORT_MEMBERS_CTORS_1ST = NO 540 | 541 | # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy 542 | # of group names into alphabetical order. If set to NO the group names will 543 | # appear in their defined order. 544 | # The default value is: NO. 545 | 546 | SORT_GROUP_NAMES = NO 547 | 548 | # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by 549 | # fully-qualified names, including namespaces. If set to NO, the class list will 550 | # be sorted only by class name, not including the namespace part. 551 | # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 552 | # Note: This option applies only to the class list, not to the alphabetical 553 | # list. 554 | # The default value is: NO. 555 | 556 | SORT_BY_SCOPE_NAME = NO 557 | 558 | # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper 559 | # type resolution of all parameters of a function it will reject a match between 560 | # the prototype and the implementation of a member function even if there is 561 | # only one candidate or it is obvious which candidate to choose by doing a 562 | # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still 563 | # accept a match between prototype and implementation in such cases. 564 | # The default value is: NO. 565 | 566 | STRICT_PROTO_MATCHING = NO 567 | 568 | # The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the 569 | # todo list. This list is created by putting \todo commands in the 570 | # documentation. 571 | # The default value is: YES. 572 | 573 | GENERATE_TODOLIST = YES 574 | 575 | # The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the 576 | # test list. This list is created by putting \test commands in the 577 | # documentation. 578 | # The default value is: YES. 579 | 580 | GENERATE_TESTLIST = YES 581 | 582 | # The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug 583 | # list. This list is created by putting \bug commands in the documentation. 584 | # The default value is: YES. 585 | 586 | GENERATE_BUGLIST = YES 587 | 588 | # The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO) 589 | # the deprecated list. This list is created by putting \deprecated commands in 590 | # the documentation. 591 | # The default value is: YES. 592 | 593 | GENERATE_DEPRECATEDLIST= YES 594 | 595 | # The ENABLED_SECTIONS tag can be used to enable conditional documentation 596 | # sections, marked by \if ... \endif and \cond 597 | # ... \endcond blocks. 598 | 599 | ENABLED_SECTIONS = 600 | 601 | # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the 602 | # initial value of a variable or macro / define can have for it to appear in the 603 | # documentation. If the initializer consists of more lines than specified here 604 | # it will be hidden. Use a value of 0 to hide initializers completely. The 605 | # appearance of the value of individual variables and macros / defines can be 606 | # controlled using \showinitializer or \hideinitializer command in the 607 | # documentation regardless of this setting. 608 | # Minimum value: 0, maximum value: 10000, default value: 30. 609 | 610 | MAX_INITIALIZER_LINES = 30 611 | 612 | # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at 613 | # the bottom of the documentation of classes and structs. If set to YES the list 614 | # will mention the files that were used to generate the documentation. 615 | # The default value is: YES. 616 | 617 | SHOW_USED_FILES = YES 618 | 619 | # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This 620 | # will remove the Files entry from the Quick Index and from the Folder Tree View 621 | # (if specified). 622 | # The default value is: YES. 623 | 624 | SHOW_FILES = YES 625 | 626 | # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces 627 | # page. This will remove the Namespaces entry from the Quick Index and from the 628 | # Folder Tree View (if specified). 629 | # The default value is: YES. 630 | 631 | SHOW_NAMESPACES = YES 632 | 633 | # The FILE_VERSION_FILTER tag can be used to specify a program or script that 634 | # doxygen should invoke to get the current version for each file (typically from 635 | # the version control system). Doxygen will invoke the program by executing (via 636 | # popen()) the command command input-file, where command is the value of the 637 | # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided 638 | # by doxygen. Whatever the program writes to standard output is used as the file 639 | # version. For an example see the documentation. 640 | 641 | FILE_VERSION_FILTER = 642 | 643 | # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed 644 | # by doxygen. The layout file controls the global structure of the generated 645 | # output files in an output format independent way. To create the layout file 646 | # that represents doxygen's defaults, run doxygen with the -l option. You can 647 | # optionally specify a file name after the option, if omitted DoxygenLayout.xml 648 | # will be used as the name of the layout file. 649 | # 650 | # Note that if you run doxygen from a directory containing a file called 651 | # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE 652 | # tag is left empty. 653 | 654 | LAYOUT_FILE = 655 | 656 | # The CITE_BIB_FILES tag can be used to specify one or more bib files containing 657 | # the reference definitions. This must be a list of .bib files. The .bib 658 | # extension is automatically appended if omitted. This requires the bibtex tool 659 | # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. 660 | # For LaTeX the style of the bibliography can be controlled using 661 | # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the 662 | # search path. Do not use file names with spaces, bibtex cannot handle them. See 663 | # also \cite for info how to create references. 664 | 665 | CITE_BIB_FILES = 666 | 667 | #--------------------------------------------------------------------------- 668 | # Configuration options related to warning and progress messages 669 | #--------------------------------------------------------------------------- 670 | 671 | # The QUIET tag can be used to turn on/off the messages that are generated to 672 | # standard output by doxygen. If QUIET is set to YES this implies that the 673 | # messages are off. 674 | # The default value is: NO. 675 | 676 | QUIET = NO 677 | 678 | # The WARNINGS tag can be used to turn on/off the warning messages that are 679 | # generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES 680 | # this implies that the warnings are on. 681 | # 682 | # Tip: Turn warnings on while writing the documentation. 683 | # The default value is: YES. 684 | 685 | WARNINGS = YES 686 | 687 | # If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate 688 | # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag 689 | # will automatically be disabled. 690 | # The default value is: YES. 691 | 692 | WARN_IF_UNDOCUMENTED = YES 693 | 694 | # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for 695 | # potential errors in the documentation, such as not documenting some parameters 696 | # in a documented function, or documenting parameters that don't exist or using 697 | # markup commands wrongly. 698 | # The default value is: YES. 699 | 700 | WARN_IF_DOC_ERROR = YES 701 | 702 | # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that 703 | # are documented, but have no documentation for their parameters or return 704 | # value. If set to NO doxygen will only warn about wrong or incomplete parameter 705 | # documentation, but not about the absence of documentation. 706 | # The default value is: NO. 707 | 708 | WARN_NO_PARAMDOC = NO 709 | 710 | # The WARN_FORMAT tag determines the format of the warning messages that doxygen 711 | # can produce. The string should contain the $file, $line, and $text tags, which 712 | # will be replaced by the file and line number from which the warning originated 713 | # and the warning text. Optionally the format may contain $version, which will 714 | # be replaced by the version of the file (if it could be obtained via 715 | # FILE_VERSION_FILTER) 716 | # The default value is: $file:$line: $text. 717 | 718 | WARN_FORMAT = "$file:$line: $text" 719 | 720 | # The WARN_LOGFILE tag can be used to specify a file to which warning and error 721 | # messages should be written. If left blank the output is written to standard 722 | # error (stderr). 723 | 724 | WARN_LOGFILE = 725 | 726 | #--------------------------------------------------------------------------- 727 | # Configuration options related to the input files 728 | #--------------------------------------------------------------------------- 729 | 730 | # The INPUT tag is used to specify the files and/or directories that contain 731 | # documented source files. You may enter file names like myfile.cpp or 732 | # directories like /usr/src/myproject. Separate the files or directories with 733 | # spaces. 734 | # Note: If this tag is empty the current directory is searched. 735 | 736 | INPUT = 737 | 738 | # This tag can be used to specify the character encoding of the source files 739 | # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses 740 | # libiconv (or the iconv built into libc) for the transcoding. See the libiconv 741 | # documentation (see: http://www.gnu.org/software/libiconv) for the list of 742 | # possible encodings. 743 | # The default value is: UTF-8. 744 | 745 | INPUT_ENCODING = UTF-8 746 | 747 | # If the value of the INPUT tag contains directories, you can use the 748 | # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and 749 | # *.h) to filter out the source-files in the directories. If left blank the 750 | # following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii, 751 | # *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, 752 | # *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, 753 | # *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, 754 | # *.qsf, *.as and *.js. 755 | 756 | FILE_PATTERNS = 757 | 758 | # The RECURSIVE tag can be used to specify whether or not subdirectories should 759 | # be searched for input files as well. 760 | # The default value is: NO. 761 | 762 | RECURSIVE = YES 763 | 764 | # The EXCLUDE tag can be used to specify files and/or directories that should be 765 | # excluded from the INPUT source files. This way you can easily exclude a 766 | # subdirectory from a directory tree whose root is specified with the INPUT tag. 767 | # 768 | # Note that relative paths are relative to the directory from which doxygen is 769 | # run. 770 | 771 | EXCLUDE = 772 | 773 | # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or 774 | # directories that are symbolic links (a Unix file system feature) are excluded 775 | # from the input. 776 | # The default value is: NO. 777 | 778 | EXCLUDE_SYMLINKS = NO 779 | 780 | # If the value of the INPUT tag contains directories, you can use the 781 | # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 782 | # certain files from those directories. 783 | # 784 | # Note that the wildcards are matched against the file with absolute path, so to 785 | # exclude all test directories for example use the pattern */test/* 786 | 787 | EXCLUDE_PATTERNS = 788 | 789 | # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 790 | # (namespaces, classes, functions, etc.) that should be excluded from the 791 | # output. The symbol name can be a fully qualified name, a word, or if the 792 | # wildcard * is used, a substring. Examples: ANamespace, AClass, 793 | # AClass::ANamespace, ANamespace::*Test 794 | # 795 | # Note that the wildcards are matched against the file with absolute path, so to 796 | # exclude all test directories use the pattern */test/* 797 | 798 | EXCLUDE_SYMBOLS = 799 | 800 | # The EXAMPLE_PATH tag can be used to specify one or more files or directories 801 | # that contain example code fragments that are included (see the \include 802 | # command). 803 | 804 | EXAMPLE_PATH = 805 | 806 | # If the value of the EXAMPLE_PATH tag contains directories, you can use the 807 | # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and 808 | # *.h) to filter out the source-files in the directories. If left blank all 809 | # files are included. 810 | 811 | EXAMPLE_PATTERNS = 812 | 813 | # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 814 | # searched for input files to be used with the \include or \dontinclude commands 815 | # irrespective of the value of the RECURSIVE tag. 816 | # The default value is: NO. 817 | 818 | EXAMPLE_RECURSIVE = NO 819 | 820 | # The IMAGE_PATH tag can be used to specify one or more files or directories 821 | # that contain images that are to be included in the documentation (see the 822 | # \image command). 823 | 824 | IMAGE_PATH = 825 | 826 | # The INPUT_FILTER tag can be used to specify a program that doxygen should 827 | # invoke to filter for each input file. Doxygen will invoke the filter program 828 | # by executing (via popen()) the command: 829 | # 830 | # 831 | # 832 | # where is the value of the INPUT_FILTER tag, and is the 833 | # name of an input file. Doxygen will then use the output that the filter 834 | # program writes to standard output. If FILTER_PATTERNS is specified, this tag 835 | # will be ignored. 836 | # 837 | # Note that the filter must not add or remove lines; it is applied before the 838 | # code is scanned, but not when the output code is generated. If lines are added 839 | # or removed, the anchors will not be placed correctly. 840 | 841 | INPUT_FILTER = 842 | 843 | # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 844 | # basis. Doxygen will compare the file name with each pattern and apply the 845 | # filter if there is a match. The filters are a list of the form: pattern=filter 846 | # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how 847 | # filters are used. If the FILTER_PATTERNS tag is empty or if none of the 848 | # patterns match the file name, INPUT_FILTER is applied. 849 | 850 | FILTER_PATTERNS = 851 | 852 | # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 853 | # INPUT_FILTER ) will also be used to filter the input files that are used for 854 | # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). 855 | # The default value is: NO. 856 | 857 | FILTER_SOURCE_FILES = NO 858 | 859 | # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file 860 | # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and 861 | # it is also possible to disable source filtering for a specific pattern using 862 | # *.ext= (so without naming a filter). 863 | # This tag requires that the tag FILTER_SOURCE_FILES is set to YES. 864 | 865 | FILTER_SOURCE_PATTERNS = 866 | 867 | # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that 868 | # is part of the input, its contents will be placed on the main page 869 | # (index.html). This can be useful if you have a project on for instance GitHub 870 | # and want to reuse the introduction page also for the doxygen output. 871 | 872 | USE_MDFILE_AS_MAINPAGE = 873 | 874 | #--------------------------------------------------------------------------- 875 | # Configuration options related to source browsing 876 | #--------------------------------------------------------------------------- 877 | 878 | # If the SOURCE_BROWSER tag is set to YES then a list of source files will be 879 | # generated. Documented entities will be cross-referenced with these sources. 880 | # 881 | # Note: To get rid of all source code in the generated output, make sure that 882 | # also VERBATIM_HEADERS is set to NO. 883 | # The default value is: NO. 884 | 885 | SOURCE_BROWSER = NO 886 | 887 | # Setting the INLINE_SOURCES tag to YES will include the body of functions, 888 | # classes and enums directly into the documentation. 889 | # The default value is: NO. 890 | 891 | INLINE_SOURCES = NO 892 | 893 | # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any 894 | # special comment blocks from generated source code fragments. Normal C, C++ and 895 | # Fortran comments will always remain visible. 896 | # The default value is: YES. 897 | 898 | STRIP_CODE_COMMENTS = YES 899 | 900 | # If the REFERENCED_BY_RELATION tag is set to YES then for each documented 901 | # function all documented functions referencing it will be listed. 902 | # The default value is: NO. 903 | 904 | REFERENCED_BY_RELATION = NO 905 | 906 | # If the REFERENCES_RELATION tag is set to YES then for each documented function 907 | # all documented entities called/used by that function will be listed. 908 | # The default value is: NO. 909 | 910 | REFERENCES_RELATION = NO 911 | 912 | # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set 913 | # to YES, then the hyperlinks from functions in REFERENCES_RELATION and 914 | # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will 915 | # link to the documentation. 916 | # The default value is: YES. 917 | 918 | REFERENCES_LINK_SOURCE = YES 919 | 920 | # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the 921 | # source code will show a tooltip with additional information such as prototype, 922 | # brief description and links to the definition and documentation. Since this 923 | # will make the HTML file larger and loading of large files a bit slower, you 924 | # can opt to disable this feature. 925 | # The default value is: YES. 926 | # This tag requires that the tag SOURCE_BROWSER is set to YES. 927 | 928 | SOURCE_TOOLTIPS = YES 929 | 930 | # If the USE_HTAGS tag is set to YES then the references to source code will 931 | # point to the HTML generated by the htags(1) tool instead of doxygen built-in 932 | # source browser. The htags tool is part of GNU's global source tagging system 933 | # (see http://www.gnu.org/software/global/global.html). You will need version 934 | # 4.8.6 or higher. 935 | # 936 | # To use it do the following: 937 | # - Install the latest version of global 938 | # - Enable SOURCE_BROWSER and USE_HTAGS in the config file 939 | # - Make sure the INPUT points to the root of the source tree 940 | # - Run doxygen as normal 941 | # 942 | # Doxygen will invoke htags (and that will in turn invoke gtags), so these 943 | # tools must be available from the command line (i.e. in the search path). 944 | # 945 | # The result: instead of the source browser generated by doxygen, the links to 946 | # source code will now point to the output of htags. 947 | # The default value is: NO. 948 | # This tag requires that the tag SOURCE_BROWSER is set to YES. 949 | 950 | USE_HTAGS = NO 951 | 952 | # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a 953 | # verbatim copy of the header file for each class for which an include is 954 | # specified. Set to NO to disable this. 955 | # See also: Section \class. 956 | # The default value is: YES. 957 | 958 | VERBATIM_HEADERS = YES 959 | 960 | #--------------------------------------------------------------------------- 961 | # Configuration options related to the alphabetical class index 962 | #--------------------------------------------------------------------------- 963 | 964 | # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all 965 | # compounds will be generated. Enable this if the project contains a lot of 966 | # classes, structs, unions or interfaces. 967 | # The default value is: YES. 968 | 969 | ALPHABETICAL_INDEX = YES 970 | 971 | # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in 972 | # which the alphabetical index list will be split. 973 | # Minimum value: 1, maximum value: 20, default value: 5. 974 | # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 975 | 976 | COLS_IN_ALPHA_INDEX = 5 977 | 978 | # In case all classes in a project start with a common prefix, all classes will 979 | # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag 980 | # can be used to specify a prefix (or a list of prefixes) that should be ignored 981 | # while generating the index headers. 982 | # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 983 | 984 | IGNORE_PREFIX = 985 | 986 | #--------------------------------------------------------------------------- 987 | # Configuration options related to the HTML output 988 | #--------------------------------------------------------------------------- 989 | 990 | # If the GENERATE_HTML tag is set to YES doxygen will generate HTML output 991 | # The default value is: YES. 992 | 993 | GENERATE_HTML = YES 994 | 995 | # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a 996 | # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 997 | # it. 998 | # The default directory is: html. 999 | # This tag requires that the tag GENERATE_HTML is set to YES. 1000 | 1001 | HTML_OUTPUT = html 1002 | 1003 | # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each 1004 | # generated HTML page (for example: .htm, .php, .asp). 1005 | # The default value is: .html. 1006 | # This tag requires that the tag GENERATE_HTML is set to YES. 1007 | 1008 | HTML_FILE_EXTENSION = .html 1009 | 1010 | # The HTML_HEADER tag can be used to specify a user-defined HTML header file for 1011 | # each generated HTML page. If the tag is left blank doxygen will generate a 1012 | # standard header. 1013 | # 1014 | # To get valid HTML the header file that includes any scripts and style sheets 1015 | # that doxygen needs, which is dependent on the configuration options used (e.g. 1016 | # the setting GENERATE_TREEVIEW). It is highly recommended to start with a 1017 | # default header using 1018 | # doxygen -w html new_header.html new_footer.html new_stylesheet.css 1019 | # YourConfigFile 1020 | # and then modify the file new_header.html. See also section "Doxygen usage" 1021 | # for information on how to generate the default header that doxygen normally 1022 | # uses. 1023 | # Note: The header is subject to change so you typically have to regenerate the 1024 | # default header when upgrading to a newer version of doxygen. For a description 1025 | # of the possible markers and block names see the documentation. 1026 | # This tag requires that the tag GENERATE_HTML is set to YES. 1027 | 1028 | HTML_HEADER = 1029 | 1030 | # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each 1031 | # generated HTML page. If the tag is left blank doxygen will generate a standard 1032 | # footer. See HTML_HEADER for more information on how to generate a default 1033 | # footer and what special commands can be used inside the footer. See also 1034 | # section "Doxygen usage" for information on how to generate the default footer 1035 | # that doxygen normally uses. 1036 | # This tag requires that the tag GENERATE_HTML is set to YES. 1037 | 1038 | HTML_FOOTER = 1039 | 1040 | # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style 1041 | # sheet that is used by each HTML page. It can be used to fine-tune the look of 1042 | # the HTML output. If left blank doxygen will generate a default style sheet. 1043 | # See also section "Doxygen usage" for information on how to generate the style 1044 | # sheet that doxygen normally uses. 1045 | # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as 1046 | # it is more robust and this tag (HTML_STYLESHEET) will in the future become 1047 | # obsolete. 1048 | # This tag requires that the tag GENERATE_HTML is set to YES. 1049 | 1050 | HTML_STYLESHEET = 1051 | 1052 | # The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user- 1053 | # defined cascading style sheet that is included after the standard style sheets 1054 | # created by doxygen. Using this option one can overrule certain style aspects. 1055 | # This is preferred over using HTML_STYLESHEET since it does not replace the 1056 | # standard style sheet and is therefor more robust against future updates. 1057 | # Doxygen will copy the style sheet file to the output directory. For an example 1058 | # see the documentation. 1059 | # This tag requires that the tag GENERATE_HTML is set to YES. 1060 | 1061 | HTML_EXTRA_STYLESHEET = 1062 | 1063 | # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or 1064 | # other source files which should be copied to the HTML output directory. Note 1065 | # that these files will be copied to the base HTML output directory. Use the 1066 | # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these 1067 | # files. In the HTML_STYLESHEET file, use the file name only. Also note that the 1068 | # files will be copied as-is; there are no commands or markers available. 1069 | # This tag requires that the tag GENERATE_HTML is set to YES. 1070 | 1071 | HTML_EXTRA_FILES = 1072 | 1073 | # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen 1074 | # will adjust the colors in the stylesheet and background images according to 1075 | # this color. Hue is specified as an angle on a colorwheel, see 1076 | # http://en.wikipedia.org/wiki/Hue for more information. For instance the value 1077 | # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 1078 | # purple, and 360 is red again. 1079 | # Minimum value: 0, maximum value: 359, default value: 220. 1080 | # This tag requires that the tag GENERATE_HTML is set to YES. 1081 | 1082 | HTML_COLORSTYLE_HUE = 220 1083 | 1084 | # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors 1085 | # in the HTML output. For a value of 0 the output will use grayscales only. A 1086 | # value of 255 will produce the most vivid colors. 1087 | # Minimum value: 0, maximum value: 255, default value: 100. 1088 | # This tag requires that the tag GENERATE_HTML is set to YES. 1089 | 1090 | HTML_COLORSTYLE_SAT = 100 1091 | 1092 | # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the 1093 | # luminance component of the colors in the HTML output. Values below 100 1094 | # gradually make the output lighter, whereas values above 100 make the output 1095 | # darker. The value divided by 100 is the actual gamma applied, so 80 represents 1096 | # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not 1097 | # change the gamma. 1098 | # Minimum value: 40, maximum value: 240, default value: 80. 1099 | # This tag requires that the tag GENERATE_HTML is set to YES. 1100 | 1101 | HTML_COLORSTYLE_GAMMA = 80 1102 | 1103 | # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML 1104 | # page will contain the date and time when the page was generated. Setting this 1105 | # to NO can help when comparing the output of multiple runs. 1106 | # The default value is: YES. 1107 | # This tag requires that the tag GENERATE_HTML is set to YES. 1108 | 1109 | HTML_TIMESTAMP = YES 1110 | 1111 | # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 1112 | # documentation will contain sections that can be hidden and shown after the 1113 | # page has loaded. 1114 | # The default value is: NO. 1115 | # This tag requires that the tag GENERATE_HTML is set to YES. 1116 | 1117 | HTML_DYNAMIC_SECTIONS = NO 1118 | 1119 | # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries 1120 | # shown in the various tree structured indices initially; the user can expand 1121 | # and collapse entries dynamically later on. Doxygen will expand the tree to 1122 | # such a level that at most the specified number of entries are visible (unless 1123 | # a fully collapsed tree already exceeds this amount). So setting the number of 1124 | # entries 1 will produce a full collapsed tree by default. 0 is a special value 1125 | # representing an infinite number of entries and will result in a full expanded 1126 | # tree by default. 1127 | # Minimum value: 0, maximum value: 9999, default value: 100. 1128 | # This tag requires that the tag GENERATE_HTML is set to YES. 1129 | 1130 | HTML_INDEX_NUM_ENTRIES = 100 1131 | 1132 | # If the GENERATE_DOCSET tag is set to YES, additional index files will be 1133 | # generated that can be used as input for Apple's Xcode 3 integrated development 1134 | # environment (see: http://developer.apple.com/tools/xcode/), introduced with 1135 | # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a 1136 | # Makefile in the HTML output directory. Running make will produce the docset in 1137 | # that directory and running make install will install the docset in 1138 | # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at 1139 | # startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html 1140 | # for more information. 1141 | # The default value is: NO. 1142 | # This tag requires that the tag GENERATE_HTML is set to YES. 1143 | 1144 | GENERATE_DOCSET = NO 1145 | 1146 | # This tag determines the name of the docset feed. A documentation feed provides 1147 | # an umbrella under which multiple documentation sets from a single provider 1148 | # (such as a company or product suite) can be grouped. 1149 | # The default value is: Doxygen generated docs. 1150 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1151 | 1152 | DOCSET_FEEDNAME = "Doxygen generated docs" 1153 | 1154 | # This tag specifies a string that should uniquely identify the documentation 1155 | # set bundle. This should be a reverse domain-name style string, e.g. 1156 | # com.mycompany.MyDocSet. Doxygen will append .docset to the name. 1157 | # The default value is: org.doxygen.Project. 1158 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1159 | 1160 | DOCSET_BUNDLE_ID = org.doxygen.Project 1161 | 1162 | # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify 1163 | # the documentation publisher. This should be a reverse domain-name style 1164 | # string, e.g. com.mycompany.MyDocSet.documentation. 1165 | # The default value is: org.doxygen.Publisher. 1166 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1167 | 1168 | DOCSET_PUBLISHER_ID = org.doxygen.Publisher 1169 | 1170 | # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. 1171 | # The default value is: Publisher. 1172 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1173 | 1174 | DOCSET_PUBLISHER_NAME = Publisher 1175 | 1176 | # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three 1177 | # additional HTML index files: index.hhp, index.hhc, and index.hhk. The 1178 | # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop 1179 | # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on 1180 | # Windows. 1181 | # 1182 | # The HTML Help Workshop contains a compiler that can convert all HTML output 1183 | # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML 1184 | # files are now used as the Windows 98 help format, and will replace the old 1185 | # Windows help format (.hlp) on all Windows platforms in the future. Compressed 1186 | # HTML files also contain an index, a table of contents, and you can search for 1187 | # words in the documentation. The HTML workshop also contains a viewer for 1188 | # compressed HTML files. 1189 | # The default value is: NO. 1190 | # This tag requires that the tag GENERATE_HTML is set to YES. 1191 | 1192 | GENERATE_HTMLHELP = NO 1193 | 1194 | # The CHM_FILE tag can be used to specify the file name of the resulting .chm 1195 | # file. You can add a path in front of the file if the result should not be 1196 | # written to the html output directory. 1197 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1198 | 1199 | CHM_FILE = 1200 | 1201 | # The HHC_LOCATION tag can be used to specify the location (absolute path 1202 | # including file name) of the HTML help compiler ( hhc.exe). If non-empty 1203 | # doxygen will try to run the HTML help compiler on the generated index.hhp. 1204 | # The file has to be specified with full path. 1205 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1206 | 1207 | HHC_LOCATION = 1208 | 1209 | # The GENERATE_CHI flag controls if a separate .chi index file is generated ( 1210 | # YES) or that it should be included in the master .chm file ( NO). 1211 | # The default value is: NO. 1212 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1213 | 1214 | GENERATE_CHI = NO 1215 | 1216 | # The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc) 1217 | # and project file content. 1218 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1219 | 1220 | CHM_INDEX_ENCODING = 1221 | 1222 | # The BINARY_TOC flag controls whether a binary table of contents is generated ( 1223 | # YES) or a normal table of contents ( NO) in the .chm file. 1224 | # The default value is: NO. 1225 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1226 | 1227 | BINARY_TOC = NO 1228 | 1229 | # The TOC_EXPAND flag can be set to YES to add extra items for group members to 1230 | # the table of contents of the HTML help documentation and to the tree view. 1231 | # The default value is: NO. 1232 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1233 | 1234 | TOC_EXPAND = NO 1235 | 1236 | # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and 1237 | # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that 1238 | # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help 1239 | # (.qch) of the generated HTML documentation. 1240 | # The default value is: NO. 1241 | # This tag requires that the tag GENERATE_HTML is set to YES. 1242 | 1243 | GENERATE_QHP = NO 1244 | 1245 | # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify 1246 | # the file name of the resulting .qch file. The path specified is relative to 1247 | # the HTML output folder. 1248 | # This tag requires that the tag GENERATE_QHP is set to YES. 1249 | 1250 | QCH_FILE = 1251 | 1252 | # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help 1253 | # Project output. For more information please see Qt Help Project / Namespace 1254 | # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). 1255 | # The default value is: org.doxygen.Project. 1256 | # This tag requires that the tag GENERATE_QHP is set to YES. 1257 | 1258 | QHP_NAMESPACE = org.doxygen.Project 1259 | 1260 | # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt 1261 | # Help Project output. For more information please see Qt Help Project / Virtual 1262 | # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- 1263 | # folders). 1264 | # The default value is: doc. 1265 | # This tag requires that the tag GENERATE_QHP is set to YES. 1266 | 1267 | QHP_VIRTUAL_FOLDER = doc 1268 | 1269 | # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom 1270 | # filter to add. For more information please see Qt Help Project / Custom 1271 | # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- 1272 | # filters). 1273 | # This tag requires that the tag GENERATE_QHP is set to YES. 1274 | 1275 | QHP_CUST_FILTER_NAME = 1276 | 1277 | # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the 1278 | # custom filter to add. For more information please see Qt Help Project / Custom 1279 | # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- 1280 | # filters). 1281 | # This tag requires that the tag GENERATE_QHP is set to YES. 1282 | 1283 | QHP_CUST_FILTER_ATTRS = 1284 | 1285 | # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this 1286 | # project's filter section matches. Qt Help Project / Filter Attributes (see: 1287 | # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). 1288 | # This tag requires that the tag GENERATE_QHP is set to YES. 1289 | 1290 | QHP_SECT_FILTER_ATTRS = 1291 | 1292 | # The QHG_LOCATION tag can be used to specify the location of Qt's 1293 | # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the 1294 | # generated .qhp file. 1295 | # This tag requires that the tag GENERATE_QHP is set to YES. 1296 | 1297 | QHG_LOCATION = 1298 | 1299 | # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be 1300 | # generated, together with the HTML files, they form an Eclipse help plugin. To 1301 | # install this plugin and make it available under the help contents menu in 1302 | # Eclipse, the contents of the directory containing the HTML and XML files needs 1303 | # to be copied into the plugins directory of eclipse. The name of the directory 1304 | # within the plugins directory should be the same as the ECLIPSE_DOC_ID value. 1305 | # After copying Eclipse needs to be restarted before the help appears. 1306 | # The default value is: NO. 1307 | # This tag requires that the tag GENERATE_HTML is set to YES. 1308 | 1309 | GENERATE_ECLIPSEHELP = NO 1310 | 1311 | # A unique identifier for the Eclipse help plugin. When installing the plugin 1312 | # the directory name containing the HTML and XML files should also have this 1313 | # name. Each documentation set should have its own identifier. 1314 | # The default value is: org.doxygen.Project. 1315 | # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. 1316 | 1317 | ECLIPSE_DOC_ID = org.doxygen.Project 1318 | 1319 | # If you want full control over the layout of the generated HTML pages it might 1320 | # be necessary to disable the index and replace it with your own. The 1321 | # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top 1322 | # of each HTML page. A value of NO enables the index and the value YES disables 1323 | # it. Since the tabs in the index contain the same information as the navigation 1324 | # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. 1325 | # The default value is: NO. 1326 | # This tag requires that the tag GENERATE_HTML is set to YES. 1327 | 1328 | DISABLE_INDEX = NO 1329 | 1330 | # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 1331 | # structure should be generated to display hierarchical information. If the tag 1332 | # value is set to YES, a side panel will be generated containing a tree-like 1333 | # index structure (just like the one that is generated for HTML Help). For this 1334 | # to work a browser that supports JavaScript, DHTML, CSS and frames is required 1335 | # (i.e. any modern browser). Windows users are probably better off using the 1336 | # HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can 1337 | # further fine-tune the look of the index. As an example, the default style 1338 | # sheet generated by doxygen has an example that shows how to put an image at 1339 | # the root of the tree instead of the PROJECT_NAME. Since the tree basically has 1340 | # the same information as the tab index, you could consider setting 1341 | # DISABLE_INDEX to YES when enabling this option. 1342 | # The default value is: NO. 1343 | # This tag requires that the tag GENERATE_HTML is set to YES. 1344 | 1345 | GENERATE_TREEVIEW = YES 1346 | 1347 | # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that 1348 | # doxygen will group on one line in the generated HTML documentation. 1349 | # 1350 | # Note that a value of 0 will completely suppress the enum values from appearing 1351 | # in the overview section. 1352 | # Minimum value: 0, maximum value: 20, default value: 4. 1353 | # This tag requires that the tag GENERATE_HTML is set to YES. 1354 | 1355 | ENUM_VALUES_PER_LINE = 4 1356 | 1357 | # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used 1358 | # to set the initial width (in pixels) of the frame in which the tree is shown. 1359 | # Minimum value: 0, maximum value: 1500, default value: 250. 1360 | # This tag requires that the tag GENERATE_HTML is set to YES. 1361 | 1362 | TREEVIEW_WIDTH = 250 1363 | 1364 | # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to 1365 | # external symbols imported via tag files in a separate window. 1366 | # The default value is: NO. 1367 | # This tag requires that the tag GENERATE_HTML is set to YES. 1368 | 1369 | EXT_LINKS_IN_WINDOW = NO 1370 | 1371 | # Use this tag to change the font size of LaTeX formulas included as images in 1372 | # the HTML documentation. When you change the font size after a successful 1373 | # doxygen run you need to manually remove any form_*.png images from the HTML 1374 | # output directory to force them to be regenerated. 1375 | # Minimum value: 8, maximum value: 50, default value: 10. 1376 | # This tag requires that the tag GENERATE_HTML is set to YES. 1377 | 1378 | FORMULA_FONTSIZE = 10 1379 | 1380 | # Use the FORMULA_TRANPARENT tag to determine whether or not the images 1381 | # generated for formulas are transparent PNGs. Transparent PNGs are not 1382 | # supported properly for IE 6.0, but are supported on all modern browsers. 1383 | # 1384 | # Note that when changing this option you need to delete any form_*.png files in 1385 | # the HTML output directory before the changes have effect. 1386 | # The default value is: YES. 1387 | # This tag requires that the tag GENERATE_HTML is set to YES. 1388 | 1389 | FORMULA_TRANSPARENT = YES 1390 | 1391 | # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see 1392 | # http://www.mathjax.org) which uses client side Javascript for the rendering 1393 | # instead of using prerendered bitmaps. Use this if you do not have LaTeX 1394 | # installed or if you want to formulas look prettier in the HTML output. When 1395 | # enabled you may also need to install MathJax separately and configure the path 1396 | # to it using the MATHJAX_RELPATH option. 1397 | # The default value is: NO. 1398 | # This tag requires that the tag GENERATE_HTML is set to YES. 1399 | 1400 | USE_MATHJAX = NO 1401 | 1402 | # When MathJax is enabled you can set the default output format to be used for 1403 | # the MathJax output. See the MathJax site (see: 1404 | # http://docs.mathjax.org/en/latest/output.html) for more details. 1405 | # Possible values are: HTML-CSS (which is slower, but has the best 1406 | # compatibility), NativeMML (i.e. MathML) and SVG. 1407 | # The default value is: HTML-CSS. 1408 | # This tag requires that the tag USE_MATHJAX is set to YES. 1409 | 1410 | MATHJAX_FORMAT = HTML-CSS 1411 | 1412 | # When MathJax is enabled you need to specify the location relative to the HTML 1413 | # output directory using the MATHJAX_RELPATH option. The destination directory 1414 | # should contain the MathJax.js script. For instance, if the mathjax directory 1415 | # is located at the same level as the HTML output directory, then 1416 | # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax 1417 | # Content Delivery Network so you can quickly see the result without installing 1418 | # MathJax. However, it is strongly recommended to install a local copy of 1419 | # MathJax from http://www.mathjax.org before deployment. 1420 | # The default value is: http://cdn.mathjax.org/mathjax/latest. 1421 | # This tag requires that the tag USE_MATHJAX is set to YES. 1422 | 1423 | MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest 1424 | 1425 | # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax 1426 | # extension names that should be enabled during MathJax rendering. For example 1427 | # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols 1428 | # This tag requires that the tag USE_MATHJAX is set to YES. 1429 | 1430 | MATHJAX_EXTENSIONS = 1431 | 1432 | # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces 1433 | # of code that will be used on startup of the MathJax code. See the MathJax site 1434 | # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an 1435 | # example see the documentation. 1436 | # This tag requires that the tag USE_MATHJAX is set to YES. 1437 | 1438 | MATHJAX_CODEFILE = 1439 | 1440 | # When the SEARCHENGINE tag is enabled doxygen will generate a search box for 1441 | # the HTML output. The underlying search engine uses javascript and DHTML and 1442 | # should work on any modern browser. Note that when using HTML help 1443 | # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) 1444 | # there is already a search function so this one should typically be disabled. 1445 | # For large projects the javascript based search engine can be slow, then 1446 | # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to 1447 | # search using the keyboard; to jump to the search box use + S 1448 | # (what the is depends on the OS and browser, but it is typically 1449 | # , /