Add Doxygen API docs #314
The diff you're trying to view is too large. We only load the first 3000 changed files.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -76,6 +76,7 @@ The best way to interact with our team is through GitHub. You can [open an issue | |
| Please make sure to check out our resources too before opening an issue: | ||
|
|
||
jmklix marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| * Our [FAQ](FAQ.md) | ||
jmklix marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| * [API Docs](https://aws.github.io/aws-iot-device-sdk-cpp-v2/) | ||
jmklix marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| * Our [Developer Guide](https://docs.aws.amazon.com/iot/latest/developerguide/what-is-aws-iot.html) ([source](https://github.com/awsdocs/aws-iot-docs)) | ||
|
There was a problem hiding this comment. it would be great to get comments on the generated service code, like we have in python. But that requires touching the code generators, which is not trivial. But we should do it some day |
||
| * Check for similar [Issues](https://github.com/aws/aws-iot-device-sdk-cpp-v2/issues) | ||
| * [AWS IoT Core Documentation](https://docs.aws.amazon.com/iot/) | ||
jmklix marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,79 @@ | ||
| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> | ||
jmklix marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| <html xmlns="http://www.w3.org/1999/xhtml"> | ||
| <head> | ||
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> | ||
| <meta http-equiv="X-UA-Compatible" content="IE=11"/> | ||
| <meta name="generator" content="Doxygen 1.9.2"/> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1"/> | ||
| <title>AWS IoT Device SDK C++ v2: crt/aws-crt-cpp/crt/aws-c-common/verification/cbmc/litani/lib/__init__.py File Reference</title> | ||
| <link href="tabs.css" rel="stylesheet" type="text/css"/> | ||
| <script type="text/javascript" src="jquery.js"></script> | ||
| <script type="text/javascript" src="dynsections.js"></script> | ||
| <link href="search/search.css" rel="stylesheet" type="text/css"/> | ||
| <script type="text/javascript" src="search/searchdata.js"></script> | ||
| <script type="text/javascript" src="search/search.js"></script> | ||
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> | ||
| </head> | ||
| <body> | ||
| <div id="top"><!-- do not remove this div, it is closed by doxygen! --> | ||
| <div id="titlearea"> | ||
| <table cellspacing="0" cellpadding="0"> | ||
| <tbody> | ||
| <tr style="height: 56px;"> | ||
| <td id="projectalign" style="padding-left: 0.5em;"> | ||
| <div id="projectname">AWS IoT Device SDK C++ v2<span id="projectnumber"> 1.14.0</span> | ||
| </div> | ||
| <div id="projectbrief">AWS IoT Device SDK C++ v2</div> | ||
| </td> | ||
| </tr> | ||
| </tbody> | ||
| </table> | ||
| </div> | ||
| <!-- end header part --> | ||
| <!-- Generated by Doxygen 1.9.2 --> | ||
| <script type="text/javascript"> | ||
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ | ||
| var searchBox = new SearchBox("searchBox", "search",'Search','.html'); | ||
| /* @license-end */ | ||
| </script> | ||
| <script type="text/javascript" src="menudata.js"></script> | ||
| <script type="text/javascript" src="menu.js"></script> | ||
| <script type="text/javascript"> | ||
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ | ||
| $(function() { | ||
| initMenu('',true,false,'search.php','Search'); | ||
| $(document).ready(function() { init_search(); }); | ||
| }); | ||
| /* @license-end */ | ||
| </script> | ||
| <div id="main-nav"></div> | ||
| <!-- window showing the filter options --> | ||
| <div id="MSearchSelectWindow" | ||
| onmouseover="return searchBox.OnSearchSelectShow()" | ||
| onmouseout="return searchBox.OnSearchSelectHide()" | ||
| onkeydown="return searchBox.OnSearchSelectKey(event)"> | ||
| </div> | ||
|
|
||
| <!-- iframe showing the search results (closed by default) --> | ||
| <div id="MSearchResultsWindow"> | ||
| <iframe src="javascript:void(0)" frameborder="0" | ||
| name="MSearchResults" id="MSearchResults"> | ||
| </iframe> | ||
| </div> | ||
|
|
||
| <div id="nav-path" class="navpath"> | ||
| <ul> | ||
| <li class="navelem"><a class="el" href="dir_affb495f978f3575eca2eeb81eb7736b.html">crt</a></li><li class="navelem"><a class="el" href="dir_eb065311872385a3a1227a6ede2c108c.html">aws-crt-cpp</a></li><li class="navelem"><a class="el" href="dir_c68d83f7493c97e50c45ec06f21e3081.html">crt</a></li><li class="navelem"><a class="el" href="dir_fab3a90bc3065fb2d7dcf327c1e16d97.html">aws-c-common</a></li><li class="navelem"><a class="el" href="dir_c606023e394e67ada440211e2f8acca4.html">verification</a></li><li class="navelem"><a class="el" href="dir_1acb4cd0f3c55772b34625105e6c8d18.html">cbmc</a></li><li class="navelem"><a class="el" href="dir_ca4d48a85c7f6785431233cf6627c0ae.html">litani</a></li><li class="navelem"><a class="el" href="dir_91ddff65ed513634821dab33a7c57579.html">lib</a></li> </ul> | ||
| </div> | ||
| </div><!-- top --> | ||
| <div class="header"> | ||
| <div class="headertitle"><div class="title">__init__.py File Reference</div></div> | ||
| </div><!--header--> | ||
| <div class="contents"> | ||
| </div><!-- contents --> | ||
| <!-- start footer part --> | ||
| <hr class="footer"/><address class="footer"><small> | ||
| Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.2 | ||
| </small></address> | ||
| </body> | ||
| </html> | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,113 @@ | ||
| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> | ||
| <html xmlns="http://www.w3.org/1999/xhtml"> | ||
| <head> | ||
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> | ||
| <meta http-equiv="X-UA-Compatible" content="IE=11"/> | ||
| <meta name="generator" content="Doxygen 1.9.2"/> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1"/> | ||
| <title>AWS IoT Device SDK C++ v2: crt/aws-crt-cpp/source/Api.cpp File Reference</title> | ||
| <link href="tabs.css" rel="stylesheet" type="text/css"/> | ||
| <script type="text/javascript" src="jquery.js"></script> | ||
| <script type="text/javascript" src="dynsections.js"></script> | ||
| <link href="search/search.css" rel="stylesheet" type="text/css"/> | ||
| <script type="text/javascript" src="search/searchdata.js"></script> | ||
| <script type="text/javascript" src="search/search.js"></script> | ||
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> | ||
| </head> | ||
| <body> | ||
| <div id="top"><!-- do not remove this div, it is closed by doxygen! --> | ||
| <div id="titlearea"> | ||
| <table cellspacing="0" cellpadding="0"> | ||
| <tbody> | ||
| <tr style="height: 56px;"> | ||
| <td id="projectalign" style="padding-left: 0.5em;"> | ||
| <div id="projectname">AWS IoT Device SDK C++ v2<span id="projectnumber"> 1.14.0</span> | ||
| </div> | ||
| <div id="projectbrief">AWS IoT Device SDK C++ v2</div> | ||
| </td> | ||
| </tr> | ||
| </tbody> | ||
| </table> | ||
| </div> | ||
| <!-- end header part --> | ||
| <!-- Generated by Doxygen 1.9.2 --> | ||
| <script type="text/javascript"> | ||
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ | ||
| var searchBox = new SearchBox("searchBox", "search",'Search','.html'); | ||
| /* @license-end */ | ||
| </script> | ||
| <script type="text/javascript" src="menudata.js"></script> | ||
| <script type="text/javascript" src="menu.js"></script> | ||
| <script type="text/javascript"> | ||
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ | ||
| $(function() { | ||
| initMenu('',true,false,'search.php','Search'); | ||
| $(document).ready(function() { init_search(); }); | ||
| }); | ||
| /* @license-end */ | ||
| </script> | ||
| <div id="main-nav"></div> | ||
| <!-- window showing the filter options --> | ||
| <div id="MSearchSelectWindow" | ||
| onmouseover="return searchBox.OnSearchSelectShow()" | ||
| onmouseout="return searchBox.OnSearchSelectHide()" | ||
| onkeydown="return searchBox.OnSearchSelectKey(event)"> | ||
| </div> | ||
|
|
||
| <!-- iframe showing the search results (closed by default) --> | ||
| <div id="MSearchResultsWindow"> | ||
| <iframe src="javascript:void(0)" frameborder="0" | ||
| name="MSearchResults" id="MSearchResults"> | ||
| </iframe> | ||
| </div> | ||
|
|
||
| <div id="nav-path" class="navpath"> | ||
| <ul> | ||
| <li class="navelem"><a class="el" href="dir_affb495f978f3575eca2eeb81eb7736b.html">crt</a></li><li class="navelem"><a class="el" href="dir_eb065311872385a3a1227a6ede2c108c.html">aws-crt-cpp</a></li><li class="navelem"><a class="el" href="dir_21df4b5f3bc78585b5795fff97334c8c.html">source</a></li> </ul> | ||
| </div> | ||
| </div><!-- top --> | ||
| <div class="header"> | ||
| <div class="summary"> | ||
| <a href="#namespaces">Namespaces</a> | | ||
| <a href="#func-members">Functions</a> </div> | ||
| <div class="headertitle"><div class="title">Api.cpp File Reference</div></div> | ||
| </div><!--header--> | ||
| <div class="contents"> | ||
| <div class="textblock"><code>#include <<a class="el" href="_api_8h_source.html">aws/crt/Api.h</a>></code><br /> | ||
| <code>#include <<a class="el" href="_stl_allocator_8h_source.html">aws/crt/StlAllocator.h</a>></code><br /> | ||
| <code>#include <<a class="el" href="aws-crt-cpp_2include_2aws_2crt_2external_2c_j_s_o_n_8h_source.html">aws/crt/external/cJSON.h</a>></code><br /> | ||
| <code>#include <<a class="el" href="_tls_options_8h_source.html">aws/crt/io/TlsOptions.h</a>></code><br /> | ||
| <code>#include <<a class="el" href="auth_8h_source.html">aws/auth/auth.h</a>></code><br /> | ||
| <code>#include <<a class="el" href="ref__count_8h_source.html">aws/common/ref_count.h</a>></code><br /> | ||
| <code>#include <<a class="el" href="http_8h_source.html">aws/http/http.h</a>></code><br /> | ||
| <code>#include <<a class="el" href="mqtt_8h_source.html">aws/mqtt/mqtt.h</a>></code><br /> | ||
| </div><table class="memberdecls"> | ||
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="namespaces" name="namespaces"></a> | ||
| Namespaces</h2></td></tr> | ||
| <tr class="memitem:namespace_aws"><td class="memItemLeft" align="right" valign="top">namespace  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_aws.html">Aws</a></td></tr> | ||
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> | ||
| <tr class="memitem:namespace_aws_1_1_crt"><td class="memItemLeft" align="right" valign="top">namespace  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_aws_1_1_crt.html">Aws::Crt</a></td></tr> | ||
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> | ||
| </table><table class="memberdecls"> | ||
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a> | ||
| Functions</h2></td></tr> | ||
| <tr class="memitem:a070ad73c54333c051188bf6e0dd6ac6c"><td class="memItemLeft" align="right" valign="top">static void * </td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_aws_1_1_crt.html#a070ad73c54333c051188bf6e0dd6ac6c">Aws::Crt::s_cJSONAlloc</a> (size_t sz)</td></tr> | ||
| <tr class="separator:a070ad73c54333c051188bf6e0dd6ac6c"><td class="memSeparator" colspan="2"> </td></tr> | ||
| <tr class="memitem:a27de811f7c8f5a54fd7255da88cc8acb"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_aws_1_1_crt.html#a27de811f7c8f5a54fd7255da88cc8acb">Aws::Crt::s_cJSONFree</a> (void *ptr)</td></tr> | ||
| <tr class="separator:a27de811f7c8f5a54fd7255da88cc8acb"><td class="memSeparator" colspan="2"> </td></tr> | ||
| <tr class="memitem:a1a323010caf6386d86f1377ff1133e60"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_aws_1_1_crt.html#a1a323010caf6386d86f1377ff1133e60">Aws::Crt::s_initApi</a> (Allocator *allocator)</td></tr> | ||
| <tr class="separator:a1a323010caf6386d86f1377ff1133e60"><td class="memSeparator" colspan="2"> </td></tr> | ||
| <tr class="memitem:a381b8c42c48a6a9408017d273d660dda"><td class="memItemLeft" align="right" valign="top"><a class="el" href="crt_2aws-crt-cpp_2include_2aws_2crt_2_exports_8h.html#a0a3f6c46aee6b588ce99a142cdb22d1d">AWS_CRT_CPP_API</a> const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_aws_1_1_crt.html#a381b8c42c48a6a9408017d273d660dda">Aws::Crt::ErrorDebugString</a> (int <a class="el" href="structerror.html">error</a>) noexcept</td></tr> | ||
| <tr class="separator:a381b8c42c48a6a9408017d273d660dda"><td class="memSeparator" colspan="2"> </td></tr> | ||
| <tr class="memitem:aec41cfe367315d4e4e1712f19e3d3061"><td class="memItemLeft" align="right" valign="top"><a class="el" href="crt_2aws-crt-cpp_2include_2aws_2crt_2_exports_8h.html#a0a3f6c46aee6b588ce99a142cdb22d1d">AWS_CRT_CPP_API</a> int </td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_aws_1_1_crt.html#aec41cfe367315d4e4e1712f19e3d3061">Aws::Crt::LastError</a> () noexcept</td></tr> | ||
| <tr class="separator:aec41cfe367315d4e4e1712f19e3d3061"><td class="memSeparator" colspan="2"> </td></tr> | ||
| <tr class="memitem:a09743b0ee6cb7e924ce2107ec8f81de6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="crt_2aws-crt-cpp_2include_2aws_2crt_2_exports_8h.html#a0a3f6c46aee6b588ce99a142cdb22d1d">AWS_CRT_CPP_API</a> int </td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_aws_1_1_crt.html#a09743b0ee6cb7e924ce2107ec8f81de6">Aws::Crt::LastErrorOrUnknown</a> () noexcept</td></tr> | ||
| <tr class="separator:a09743b0ee6cb7e924ce2107ec8f81de6"><td class="memSeparator" colspan="2"> </td></tr> | ||
| </table> | ||
| </div><!-- contents --> | ||
| <!-- start footer part --> | ||
| <hr class="footer"/><address class="footer"><small> | ||
| Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.2 | ||
| </small></address> | ||
| </body> | ||
| </html> |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.