Skip to content

Commit 0a52d6d

Browse files
committed
Update documentation
Signed-off-by: Elmurod Talipov <elmurod.talipov@gmail.com>
1 parent 1140fcd commit 0a52d6d

517 files changed

Lines changed: 53460 additions & 12348 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,3 +49,4 @@ build
4949

5050
# CLion projects
5151
.idea
52+

Doxyconf

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ PROJECT_NAME = "Telebot"
3838
# could be handy for archiving the generated documentation or if some version
3939
# control system is used.
4040

41-
PROJECT_NUMBER = 4.7.0
41+
PROJECT_NUMBER = 9.4
4242

4343
# Using the PROJECT_BRIEF tag one can provide an optional one line description
4444
# for a project that appears at the top of each page and should give viewer a
@@ -58,7 +58,7 @@ PROJECT_LOGO =
5858
# entered, it will be relative to the location where doxygen was started. If
5959
# left blank the current directory will be used.
6060

61-
OUTPUT_DIRECTORY =
61+
OUTPUT_DIRECTORY = docs
6262

6363
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub-
6464
# directories (in 2 levels) under the output directory of each output format and
@@ -743,7 +743,7 @@ WARN_LOGFILE =
743743
# spaces.
744744
# Note: If this tag is empty the current directory is searched.
745745

746-
INPUT = include
746+
INPUT = README.md include
747747

748748
# This tag can be used to specify the character encoding of the source files
749749
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ make
4242

4343
## Testing
4444

45-
Place Telegam Bot API Token in .toke file in the root folder of the repository, and run as below
45+
Place Telegam Bot API Token in `.token` file in the root folder of the repository, and run as below
4646
```sh
4747
./build/test/testbot
4848
```

docs/annotated.html

Lines changed: 156 additions & 56 deletions
Large diffs are not rendered by default.

docs/bc_sd.png

635 Bytes
Loading

docs/bdwn.png

-147 Bytes
Binary file not shown.

docs/classes.html

Lines changed: 31 additions & 32 deletions
Large diffs are not rendered by default.
Lines changed: 51 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2-
<html xmlns="http://www.w3.org/1999/xhtml">
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2+
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
33
<head>
44
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5-
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6-
<meta name="generator" content="Doxygen 1.8.13"/>
5+
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
6+
<meta name="generator" content="Doxygen 1.9.8"/>
77
<meta name="viewport" content="width=device-width, initial-scale=1"/>
88
<title>Telebot: include Directory Reference</title>
99
<link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -19,10 +19,9 @@
1919
<div id="titlearea">
2020
<table cellspacing="0" cellpadding="0">
2121
<tbody>
22-
<tr style="height: 56px;">
23-
<td id="projectalign" style="padding-left: 0.5em;">
24-
<div id="projectname">Telebot
25-
&#160;<span id="projectnumber">4.7.0</span>
22+
<tr id="projectrow">
23+
<td id="projectalign">
24+
<div id="projectname">Telebot<span id="projectnumber">&#160;9.4</span>
2625
</div>
2726
<div id="projectbrief">Library for Telegram bot API</div>
2827
</td>
@@ -31,17 +30,21 @@
3130
</table>
3231
</div>
3332
<!-- end header part -->
34-
<!-- Generated by Doxygen 1.8.13 -->
33+
<!-- Generated by Doxygen 1.9.8 -->
3534
<script type="text/javascript">
36-
var searchBox = new SearchBox("searchBox", "search",false,'Search');
35+
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
36+
var searchBox = new SearchBox("searchBox", "search/",'.html');
37+
/* @license-end */
3738
</script>
3839
<script type="text/javascript" src="menudata.js"></script>
3940
<script type="text/javascript" src="menu.js"></script>
4041
<script type="text/javascript">
42+
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
4143
$(function() {
4244
initMenu('',true,false,'search.php','Search');
4345
$(document).ready(function() { init_search(); });
4446
});
47+
/* @license-end */
4548
</script>
4649
<div id="main-nav"></div>
4750
<!-- window showing the filter options -->
@@ -53,9 +56,16 @@
5356

5457
<!-- iframe showing the search results (closed by default) -->
5558
<div id="MSearchResultsWindow">
56-
<iframe src="javascript:void(0)" frameborder="0"
57-
name="MSearchResults" id="MSearchResults">
58-
</iframe>
59+
<div id="MSearchResults">
60+
<div class="SRPage">
61+
<div id="SRIndex">
62+
<div id="SRResults"></div>
63+
<div class="SRStatus" id="Loading">Loading...</div>
64+
<div class="SRStatus" id="Searching">Searching...</div>
65+
<div class="SRStatus" id="NoMatches">No Matches</div>
66+
</div>
67+
</div>
68+
</div>
5969
</div>
6070

6171
<div id="nav-path" class="navpath">
@@ -64,32 +74,50 @@
6474
</div>
6575
</div><!-- top -->
6676
<div class="header">
67-
<div class="headertitle">
68-
<div class="title">include Directory Reference</div> </div>
77+
<div class="headertitle"><div class="title">include Directory Reference</div></div>
6978
</div><!--header-->
7079
<div class="contents">
7180
<table class="memberdecls">
72-
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="files"></a>
81+
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="files" name="files"></a>
7382
Files</h2></td></tr>
74-
<tr class="memitem:telebot-common_8h"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="telebot-common_8h.html">telebot-common.h</a> <a href="telebot-common_8h_source.html">[code]</a></td></tr>
83+
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top"><a href="telebot-common_8h_source.html"><span class="icondoc"></span></a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="telebot-common_8h.html">telebot-common.h</a></td></tr>
7584
<tr class="memdesc:telebot-common_8h"><td class="mdescLeft">&#160;</td><td class="mdescRight">This file contains telegram bot common defintions. <br /></td></tr>
7685
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
77-
<tr class="memitem:telebot-methods_8h"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="telebot-methods_8h.html">telebot-methods.h</a> <a href="telebot-methods_8h_source.html">[code]</a></td></tr>
86+
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top"><a href="telebot-core_8h_source.html"><span class="icondoc"></span></a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="telebot-core_8h.html">telebot-core.h</a></td></tr>
87+
<tr class="memdesc:telebot-core_8h"><td class="mdescLeft">&#160;</td><td class="mdescRight">This file contains core API for the telegram bot interface. <br /></td></tr>
88+
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
89+
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top"><a href="telebot-forums_8h_source.html"><span class="icondoc"></span></a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="telebot-forums_8h.html">telebot-forums.h</a></td></tr>
90+
<tr class="memdesc:telebot-forums_8h"><td class="mdescLeft">&#160;</td><td class="mdescRight">This file contains forums feature of telegram bot. <br /></td></tr>
91+
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
92+
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top"><a href="telebot-games_8h_source.html"><span class="icondoc"></span></a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="telebot-games_8h.html">telebot-games.h</a></td></tr>
93+
<tr class="memdesc:telebot-games_8h"><td class="mdescLeft">&#160;</td><td class="mdescRight">This file contains games feature of telegram bot. <br /></td></tr>
94+
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
95+
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top"><a href="telebot-inline_8h_source.html"><span class="icondoc"></span></a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="telebot-inline_8h.html">telebot-inline.h</a></td></tr>
96+
<tr class="memdesc:telebot-inline_8h"><td class="mdescLeft">&#160;</td><td class="mdescRight">This file contains inline mode feature of telegram bot. <br /></td></tr>
97+
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
98+
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top"><a href="telebot-methods_8h_source.html"><span class="icondoc"></span></a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="telebot-methods_8h.html">telebot-methods.h</a></td></tr>
7899
<tr class="memdesc:telebot-methods_8h"><td class="mdescLeft">&#160;</td><td class="mdescRight">This file contains methods used to create telegram bot. <br /></td></tr>
79100
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
80-
<tr class="memitem:telebot-stickers_8h"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="telebot-stickers_8h.html">telebot-stickers.h</a> <a href="telebot-stickers_8h_source.html">[code]</a></td></tr>
101+
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top"><a href="telebot-passport_8h_source.html"><span class="icondoc"></span></a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="telebot-passport_8h.html">telebot-passport.h</a></td></tr>
102+
<tr class="memdesc:telebot-passport_8h"><td class="mdescLeft">&#160;</td><td class="mdescRight">This file contains Telegram Passport feature of telegram bot. <br /></td></tr>
103+
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
104+
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top"><a href="telebot-payments_8h_source.html"><span class="icondoc"></span></a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="telebot-payments_8h.html">telebot-payments.h</a></td></tr>
105+
<tr class="memdesc:telebot-payments_8h"><td class="mdescLeft">&#160;</td><td class="mdescRight">This file contains payments feature of telegram bot. <br /></td></tr>
106+
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
107+
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top"><a href="telebot-stickers_8h_source.html"><span class="icondoc"></span></a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="telebot-stickers_8h.html">telebot-stickers.h</a></td></tr>
81108
<tr class="memdesc:telebot-stickers_8h"><td class="mdescLeft">&#160;</td><td class="mdescRight">This file contains stickers feature of telegram bot. <br /></td></tr>
82109
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
83-
<tr class="memitem:telebot-types_8h"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="telebot-types_8h.html">telebot-types.h</a> <a href="telebot-types_8h_source.html">[code]</a></td></tr>
110+
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top"><a href="telebot-types_8h_source.html"><span class="icondoc"></span></a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="telebot-types_8h.html">telebot-types.h</a></td></tr>
84111
<tr class="memdesc:telebot-types_8h"><td class="mdescLeft">&#160;</td><td class="mdescRight">This file contains types used to create telegram bot. <br /></td></tr>
85112
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
113+
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top"><a href="telebot_8h_source.html"><span class="icondoc"></span></a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="telebot_8h.html">telebot.h</a></td></tr>
114+
<tr class="memdesc:telebot_8h"><td class="mdescLeft">&#160;</td><td class="mdescRight">This file includes all the header files of the telegram bot library. <br /></td></tr>
115+
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
86116
</table>
87117
</div><!-- contents -->
88118
<!-- start footer part -->
89119
<hr class="footer"/><address class="footer"><small>
90-
Generated on Sun Apr 19 2020 06:10:32 for Telebot by &#160;<a href="http://www.doxygen.org/index.html">
91-
<img class="footer" src="doxygen.png" alt="doxygen"/>
92-
</a> 1.8.13
120+
Generated on Sat Feb 28 2026 00:34:22 for Telebot by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
93121
</small></address>
94122
</body>
95123
</html>

docs/doc.png

-746 Bytes
Binary file not shown.

docs/doc.svg

Lines changed: 12 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)