Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation #4

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
.vscode/
build/
19 changes: 19 additions & 0 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
cmake_minimum_required(VERSION 3.0)

include(ExternalProject)

ExternalProject_Add(
unit_tests
PREFIX ${CMAKE_SOURCE_DIR}/tests
SOURCE_DIR ${CMAKE_SOURCE_DIR}/tests
BINARY_DIR ${CMAKE_SOURCE_DIR}/tests/build
STAMP_DIR ${CMAKE_SOURCE_DIR}/tests/build
TMP_DIR ${CMAKE_SOURCE_DIR}/tests/build
DOWNLOAD_COMMAND ""
PATCH_COMMAND ""
INSTALL_COMMAND ""
UPDATE_COMMAND ""
CONFIGURE_COMMAND ${CMAKE_COMMAND} -DCMAKE_EXPORT_COMPILE_COMMANDS:BOOL=TRUE -S ${CMAKE_SOURCE_DIR}/tests -G ${CMAKE_GENERATOR}
BUILD_ALWAYS TRUE
ALWAYS TRUE
)
2,661 changes: 2,661 additions & 0 deletions doc/Doxyfile

Large diffs are not rendered by default.

226 changes: 226 additions & 0 deletions doc/html/_parser_8hpp_source.html

Large diffs are not rendered by default.

108 changes: 108 additions & 0 deletions doc/html/annotated.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@
<!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=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>&#x202A;Universal AT Parser: &#x202A;Class List</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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.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">&#x202A;Universal AT Parser
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('annotated.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- 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 class="header">
<div class="headertitle">
<div class="title">Class List</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock">Here are the classes, structs, unions and interfaces with brief descriptions:</div><div class="directory">
<div class="levels">[detail level <span onclick="javascript:toggleLevel(1);">1</span><span onclick="javascript:toggleLevel(2);">2</span>]</div><table class="directory">
<tr id="row_0_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classfunction.html" target="_self">&#x202A;function</a></td><td class="desc">&#x202A;Stub class </td></tr>
<tr id="row_1_"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_1_" class="arrow" onclick="toggleFolder('1_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classfunction_3_01_return_07_args_01_8_8_8_08_4.html" target="_self">&#x202A;function&lt; Return(Args ...)&gt;</a></td><td class="desc">&#x202A;A class for storing a pointer to a callable object </td></tr>
<tr id="row_1_0_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structfunction_3_01_return_07_args_01_8_8_8_08_4_1_1function__base.html" target="_self">&#x202A;function_base</a></td><td class="desc">&#x202A;Helper abstract class </td></tr>
<tr id="row_1_1_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structfunction_3_01_return_07_args_01_8_8_8_08_4_1_1function__holder.html" target="_self">&#x202A;function_holder</a></td><td class="desc">&#x202A;A class that stores directly a pointer to a callable object </td></tr>
<tr id="row_2_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_2_" class="arrow" onclick="toggleFolder('2_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_parser.html" target="_self">&#x202A;Parser</a></td><td class="desc">&#x202A;Universal parser of AT commands </td></tr>
<tr id="row_2_0_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_parser_1_1_a_t__base.html" target="_self">&#x202A;AT_base</a></td><td class="desc">&#x202A;Helper abstract class </td></tr>
<tr id="row_2_1_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_parser_1_1_a_t___command.html" target="_self">&#x202A;AT_Command</a></td><td class="desc">&#x202A;Command class </td></tr>
</table>
</div><!-- directory -->
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">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.1 </li>
</ul>
</div>
</body>
</html>
6 changes: 6 additions & 0 deletions doc/html/annotated_dup.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
var annotated_dup =
[
[ "\u202Afunction", "classfunction.html", null ],
[ "\u202Afunction< Return(Args ...)>", "classfunction_3_01_return_07_args_01_8_8_8_08_4.html", "classfunction_3_01_return_07_args_01_8_8_8_08_4" ],
[ "\u202AParser", "class_parser.html", "class_parser" ]
];
Binary file added doc/html/bc_s.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/html/bdwn.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
121 changes: 121 additions & 0 deletions doc/html/class_parser-members.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
<!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=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>&#x202A;Universal AT Parser: &#x202A;Member List</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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.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">&#x202A;Universal AT Parser
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('class_parser.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- 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 class="header">
<div class="headertitle">
<div class="title">Parser&lt; ATsize &gt; Member List</div> </div>
</div><!--header-->
<div class="contents">

<p>This is the complete list of members for <a class="el" href="class_parser.html">Parser&lt; ATsize &gt;</a>, including all inherited members.</p>
<table class="directory">
<tr class="even"><td class="entry"><a class="el" href="class_parser.html#ae331aa0cd12c9c4862d68366fcc15d0b">arrAT</a></td><td class="entry"><a class="el" href="class_parser.html">Parser&lt; ATsize &gt;</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
<tr><td class="entry"><a class="el" href="class_parser.html#aa5d69f2c9b02b11d395677b2962fb372">command_list_t</a> typedef</td><td class="entry"><a class="el" href="class_parser.html">Parser&lt; ATsize &gt;</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_parser.html#a37f0dc0c23bacba672d8a42eedb68733">command_t</a> typedef</td><td class="entry"><a class="el" href="class_parser.html">Parser&lt; ATsize &gt;</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
<tr><td class="entry"><a class="el" href="class_parser.html#a7c129c3ff40e5e56297e477ed0bddaa9">convert</a>(const string_t &amp;val, int *specifier) const</td><td class="entry"><a class="el" href="class_parser.html">Parser&lt; ATsize &gt;</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_parser.html#ac1718480f66f6833bc1be4267634507a">convert</a>(const string_t &amp;val, string_t *specifier) const</td><td class="entry"><a class="el" href="class_parser.html">Parser&lt; ATsize &gt;</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
<tr><td class="entry"><a class="el" href="class_parser.html#ab278081adb7c0b81d2e53865836ca990">convert</a>(const string_t &amp;val, const char **specifier) const</td><td class="entry"><a class="el" href="class_parser.html">Parser&lt; ATsize &gt;</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_parser.html#a11966e5af3aa6c38e17751b4973b449c">CPPUTEST</a></td><td class="entry"><a class="el" href="class_parser.html">Parser&lt; ATsize &gt;</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
<tr><td class="entry"><a class="el" href="class_parser.html#a23d21d7fb5d9f692284b4fc5a35a91fd">findAT</a>(const char *const pStr) const</td><td class="entry"><a class="el" href="class_parser.html">Parser&lt; ATsize &gt;</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_parser.html#a6a7817f47d4e8cd2baa842c488dfc542">format_t</a> typedef</td><td class="entry"><a class="el" href="class_parser.html">Parser&lt; ATsize &gt;</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
<tr><td class="entry"><a class="el" href="class_parser.html#aa111315075f22cb09e065b7a6426511b">param_list_t</a> typedef</td><td class="entry"><a class="el" href="class_parser.html">Parser&lt; ATsize &gt;</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_parser.html#a4c36a60593462528bdcc43360b554761">Parse</a>(const char *str)</td><td class="entry"><a class="el" href="class_parser.html">Parser&lt; ATsize &gt;</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_parser.html#a37d1744739cfe0a21b0fa21e415aab18">Parser</a>(const char *prefix, const printf_t &amp;write)</td><td class="entry"><a class="el" href="class_parser.html">Parser&lt; ATsize &gt;</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_parser.html#a0b894c199c4de0894ad37b5a4231ad95">prefix</a></td><td class="entry"><a class="el" href="class_parser.html">Parser&lt; ATsize &gt;</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
<tr><td class="entry"><a class="el" href="class_parser.html#aba4a513e6b12371c67e5a85c53c71969">prefix_t</a> typedef</td><td class="entry"><a class="el" href="class_parser.html">Parser&lt; ATsize &gt;</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_parser.html#aa16297270bbe395521fcc820936d1079">print</a>(const First &amp;first, const Second &amp;sec, const Args &amp;... args) const</td><td class="entry"><a class="el" href="class_parser.html">Parser&lt; ATsize &gt;</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
<tr><td class="entry"><a class="el" href="class_parser.html#ab7fcd43b3bbf036990c1f5a2793e3418">print</a>(const T &amp;param) const</td><td class="entry"><a class="el" href="class_parser.html">Parser&lt; ATsize &gt;</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_parser.html#af9f61e63d45760826c5c30542651a407">print</a>(const char *pStr) const</td><td class="entry"><a class="el" href="class_parser.html">Parser&lt; ATsize &gt;</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
<tr><td class="entry"><a class="el" href="class_parser.html#a182e26dea42b08a53b52995fafc93f74">print</a>(const string_t &amp;rStr) const</td><td class="entry"><a class="el" href="class_parser.html">Parser&lt; ATsize &gt;</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_parser.html#a19f9252fa3cf0cf12b48d6a16d7cca6b">printf_t</a> typedef</td><td class="entry"><a class="el" href="class_parser.html">Parser&lt; ATsize &gt;</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr><td class="entry"><a class="el" href="class_parser.html#a2fba4d3cf5046c04eb89e23590b99f2e">string_t</a> typedef</td><td class="entry"><a class="el" href="class_parser.html">Parser&lt; ATsize &gt;</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_parser.html#aad9f12c6814e3e74c352f3b176eff3e4">Write</a></td><td class="entry"><a class="el" href="class_parser.html">Parser&lt; ATsize &gt;</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
</table></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">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.1 </li>
</ul>
</div>
</body>
</html>
Loading