Skip to content

Commit 8b82160

Browse files
irishpatrickirishpatrick
committed
start on docs
1 parent b506bbe commit 8b82160

File tree

115 files changed

+12702
-0
lines changed

Some content is hidden

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

115 files changed

+12702
-0
lines changed

‎Doxyfile‎

Lines changed: 2579 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/html/CMakeLists_8txt.html‎

Lines changed: 123 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
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.17"/>
7+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8+
<title>pico-servo: CMakeLists.txt 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">pico-servo
25+
</div>
26+
</td>
27+
</tr>
28+
</tbody>
29+
</table>
30+
</div>
31+
<!-- end header part -->
32+
<!-- Generated by Doxygen 1.8.17 -->
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><!-- top -->
63+
<div class="header">
64+
<div class="summary">
65+
<a href="#func-members">Functions</a> </div>
66+
<div class="headertitle">
67+
<div class="title">CMakeLists.txt File Reference</div> </div>
68+
</div><!--header-->
69+
<div class="contents">
70+
<table class="memberdecls">
71+
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
72+
Functions</h2></td></tr>
73+
<tr class="memitem:a21ebab3d0b0bc5afa95693bc35ca868e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="CMakeLists_8txt.html#a21ebab3d0b0bc5afa95693bc35ca868e">cmake_minimum_required</a> (VERSION 3.12) include(pico_sdk_import.cmake) project(pico-servo) pico_sdk_init() add_library($</td></tr>
74+
<tr class="separator:a21ebab3d0b0bc5afa95693bc35ca868e"><td class="memSeparator" colspan="2">&#160;</td></tr>
75+
<tr class="memitem:a4fa2fa24b5890d9a99d390135b93431b"><td class="memItemLeft" align="right" valign="top">src pico_servo c&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="CMakeLists_8txt.html#a4fa2fa24b5890d9a99d390135b93431b">target_include_directories</a> (${PROJECT_NAME} PRIVATE include) target_link_libraries($</td></tr>
76+
<tr class="separator:a4fa2fa24b5890d9a99d390135b93431b"><td class="memSeparator" colspan="2">&#160;</td></tr>
77+
</table>
78+
<h2 class="groupheader">Function Documentation</h2>
79+
<a id="a21ebab3d0b0bc5afa95693bc35ca868e"></a>
80+
<h2 class="memtitle"><span class="permalink"><a href="#a21ebab3d0b0bc5afa95693bc35ca868e">&#9670;&nbsp;</a></span>cmake_minimum_required()</h2>
81+
82+
<div class="memitem">
83+
<div class="memproto">
84+
<table class="memname">
85+
<tr>
86+
<td class="memname">cmake_minimum_required </td>
87+
<td>(</td>
88+
<td class="paramtype">VERSION 3.&#160;</td>
89+
<td class="paramname"><em>12</em></td><td>)</td>
90+
<td></td>
91+
</tr>
92+
</table>
93+
</div><div class="memdoc">
94+
95+
</div>
96+
</div>
97+
<a id="a4fa2fa24b5890d9a99d390135b93431b"></a>
98+
<h2 class="memtitle"><span class="permalink"><a href="#a4fa2fa24b5890d9a99d390135b93431b">&#9670;&nbsp;</a></span>target_include_directories()</h2>
99+
100+
<div class="memitem">
101+
<div class="memproto">
102+
<table class="memname">
103+
<tr>
104+
<td class="memname">src pico_servo c target_include_directories </td>
105+
<td>(</td>
106+
<td class="paramtype">&#160;</td>
107+
<td class="paramname"><em>${PROJECT_NAME} PRIVATE</em></td><td>)</td>
108+
<td></td>
109+
</tr>
110+
</table>
111+
</div><div class="memdoc">
112+
113+
</div>
114+
</div>
115+
</div><!-- contents -->
116+
<!-- start footer part -->
117+
<hr class="footer"/><address class="footer"><small>
118+
Generated by &#160;<a href="http://www.doxygen.org/index.html">
119+
<img class="footer" src="doxygen.png" alt="doxygen"/>
120+
</a> 1.8.17
121+
</small></address>
122+
</body>
123+
</html>

‎docs/html/README_8md.html‎

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
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.17"/>
7+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8+
<title>pico-servo: README.md 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">pico-servo
25+
</div>
26+
</td>
27+
</tr>
28+
</tbody>
29+
</table>
30+
</div>
31+
<!-- end header part -->
32+
<!-- Generated by Doxygen 1.8.17 -->
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><!-- top -->
63+
<div class="header">
64+
<div class="headertitle">
65+
<div class="title">README.md File Reference</div> </div>
66+
</div><!--header-->
67+
<div class="contents">
68+
</div><!-- contents -->
69+
<!-- start footer part -->
70+
<hr class="footer"/><address class="footer"><small>
71+
Generated by &#160;<a href="http://www.doxygen.org/index.html">
72+
<img class="footer" src="doxygen.png" alt="doxygen"/>
73+
</a> 1.8.17
74+
</small></address>
75+
</body>
76+
</html>

‎docs/html/bc_s.png‎

676 Bytes
Loading

‎docs/html/bdwn.png‎

147 Bytes
Loading

‎docs/html/closed.png‎

132 Bytes
Loading

‎docs/html/dir_000001_000000.html‎

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
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.17"/>
7+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8+
<title>pico-servo: src -&gt; include Relation</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">pico-servo
25+
</div>
26+
</td>
27+
</tr>
28+
</tbody>
29+
</table>
30+
</div>
31+
<!-- end header part -->
32+
<!-- Generated by Doxygen 1.8.17 -->
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_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li> </ul>
65+
</div>
66+
</div><!-- top -->
67+
<div class="contents">
68+
<h3>src &rarr; include Relation</h3><table class="dirtab"><tr class="dirtab"><th class="dirtab">File in src</th><th class="dirtab">Includes file in include</th></tr><tr class="dirtab"><td class="dirtab"><a class="el" href="pico__servo_8c.html">pico_servo.c</a></td><td class="dirtab"><a class="el" href="pico__servo_8h.html">pico_servo.h</a></td></tr></table></div><!-- contents -->
69+
<!-- start footer part -->
70+
<hr class="footer"/><address class="footer"><small>
71+
Generated by &#160;<a href="http://www.doxygen.org/index.html">
72+
<img class="footer" src="doxygen.png" alt="doxygen"/>
73+
</a> 1.8.17
74+
</small></address>
75+
</body>
76+
</html>

‎docs/html/dir_68267d1309a1af8e8297ef4c3efbcdba.html‎

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
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.17"/>
7+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8+
<title>pico-servo: src Directory 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">pico-servo
25+
</div>
26+
</td>
27+
</tr>
28+
</tbody>
29+
</table>
30+
</div>
31+
<!-- end header part -->
32+
<!-- Generated by Doxygen 1.8.17 -->
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_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li> </ul>
65+
</div>
66+
</div><!-- top -->
67+
<div class="header">
68+
<div class="headertitle">
69+
<div class="title">src Directory Reference</div> </div>
70+
</div><!--header-->
71+
<div class="contents">
72+
<div class="dynheader">
73+
Directory dependency graph for src:</div>
74+
<div class="dyncontent">
75+
<div class="center"><img src="dir_68267d1309a1af8e8297ef4c3efbcdba_dep.png" border="0" usemap="#dir__68267d1309a1af8e8297ef4c3efbcdba__dep" alt="src"/></div>
76+
<!-- MAP 0 -->
77+
</div>
78+
<table class="memberdecls">
79+
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="files"></a>
80+
Files</h2></td></tr>
81+
<tr class="memitem:pico__servo_8c"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pico__servo_8c.html">pico_servo.c</a></td></tr>
82+
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
83+
</table>
84+
</div><!-- contents -->
85+
<!-- start footer part -->
86+
<hr class="footer"/><address class="footer"><small>
87+
Generated by &#160;<a href="http://www.doxygen.org/index.html">
88+
<img class="footer" src="doxygen.png" alt="doxygen"/>
89+
</a> 1.8.17
90+
</small></address>
91+
</body>
92+
</html>

‎docs/html/dir_68267d1309a1af8e8297ef4c3efbcdba_dep.dot‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
digraph "src" {
2+
compound=true
3+
node [ fontsize="10", fontname="Helvetica"];
4+
edge [ labelfontsize="10", labelfontname="Helvetica"];
5+
dir_68267d1309a1af8e8297ef4c3efbcdba [shape=box, label="src", style="filled", fillcolor="#eeeeff", pencolor="black", URL="dir_68267d1309a1af8e8297ef4c3efbcdba.html"];
6+
dir_d44c64559bbebec7f509842c48db8b23 [shape=box label="include" URL="dir_d44c64559bbebec7f509842c48db8b23.html"];
7+
dir_68267d1309a1af8e8297ef4c3efbcdba->dir_d44c64559bbebec7f509842c48db8b23 [headlabel="1", labeldistance=1.5 headhref="dir_000001_000000.html"];
8+
}

0 commit comments

Comments
 (0)