docs updated

This commit is contained in:
Hauke Zühl
2017-06-06 14:39:53 +02:00
parent 23370963d4
commit d75e40bea7
143 changed files with 690 additions and 474 deletions
+12 -12
View File
@@ -284,45 +284,45 @@ $(document).ready(function(){initNavTree('example01_8cc_source.html','');});
<div class="line"><a name="l00197"></a><span class="lineno"> 197</span>&#160;</div>
<div class="line"><a name="l00198"></a><span class="lineno"> 198</span>&#160; <span class="keywordflow">if</span> (s != <span class="stringliteral">&quot;&quot;</span>) {</div>
<div class="line"><a name="l00199"></a><span class="lineno"> 199</span>&#160; <a class="code" href="classTelegram_1_1TelegramBot.html">Telegram::TelegramBot</a> tg(<a class="code" href="example01_8cc.html#a46ae855efe2974950d236ddeb7a7118a">BOT_TOKEN</a>);</div>
<div class="line"><a name="l00200"></a><span class="lineno"> 200</span>&#160; tg.<a class="code" href="classTelegram_1_1TelegramBot.html#a1645dae5fdfb1437bb8976f44c237563">sendMessage</a>(s, user_id);</div>
<div class="line"><a name="l00200"></a><span class="lineno"> 200</span>&#160; tg.<a class="code" href="classTelegram_1_1TelegramBot.html#acd21ba91f309c6d5fbcf7dc0063375ae">sendMessage</a>(s, user_id);</div>
<div class="line"><a name="l00201"></a><span class="lineno"> 201</span>&#160; }</div>
<div class="line"><a name="l00202"></a><span class="lineno"> 202</span>&#160;</div>
<div class="line"><a name="l00203"></a><span class="lineno"> 203</span>&#160; }</div>
<div class="line"><a name="l00204"></a><span class="lineno"> 204</span>&#160;</div>
<div class="line"><a name="l00205"></a><span class="lineno"> 205</span>&#160; <span class="keywordflow">return</span> 0;</div>
<div class="line"><a name="l00206"></a><span class="lineno"> 206</span>&#160;}</div>
<div class="ttc" id="structTelegram_1_1TCommand_html_a1c051d162e478b9f98efafbeeed19f9b"><div class="ttname"><a href="structTelegram_1_1TCommand.html#a1c051d162e478b9f98efafbeeed19f9b">Telegram::TCommand::command</a></div><div class="ttdeci">std::string command</div><div class="ttdoc">The command, e.g. /help. </div><div class="ttdef"><b>Definition:</b> <a href="TelegramBot_8h_source.html#l00026">TelegramBot.h:26</a></div></div>
<div class="ttc" id="structTelegram_1_1TCommand_html_a1c051d162e478b9f98efafbeeed19f9b"><div class="ttname"><a href="structTelegram_1_1TCommand.html#a1c051d162e478b9f98efafbeeed19f9b">Telegram::TCommand::command</a></div><div class="ttdeci">std::string command</div><div class="ttdoc">The command, e.g. /help. </div><div class="ttdef"><b>Definition:</b> <a href="TelegramBot_8h_source.html#l00027">TelegramBot.h:27</a></div></div>
<div class="ttc" id="example01_8cc_html_a3c04138a5bfe5d72780bb7e82a18e627"><div class="ttname"><a href="example01_8cc.html#a3c04138a5bfe5d72780bb7e82a18e627">main</a></div><div class="ttdeci">int main(int argc, char **argv)</div><div class="ttdef"><b>Definition:</b> <a href="example01_8cc_source.html#l00116">example01.cc:116</a></div></div>
<div class="ttc" id="example01_8cc_html_ad80d7c455c0c87f879a92658ad28329d"><div class="ttname"><a href="example01_8cc.html#ad80d7c455c0c87f879a92658ad28329d">help</a></div><div class="ttdeci">std::string help(Telegram::TelegramBot *tg, Telegram::TCommandLine args)</div><div class="ttdef"><b>Definition:</b> <a href="example01_8cc_source.html#l00087">example01.cc:87</a></div></div>
<div class="ttc" id="example01_8cc_html_a62e688e1f7e24b74a53a2bf7da93e5c1"><div class="ttname"><a href="example01_8cc.html#a62e688e1f7e24b74a53a2bf7da93e5c1">start</a></div><div class="ttdeci">std::string start(Telegram::TelegramBot *tg, Telegram::TCommandLine args)</div><div class="ttdef"><b>Definition:</b> <a href="example01_8cc_source.html#l00082">example01.cc:82</a></div></div>
<div class="ttc" id="example01_8cc_html_a0d2f37137ee1fd6ff4a0ef803849dd63"><div class="ttname"><a href="example01_8cc.html#a0d2f37137ee1fd6ff4a0ef803849dd63">SSTR</a></div><div class="ttdeci">#define SSTR(x)</div><div class="ttdef"><b>Definition:</b> <a href="example01_8cc_source.html#l00035">example01.cc:35</a></div></div>
<div class="ttc" id="classTelegram_1_1TelegramBot_html_a1645dae5fdfb1437bb8976f44c237563"><div class="ttname"><a href="classTelegram_1_1TelegramBot.html#a1645dae5fdfb1437bb8976f44c237563">Telegram::TelegramBot::sendMessage</a></div><div class="ttdeci">void sendMessage(std::string, Json::Int64)</div><div class="ttdef"><b>Definition:</b> <a href="TelegramBot_8cc_source.html#l00090">TelegramBot.cc:90</a></div></div>
<div class="ttc" id="example01_8cc_html_a316c9e2b99ca29094112ea9f4f131b85"><div class="ttname"><a href="example01_8cc.html#a316c9e2b99ca29094112ea9f4f131b85">explode</a></div><div class="ttdeci">std::vector&lt; std::string &gt; explode(const std::string &amp;delimiter, const std::string &amp;str)</div><div class="ttdef"><b>Definition:</b> <a href="example01_8cc_source.html#l00054">example01.cc:54</a></div></div>
<div class="ttc" id="structTelegram_1_1TCommand_html_a867f39a193fc9362da5b7111a655ae2b"><div class="ttname"><a href="structTelegram_1_1TCommand.html#a867f39a193fc9362da5b7111a655ae2b">Telegram::TCommand::help_text</a></div><div class="ttdeci">std::string help_text</div><div class="ttdoc">Help text of the command. </div><div class="ttdef"><b>Definition:</b> <a href="TelegramBot_8h_source.html#l00028">TelegramBot.h:28</a></div></div>
<div class="ttc" id="structTelegram_1_1TCommand_html_a867f39a193fc9362da5b7111a655ae2b"><div class="ttname"><a href="structTelegram_1_1TCommand.html#a867f39a193fc9362da5b7111a655ae2b">Telegram::TCommand::help_text</a></div><div class="ttdeci">std::string help_text</div><div class="ttdoc">Help text of the command. </div><div class="ttdef"><b>Definition:</b> <a href="TelegramBot_8h_source.html#l00029">TelegramBot.h:29</a></div></div>
<div class="ttc" id="classTelegram_1_1TelegramBot_html_af6fbb842f679b33dd8a60f94f82d7c81"><div class="ttname"><a href="classTelegram_1_1TelegramBot.html#af6fbb842f679b33dd8a60f94f82d7c81">Telegram::TelegramBot::processMessage</a></div><div class="ttdeci">void processMessage(std::string)</div><div class="ttdef"><b>Definition:</b> <a href="TelegramBot_8cc_source.html#l00074">TelegramBot.cc:74</a></div></div>
<div class="ttc" id="classTelegram_1_1TelegramBot_html_aae9aba06108ce34f9766199c6588e1d6"><div class="ttname"><a href="classTelegram_1_1TelegramBot.html#aae9aba06108ce34f9766199c6588e1d6">Telegram::TelegramBot::getCommandMap</a></div><div class="ttdeci">std::map&lt; std::string, TCommand &gt; getCommandMap()</div><div class="ttdef"><b>Definition:</b> <a href="TelegramBot_8cc_source.html#l00133">TelegramBot.cc:133</a></div></div>
<div class="ttc" id="structTelegram_1_1TCommand_html"><div class="ttname"><a href="structTelegram_1_1TCommand.html">Telegram::TCommand</a></div><div class="ttdef"><b>Definition:</b> <a href="TelegramBot_8h_source.html#l00025">TelegramBot.h:25</a></div></div>
<div class="ttc" id="classTelegram_1_1TelegramBot_html_aae9aba06108ce34f9766199c6588e1d6"><div class="ttname"><a href="classTelegram_1_1TelegramBot.html#aae9aba06108ce34f9766199c6588e1d6">Telegram::TelegramBot::getCommandMap</a></div><div class="ttdeci">std::map&lt; std::string, TCommand &gt; getCommandMap()</div><div class="ttdef"><b>Definition:</b> <a href="TelegramBot_8cc_source.html#l00151">TelegramBot.cc:151</a></div></div>
<div class="ttc" id="structTelegram_1_1TCommand_html"><div class="ttname"><a href="structTelegram_1_1TCommand.html">Telegram::TCommand</a></div><div class="ttdef"><b>Definition:</b> <a href="TelegramBot_8h_source.html#l00026">TelegramBot.h:26</a></div></div>
<div class="ttc" id="example01_8cc_html_a43b669bccb8bce8ea862a58a9dc116bd"><div class="ttname"><a href="example01_8cc.html#a43b669bccb8bce8ea862a58a9dc116bd">exec</a></div><div class="ttdeci">std::string exec(const char *cmd)</div><div class="ttdef"><b>Definition:</b> <a href="example01_8cc_source.html#l00037">example01.cc:37</a></div></div>
<div class="ttc" id="TelegramBot_8h_html"><div class="ttname"><a href="TelegramBot_8h.html">TelegramBot.h</a></div></div>
<div class="ttc" id="example01_8cc_html_aecdda2b4770f85617b26cf01e056354b"><div class="ttname"><a href="example01_8cc.html#aecdda2b4770f85617b26cf01e056354b">proc</a></div><div class="ttdeci">std::string proc(Telegram::TelegramBot *tg, Telegram::TCommandLine args)</div><div class="ttdef"><b>Definition:</b> <a href="example01_8cc_source.html#l00110">example01.cc:110</a></div></div>
<div class="ttc" id="structTelegram_1_1TCommand_html_a3f2c8ecbfd34be25baa577afee2e6e52"><div class="ttname"><a href="structTelegram_1_1TCommand.html#a3f2c8ecbfd34be25baa577afee2e6e52">Telegram::TCommand::callback</a></div><div class="ttdeci">CommandCallback callback</div><div class="ttdoc">Pointer to the callback function. </div><div class="ttdef"><b>Definition:</b> <a href="TelegramBot_8h_source.html#l00027">TelegramBot.h:27</a></div></div>
<div class="ttc" id="structTelegram_1_1TCommand_html_a3f2c8ecbfd34be25baa577afee2e6e52"><div class="ttname"><a href="structTelegram_1_1TCommand.html#a3f2c8ecbfd34be25baa577afee2e6e52">Telegram::TCommand::callback</a></div><div class="ttdeci">CommandCallback callback</div><div class="ttdoc">Pointer to the callback function. </div><div class="ttdef"><b>Definition:</b> <a href="TelegramBot_8h_source.html#l00028">TelegramBot.h:28</a></div></div>
<div class="ttc" id="example01_8cc_html_a127652392bff79b07e87fc7cfa88508c"><div class="ttname"><a href="example01_8cc.html#a127652392bff79b07e87fc7cfa88508c">whoami</a></div><div class="ttdeci">std::string whoami(Telegram::TelegramBot *tg, Telegram::TCommandLine args)</div><div class="ttdef"><b>Definition:</b> <a href="example01_8cc_source.html#l00100">example01.cc:100</a></div></div>
<div class="ttc" id="classTelegram_1_1Message_html_a18d5d0522058707134a3547f7288663e"><div class="ttname"><a href="classTelegram_1_1Message.html#a18d5d0522058707134a3547f7288663e">Telegram::Message::getChat</a></div><div class="ttdeci">Telegram::Chat * getChat()</div><div class="ttdef"><b>Definition:</b> <a href="Message_8cc_source.html#l00122">Message.cc:122</a></div></div>
<div class="ttc" id="namespaceTelegram_html_ad82f4bcddd3c7921e8842bb30170a1c2"><div class="ttname"><a href="namespaceTelegram.html#ad82f4bcddd3c7921e8842bb30170a1c2">Telegram::TCommandMap</a></div><div class="ttdeci">std::map&lt; std::string, TCommand &gt; TCommandMap</div><div class="ttdoc">Map that stores the known commands. </div><div class="ttdef"><b>Definition:</b> <a href="TelegramBot_8h_source.html#l00030">TelegramBot.h:30</a></div></div>
<div class="ttc" id="namespaceTelegram_html_a97c1241696e3250bf462adae6b65a563"><div class="ttname"><a href="namespaceTelegram.html#a97c1241696e3250bf462adae6b65a563">Telegram::TCommandLine</a></div><div class="ttdeci">std::vector&lt; std::string &gt; TCommandLine</div><div class="ttdoc">Arguments for the bot&#39;s commands. </div><div class="ttdef"><b>Definition:</b> <a href="TelegramBot_8h_source.html#l00017">TelegramBot.h:17</a></div></div>
<div class="ttc" id="namespaceTelegram_html_ad82f4bcddd3c7921e8842bb30170a1c2"><div class="ttname"><a href="namespaceTelegram.html#ad82f4bcddd3c7921e8842bb30170a1c2">Telegram::TCommandMap</a></div><div class="ttdeci">std::map&lt; std::string, TCommand &gt; TCommandMap</div><div class="ttdoc">Map that stores the known commands. </div><div class="ttdef"><b>Definition:</b> <a href="TelegramBot_8h_source.html#l00031">TelegramBot.h:31</a></div></div>
<div class="ttc" id="namespaceTelegram_html_a97c1241696e3250bf462adae6b65a563"><div class="ttname"><a href="namespaceTelegram.html#a97c1241696e3250bf462adae6b65a563">Telegram::TCommandLine</a></div><div class="ttdeci">std::vector&lt; std::string &gt; TCommandLine</div><div class="ttdoc">Arguments for the bot&#39;s commands. </div><div class="ttdef"><b>Definition:</b> <a href="TelegramBot_8h_source.html#l00018">TelegramBot.h:18</a></div></div>
<div class="ttc" id="classTelegram_1_1TelegramBot_html_a398bd76186e27d514afd835c5437c6ed"><div class="ttname"><a href="classTelegram_1_1TelegramBot.html#a398bd76186e27d514afd835c5437c6ed">Telegram::TelegramBot::addCommand</a></div><div class="ttdeci">void addCommand(TCommand)</div><div class="ttdef"><b>Definition:</b> <a href="TelegramBot_8cc_source.html#l00044">TelegramBot.cc:44</a></div></div>
<div class="ttc" id="classTelegram_1_1TelegramBot_html_a7c54766f656974b35f03ea510d7b6a4f"><div class="ttname"><a href="classTelegram_1_1TelegramBot.html#a7c54766f656974b35f03ea510d7b6a4f">Telegram::TelegramBot::getMessage</a></div><div class="ttdeci">Telegram::Message * getMessage()</div><div class="ttdef"><b>Definition:</b> <a href="TelegramBot_8cc_source.html#l00128">TelegramBot.cc:128</a></div></div>
<div class="ttc" id="classTelegram_1_1TelegramBot_html_a7c54766f656974b35f03ea510d7b6a4f"><div class="ttname"><a href="classTelegram_1_1TelegramBot.html#a7c54766f656974b35f03ea510d7b6a4f">Telegram::TelegramBot::getMessage</a></div><div class="ttdeci">Telegram::Message * getMessage()</div><div class="ttdef"><b>Definition:</b> <a href="TelegramBot_8cc_source.html#l00146">TelegramBot.cc:146</a></div></div>
<div class="ttc" id="classTelegram_1_1Chat_html_a4606d7a26be673bf83711f26e3cce85c"><div class="ttname"><a href="classTelegram_1_1Chat.html#a4606d7a26be673bf83711f26e3cce85c">Telegram::Chat::getId</a></div><div class="ttdeci">Json::Int64 getId()</div><div class="ttdef"><b>Definition:</b> <a href="Chat_8cc_source.html#l00013">Chat.cc:13</a></div></div>
<div class="ttc" id="example01_8cc_html_a46ae855efe2974950d236ddeb7a7118a"><div class="ttname"><a href="example01_8cc.html#a46ae855efe2974950d236ddeb7a7118a">BOT_TOKEN</a></div><div class="ttdeci">#define BOT_TOKEN</div><div class="ttdef"><b>Definition:</b> <a href="example01_8cc_source.html#l00034">example01.cc:34</a></div></div>
<div class="ttc" id="example01_8cc_html_aa93e480f3e6a877724767a4058c57ec5"><div class="ttname"><a href="example01_8cc.html#aa93e480f3e6a877724767a4058c57ec5">loadavg</a></div><div class="ttdeci">std::string loadavg(Telegram::TelegramBot *tg, Telegram::TCommandLine args)</div><div class="ttdef"><b>Definition:</b> <a href="example01_8cc_source.html#l00105">example01.cc:105</a></div></div>
<div class="ttc" id="classTelegram_1_1TelegramBot_html"><div class="ttname"><a href="classTelegram_1_1TelegramBot.html">Telegram::TelegramBot</a></div><div class="ttdef"><b>Definition:</b> <a href="TelegramBot_8h_source.html#l00032">TelegramBot.h:32</a></div></div>
<div class="ttc" id="classTelegram_1_1TelegramBot_html_acd21ba91f309c6d5fbcf7dc0063375ae"><div class="ttname"><a href="classTelegram_1_1TelegramBot.html#acd21ba91f309c6d5fbcf7dc0063375ae">Telegram::TelegramBot::sendMessage</a></div><div class="ttdeci">Telegram::Message * sendMessage(std::string, Json::Int64)</div><div class="ttdef"><b>Definition:</b> <a href="TelegramBot_8cc_source.html#l00100">TelegramBot.cc:100</a></div></div>
<div class="ttc" id="classTelegram_1_1TelegramBot_html"><div class="ttname"><a href="classTelegram_1_1TelegramBot.html">Telegram::TelegramBot</a></div><div class="ttdef"><b>Definition:</b> <a href="TelegramBot_8h_source.html#l00033">TelegramBot.h:33</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_c1e5849d565b56fca2010f6d30d9464c.html">examples</a></li><li class="navelem"><a class="el" href="example01_8cc.html">example01.cc</a></li>
<li class="footer">Generated on Sun Jun 4 2017 13:31:53 for LibTgBotPP by
<li class="footer">Generated on Tue Jun 6 2017 14:39:17 for LibTgBotPP by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li>
</ul>