Skip to content

Commit 01cb75e

Browse files
TingDaoKTingDaoK
authored
Docs(phase 1) (aws#114)
- Generated document based on the comments we had via Doxygen - Comments updated at crt.IO for the document.
1 parent f066bc2 commit 01cb75e

File tree

724 files changed

+77487
-68
lines changed

Some content is hidden

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

724 files changed

+77487
-68
lines changed

‎docs/Api_8cpp.html

Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
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">
3+
<head>
4+
<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.18"/>
7+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8+
<title>aws-crt-cpp: /home/ANT.AMAZON.COM/dengket/doc/aws-crt-cpp/source/Api.cpp File Reference</title>
9+
<link href="tabs.css" rel="stylesheet" type="text/css"/>
10+
<script type="text/javascript" src="jquery.js"></script>
11+
<script type="text/javascript" src="dynsections.js"></script>
12+
<link href="search/search.css" rel="stylesheet" type="text/css"/>
13+
<script type="text/javascript" src="search/searchdata.js"></script>
14+
<script type="text/javascript" src="search/search.js"></script>
15+
<link href="doxygen.css" rel="stylesheet" type="text/css" />
16+
</head>
17+
<body>
18+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
19+
<div id="titlearea">
20+
<table cellspacing="0" cellpadding="0">
21+
<tbody>
22+
<tr style="height: 56px;">
23+
<td id="projectalign" style="padding-left: 0.5em;">
24+
<div id="projectname">aws-crt-cpp
25+
</div>
26+
</td>
27+
</tr>
28+
</tbody>
29+
</table>
30+
</div>
31+
<!-- end header part -->
32+
<!-- Generated by Doxygen 1.8.18 -->
33+
<script type="text/javascript">
34+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
35+
var searchBox = new SearchBox("searchBox", "search",false,'Search');
36+
/* @license-end */
37+
</script>
38+
<script type="text/javascript" src="menudata.js"></script>
39+
<script type="text/javascript" src="menu.js"></script>
40+
<script type="text/javascript">
41+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
42+
$(function() {
43+
initMenu('',true,false,'search.php','Search');
44+
$(document).ready(function() { init_search(); });
45+
});
46+
/* @license-end */</script>
47+
<div id="main-nav"></div>
48+
<!-- window showing the filter options -->
49+
<div id="MSearchSelectWindow"
50+
onmouseover="return searchBox.OnSearchSelectShow()"
51+
onmouseout="return searchBox.OnSearchSelectHide()"
52+
onkeydown="return searchBox.OnSearchSelectKey(event)">
53+
</div>
54+
55+
<!-- iframe showing the search results (closed by default) -->
56+
<div id="MSearchResultsWindow">
57+
<iframe src="javascript:void(0)" frameborder="0"
58+
name="MSearchResults" id="MSearchResults">
59+
</iframe>
60+
</div>
61+
62+
<div id="nav-path" class="navpath">
63+
<ul>
64+
<li class="navelem"><a class="el" href="dir_b2f33c71d4aa5e7af42a1ca61ff5af1b.html">source</a></li> </ul>
65+
</div>
66+
</div><!-- top -->
67+
<div class="header">
68+
<div class="summary">
69+
<a href="#namespaces">Namespaces</a> &#124;
70+
<a href="#func-members">Functions</a> </div>
71+
<div class="headertitle">
72+
<div class="title">Api.cpp File Reference</div> </div>
73+
</div><!--header-->
74+
<div class="contents">
75+
<div class="textblock"><code>#include &lt;<a class="el" href="Api_8h_source.html">aws/crt/Api.h</a>&gt;</code><br />
76+
<code>#include &lt;<a class="el" href="StlAllocator_8h_source.html">aws/crt/StlAllocator.h</a>&gt;</code><br />
77+
<code>#include &lt;<a class="el" href="cJSON_8h_source.html">aws/crt/external/cJSON.h</a>&gt;</code><br />
78+
<code>#include &lt;<a class="el" href="TlsOptions_8h_source.html">aws/crt/io/TlsOptions.h</a>&gt;</code><br />
79+
<code>#include &lt;aws/auth/auth.h&gt;</code><br />
80+
<code>#include &lt;aws/http/http.h&gt;</code><br />
81+
<code>#include &lt;aws/mqtt/mqtt.h&gt;</code><br />
82+
</div><table class="memberdecls">
83+
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
84+
Namespaces</h2></td></tr>
85+
<tr class="memitem:namespaceAws"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceAws.html">Aws</a></td></tr>
86+
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
87+
<tr class="memitem:namespaceAws_1_1Crt"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceAws_1_1Crt.html">Aws::Crt</a></td></tr>
88+
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
89+
</table><table class="memberdecls">
90+
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
91+
Functions</h2></td></tr>
92+
<tr class="memitem:a381b8c42c48a6a9408017d273d660dda"><td class="memItemLeft" align="right" valign="top"><a class="el" href="Exports_8h.html#a0a3f6c46aee6b588ce99a142cdb22d1d">AWS_CRT_CPP_API</a> const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceAws_1_1Crt.html#a381b8c42c48a6a9408017d273d660dda">Aws::Crt::ErrorDebugString</a> (int <a class="el" href="structerror.html">error</a>) noexcept</td></tr>
93+
<tr class="separator:a381b8c42c48a6a9408017d273d660dda"><td class="memSeparator" colspan="2">&#160;</td></tr>
94+
<tr class="memitem:aec41cfe367315d4e4e1712f19e3d3061"><td class="memItemLeft" align="right" valign="top"><a class="el" href="Exports_8h.html#a0a3f6c46aee6b588ce99a142cdb22d1d">AWS_CRT_CPP_API</a> int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceAws_1_1Crt.html#aec41cfe367315d4e4e1712f19e3d3061">Aws::Crt::LastError</a> () noexcept</td></tr>
95+
<tr class="separator:aec41cfe367315d4e4e1712f19e3d3061"><td class="memSeparator" colspan="2">&#160;</td></tr>
96+
<tr class="memitem:a09743b0ee6cb7e924ce2107ec8f81de6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="Exports_8h.html#a0a3f6c46aee6b588ce99a142cdb22d1d">AWS_CRT_CPP_API</a> int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceAws_1_1Crt.html#a09743b0ee6cb7e924ce2107ec8f81de6">Aws::Crt::LastErrorOrUnknown</a> () noexcept</td></tr>
97+
<tr class="separator:a09743b0ee6cb7e924ce2107ec8f81de6"><td class="memSeparator" colspan="2">&#160;</td></tr>
98+
</table>
99+
</div><!-- contents -->
100+
<!-- start footer part -->
101+
<hr class="footer"/><address class="footer"><small>
102+
Generated by &#160;<a href="http://www.doxygen.org/index.html">
103+
<img class="footer" src="doxygen.png" alt="doxygen"/>
104+
</a> 1.8.18
105+
</small></address>
106+
</body>
107+
</html>

‎docs/Api_8h.html

Lines changed: 131 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,131 @@
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">
3+
<head>
4+
<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.18"/>
7+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8+
<title>aws-crt-cpp: /home/ANT.AMAZON.COM/dengket/doc/aws-crt-cpp/include/aws/crt/Api.h File Reference</title>
9+
<link href="tabs.css" rel="stylesheet" type="text/css"/>
10+
<script type="text/javascript" src="jquery.js"></script>
11+
<script type="text/javascript" src="dynsections.js"></script>
12+
<link href="search/search.css" rel="stylesheet" type="text/css"/>
13+
<script type="text/javascript" src="search/searchdata.js"></script>
14+
<script type="text/javascript" src="search/search.js"></script>
15+
<link href="doxygen.css" rel="stylesheet" type="text/css" />
16+
</head>
17+
<body>
18+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
19+
<div id="titlearea">
20+
<table cellspacing="0" cellpadding="0">
21+
<tbody>
22+
<tr style="height: 56px;">
23+
<td id="projectalign" style="padding-left: 0.5em;">
24+
<div id="projectname">aws-crt-cpp
25+
</div>
26+
</td>
27+
</tr>
28+
</tbody>
29+
</table>
30+
</div>
31+
<!-- end header part -->
32+
<!-- Generated by Doxygen 1.8.18 -->
33+
<script type="text/javascript">
34+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
35+
var searchBox = new SearchBox("searchBox", "search",false,'Search');
36+
/* @license-end */
37+
</script>
38+
<script type="text/javascript" src="menudata.js"></script>
39+
<script type="text/javascript" src="menu.js"></script>
40+
<script type="text/javascript">
41+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
42+
$(function() {
43+
initMenu('',true,false,'search.php','Search');
44+
$(document).ready(function() { init_search(); });
45+
});
46+
/* @license-end */</script>
47+
<div id="main-nav"></div>
48+
<!-- window showing the filter options -->
49+
<div id="MSearchSelectWindow"
50+
onmouseover="return searchBox.OnSearchSelectShow()"
51+
onmouseout="return searchBox.OnSearchSelectHide()"
52+
onkeydown="return searchBox.OnSearchSelectKey(event)">
53+
</div>
54+
55+
<!-- iframe showing the search results (closed by default) -->
56+
<div id="MSearchResultsWindow">
57+
<iframe src="javascript:void(0)" frameborder="0"
58+
name="MSearchResults" id="MSearchResults">
59+
</iframe>
60+
</div>
61+
62+
<div id="nav-path" class="navpath">
63+
<ul>
64+
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_076842b242c291358044feb169933571.html">aws</a></li><li class="navelem"><a class="el" href="dir_cc4322e4b2151c90adb7cd2e3f54423a.html">crt</a></li> </ul>
65+
</div>
66+
</div><!-- top -->
67+
<div class="header">
68+
<div class="summary">
69+
<a href="#nested-classes">Classes</a> &#124;
70+
<a href="#namespaces">Namespaces</a> &#124;
71+
<a href="#enum-members">Enumerations</a> &#124;
72+
<a href="#func-members">Functions</a> </div>
73+
<div class="headertitle">
74+
<div class="title">Api.h File Reference</div> </div>
75+
</div><!--header-->
76+
<div class="contents">
77+
<div class="textblock"><code>#include &lt;<a class="el" href="Types_8h_source.html">aws/crt/Types.h</a>&gt;</code><br />
78+
<code>#include &lt;<a class="el" href="Bootstrap_8h_source.html">aws/crt/io/Bootstrap.h</a>&gt;</code><br />
79+
<code>#include &lt;<a class="el" href="EventLoopGroup_8h_source.html">aws/crt/io/EventLoopGroup.h</a>&gt;</code><br />
80+
<code>#include &lt;<a class="el" href="TlsOptions_8h_source.html">aws/crt/io/TlsOptions.h</a>&gt;</code><br />
81+
<code>#include &lt;<a class="el" href="crt_2mqtt_2MqttClient_8h_source.html">aws/crt/mqtt/MqttClient.h</a>&gt;</code><br />
82+
<code>#include &lt;aws/common/logging.h&gt;</code><br />
83+
</div>
84+
<p><a href="Api_8h_source.html">Go to the source code of this file.</a></p>
85+
<table class="memberdecls">
86+
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
87+
Classes</h2></td></tr>
88+
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAws_1_1Crt_1_1ApiHandle.html">Aws::Crt::ApiHandle</a></td></tr>
89+
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
90+
</table><table class="memberdecls">
91+
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
92+
Namespaces</h2></td></tr>
93+
<tr class="memitem:namespaceAws"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceAws.html">Aws</a></td></tr>
94+
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
95+
<tr class="memitem:namespaceAws_1_1Crt"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceAws_1_1Crt.html">Aws::Crt</a></td></tr>
96+
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
97+
</table><table class="memberdecls">
98+
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
99+
Enumerations</h2></td></tr>
100+
<tr class="memitem:a38935c4922a7101640006354d741ffeb"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceAws_1_1Crt.html#a38935c4922a7101640006354d741ffeb">Aws::Crt::LogLevel</a> { <br />
101+
&#160;&#160;<a class="el" href="namespaceAws_1_1Crt.html#a38935c4922a7101640006354d741ffeba6adf97f83acf6453d4a6a4b1070f3754">Aws::Crt::LogLevel::None</a> = AWS_LL_NONE,
102+
<a class="el" href="namespaceAws_1_1Crt.html#a38935c4922a7101640006354d741ffeba882384ec38ce8d9582b57e70861730e4">Aws::Crt::LogLevel::Fatal</a> = AWS_LL_FATAL,
103+
<a class="el" href="namespaceAws_1_1Crt.html#a38935c4922a7101640006354d741ffeba902b0d55fddef6f8d651fe1035b7d4bd">Aws::Crt::LogLevel::Error</a> = AWS_LL_ERROR,
104+
<a class="el" href="namespaceAws_1_1Crt.html#a38935c4922a7101640006354d741ffeba56525ae64d370c0b448ac0d60710ef17">Aws::Crt::LogLevel::Warn</a> = AWS_LL_WARN,
105+
<br />
106+
&#160;&#160;<a class="el" href="namespaceAws_1_1Crt.html#a38935c4922a7101640006354d741ffeba4059b0251f66a18cb56f544728796875">Aws::Crt::LogLevel::Info</a> = AWS_LL_INFO,
107+
<a class="el" href="namespaceAws_1_1Crt.html#a38935c4922a7101640006354d741ffebaa603905470e2a5b8c13e96b579ef0dba">Aws::Crt::LogLevel::Debug</a> = AWS_LL_DEBUG,
108+
<a class="el" href="namespaceAws_1_1Crt.html#a38935c4922a7101640006354d741ffebadd4ec0ac4e58f7c32a01244ae91150b1">Aws::Crt::LogLevel::Trace</a> = AWS_LL_TRACE,
109+
<a class="el" href="namespaceAws_1_1Crt.html#a38935c4922a7101640006354d741ffebae93f994f01c537c4e2f7d8528c3eb5e9">Aws::Crt::LogLevel::Count</a>
110+
<br />
111+
}</td></tr>
112+
<tr class="separator:a38935c4922a7101640006354d741ffeb"><td class="memSeparator" colspan="2">&#160;</td></tr>
113+
</table><table class="memberdecls">
114+
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
115+
Functions</h2></td></tr>
116+
<tr class="memitem:a381b8c42c48a6a9408017d273d660dda"><td class="memItemLeft" align="right" valign="top"><a class="el" href="Exports_8h.html#a0a3f6c46aee6b588ce99a142cdb22d1d">AWS_CRT_CPP_API</a> const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceAws_1_1Crt.html#a381b8c42c48a6a9408017d273d660dda">Aws::Crt::ErrorDebugString</a> (int <a class="el" href="structerror.html">error</a>) noexcept</td></tr>
117+
<tr class="separator:a381b8c42c48a6a9408017d273d660dda"><td class="memSeparator" colspan="2">&#160;</td></tr>
118+
<tr class="memitem:aec41cfe367315d4e4e1712f19e3d3061"><td class="memItemLeft" align="right" valign="top"><a class="el" href="Exports_8h.html#a0a3f6c46aee6b588ce99a142cdb22d1d">AWS_CRT_CPP_API</a> int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceAws_1_1Crt.html#aec41cfe367315d4e4e1712f19e3d3061">Aws::Crt::LastError</a> () noexcept</td></tr>
119+
<tr class="separator:aec41cfe367315d4e4e1712f19e3d3061"><td class="memSeparator" colspan="2">&#160;</td></tr>
120+
<tr class="memitem:a09743b0ee6cb7e924ce2107ec8f81de6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="Exports_8h.html#a0a3f6c46aee6b588ce99a142cdb22d1d">AWS_CRT_CPP_API</a> int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceAws_1_1Crt.html#a09743b0ee6cb7e924ce2107ec8f81de6">Aws::Crt::LastErrorOrUnknown</a> () noexcept</td></tr>
121+
<tr class="separator:a09743b0ee6cb7e924ce2107ec8f81de6"><td class="memSeparator" colspan="2">&#160;</td></tr>
122+
</table>
123+
</div><!-- contents -->
124+
<!-- start footer part -->
125+
<hr class="footer"/><address class="footer"><small>
126+
Generated by &#160;<a href="http://www.doxygen.org/index.html">
127+
<img class="footer" src="doxygen.png" alt="doxygen"/>
128+
</a> 1.8.18
129+
</small></address>
130+
</body>
131+
</html>

0 commit comments

Comments
 (0)