Skip to content

Commit

Permalink
remade docs
Browse files Browse the repository at this point in the history
  • Loading branch information
klavins committed Mar 11, 2019
1 parent 3e225de commit 83b53cb
Show file tree
Hide file tree
Showing 90 changed files with 472 additions and 347 deletions.
22 changes: 14 additions & 8 deletions docs/README_8md_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -178,19 +178,25 @@
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; cd elma</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; make</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160;</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160;Usage</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160;===</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160;See the examples in the `examples` directory for how to build new event loops with Elma.</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160;Note that the Makefile should detect if you are on a pi by using the command</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160;</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; uname -m</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160;</div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160;License</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160;===</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160;</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160;This software is open source and uses the MIT license. Details can be found [here](https://github.com/klavinslab/elma).</div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160;which on a pi 3 model B+ returns &#39;armv71&#39;. If your pi is different, you might need to change the ifeq statments in `test/Makefile` and `examples/Makefile`.</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160;</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160;Usage</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160;===</div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160;See the examples in the `examples` directory for how to build new event loops with Elma.</div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160;</div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160;License</div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160;===</div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160;</div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160;This software is open source and uses the MIT license. Details can be found [here](https://github.com/klavinslab/elma).</div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Developed by <a href="http://klavinslab.org">Eric Klavins</a> for UW ECE P 520<br>
Generated on Sun Mar 10 2019 16:17:05 for Elma by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Mon Mar 11 2019 00:40:18 for Elma by &#160;<a href="http://www.doxygen.org/index.html">
Doxygen
</a> 1.8.8
</small></address>
Expand Down
2 changes: 1 addition & 1 deletion docs/annotated.html
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Developed by <a href="http://klavinslab.org">Eric Klavins</a> for UW ECE P 520<br>
Generated on Sun Mar 10 2019 16:17:07 for Elma by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Mon Mar 11 2019 00:40:19 for Elma by &#160;<a href="http://www.doxygen.org/index.html">
Doxygen
</a> 1.8.8
</small></address>
Expand Down
2 changes: 1 addition & 1 deletion docs/basic_8cc.html
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Developed by <a href="http://klavinslab.org">Eric Klavins</a> for UW ECE P 520<br>
Generated on Sun Mar 10 2019 16:17:06 for Elma by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Mon Mar 11 2019 00:40:18 for Elma by &#160;<a href="http://www.doxygen.org/index.html">
Doxygen
</a> 1.8.8
</small></address>
Expand Down
6 changes: 3 additions & 3 deletions docs/basic_8cc_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -133,12 +133,12 @@
<div class="ttc" id="classelma_1_1Manager_html"><div class="ttname"><a href="classelma_1_1Manager.html">elma::Manager</a></div><div class="ttdoc">The Process Manager class. </div><div class="ttdef"><b>Definition:</b> <a href="manager_8h_source.html#l00026">manager.h:26</a></div></div>
<div class="ttc" id="classelma_1_1Manager_html_aff7ec0e7409420c8d92a59443066738c"><div class="ttname"><a href="classelma_1_1Manager.html#aff7ec0e7409420c8d92a59443066738c">elma::Manager::schedule</a></div><div class="ttdeci">Manager &amp; schedule(Process &amp;process, high_resolution_clock::duration period)</div><div class="ttdef"><b>Definition:</b> <a href="manager_8cc_source.html#l00011">manager.cc:11</a></div></div>
<div class="ttc" id="classbasic__example_1_1BasicProcess_html_a5138630dba00f218acb13f31f7d4532f"><div class="ttname"><a href="classbasic__example_1_1BasicProcess.html#a5138630dba00f218acb13f31f7d4532f">basic_example::BasicProcess::init</a></div><div class="ttdeci">void init()</div><div class="ttdoc">Nothing to do to initialize. </div><div class="ttdef"><b>Definition:</b> <a href="basic_8cc_source.html#l00024">basic.cc:24</a></div></div>
<div class="ttc" id="classelma_1_1Manager_html_ad5df7316416ac9697d62e68e21f04758"><div class="ttname"><a href="classelma_1_1Manager.html#ad5df7316416ac9697d62e68e21f04758">elma::Manager::run</a></div><div class="ttdeci">Manager &amp; run(high_resolution_clock::duration)</div><div class="ttdef"><b>Definition:</b> <a href="manager_8cc_source.html#l00122">manager.cc:122</a></div></div>
<div class="ttc" id="classelma_1_1Manager_html_ad5df7316416ac9697d62e68e21f04758"><div class="ttname"><a href="classelma_1_1Manager.html#ad5df7316416ac9697d62e68e21f04758">elma::Manager::run</a></div><div class="ttdeci">Manager &amp; run(high_resolution_clock::duration)</div><div class="ttdef"><b>Definition:</b> <a href="manager_8cc_source.html#l00155">manager.cc:155</a></div></div>
<div class="ttc" id="classbasic__example_1_1BasicProcess_html_ae597a00726c51e7feff854f16d4886b2"><div class="ttname"><a href="classbasic__example_1_1BasicProcess.html#ae597a00726c51e7feff854f16d4886b2">basic_example::BasicProcess::start</a></div><div class="ttdeci">void start()</div><div class="ttdoc">Nothing to do to start. </div><div class="ttdef"><b>Definition:</b> <a href="basic_8cc_source.html#l00027">basic.cc:27</a></div></div>
<div class="ttc" id="classbasic__example_1_1BasicProcess_html"><div class="ttname"><a href="classbasic__example_1_1BasicProcess.html">basic_example::BasicProcess</a></div><div class="ttdoc">Example: A very basic process class. See the file examples/basic.cc for usage. </div><div class="ttdef"><b>Definition:</b> <a href="basic_8cc_source.html#l00016">basic.cc:16</a></div></div>
<div class="ttc" id="namespacestd_1_1chrono_html"><div class="ttname"><a href="namespacestd_1_1chrono.html">chrono</a></div></div>
<div class="ttc" id="namespacebasic__example_html"><div class="ttname"><a href="namespacebasic__example.html">basic_example</a></div><div class="ttdef"><b>Definition:</b> <a href="basic_8cc_source.html#l00010">basic.cc:10</a></div></div>
<div class="ttc" id="classelma_1_1Manager_html_a457cd75094c043632a1443758f041090"><div class="ttname"><a href="classelma_1_1Manager.html#a457cd75094c043632a1443758f041090">elma::Manager::init</a></div><div class="ttdeci">Manager &amp; init()</div><div class="ttdef"><b>Definition:</b> <a href="manager_8cc_source.html#l00092">manager.cc:92</a></div></div>
<div class="ttc" id="classelma_1_1Manager_html_a457cd75094c043632a1443758f041090"><div class="ttname"><a href="classelma_1_1Manager.html#a457cd75094c043632a1443758f041090">elma::Manager::init</a></div><div class="ttdeci">Manager &amp; init()</div><div class="ttdef"><b>Definition:</b> <a href="manager_8cc_source.html#l00096">manager.cc:96</a></div></div>
<div class="ttc" id="classbasic__example_1_1BasicProcess_html_a08fe736552a1c6b3f01d572d13bc4ca9"><div class="ttname"><a href="classbasic__example_1_1BasicProcess.html#a08fe736552a1c6b3f01d572d13bc4ca9">basic_example::BasicProcess::stop</a></div><div class="ttdeci">void stop()</div><div class="ttdoc">Nothing to do to stop. </div><div class="ttdef"><b>Definition:</b> <a href="basic_8cc_source.html#l00037">basic.cc:37</a></div></div>
<div class="ttc" id="classbasic__example_1_1BasicProcess_html_a1f0385c21355b4b9ea3b2368c5ea415c"><div class="ttname"><a href="classbasic__example_1_1BasicProcess.html#a1f0385c21355b4b9ea3b2368c5ea415c">basic_example::BasicProcess::BasicProcess</a></div><div class="ttdeci">BasicProcess(std::string name)</div><div class="ttdef"><b>Definition:</b> <a href="basic_8cc_source.html#l00021">basic.cc:21</a></div></div>
<div class="ttc" id="classbasic__example_1_1BasicProcess_html_a69c033d32c509410a734956ea44cadbf"><div class="ttname"><a href="classbasic__example_1_1BasicProcess.html#a69c033d32c509410a734956ea44cadbf">basic_example::BasicProcess::update</a></div><div class="ttdeci">void update()</div><div class="ttdoc">The update method just prints out some useful information. </div><div class="ttdef"><b>Definition:</b> <a href="basic_8cc_source.html#l00030">basic.cc:30</a></div></div>
Expand All @@ -148,7 +148,7 @@
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Developed by <a href="http://klavinslab.org">Eric Klavins</a> for UW ECE P 520<br>
Generated on Sun Mar 10 2019 16:17:05 for Elma by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Mon Mar 11 2019 00:40:18 for Elma by &#160;<a href="http://www.doxygen.org/index.html">
Doxygen
</a> 1.8.8
</small></address>
Expand Down
2 changes: 1 addition & 1 deletion docs/channel_8cc_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Developed by <a href="http://klavinslab.org">Eric Klavins</a> for UW ECE P 520<br>
Generated on Sun Mar 10 2019 16:17:05 for Elma by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Mon Mar 11 2019 00:40:18 for Elma by &#160;<a href="http://www.doxygen.org/index.html">
Doxygen
</a> 1.8.8
</small></address>
Expand Down
2 changes: 1 addition & 1 deletion docs/channel_8h_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Developed by <a href="http://klavinslab.org">Eric Klavins</a> for UW ECE P 520<br>
Generated on Sun Mar 10 2019 16:17:05 for Elma by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Mon Mar 11 2019 00:40:18 for Elma by &#160;<a href="http://www.doxygen.org/index.html">
Doxygen
</a> 1.8.8
</small></address>
Expand Down
6 changes: 3 additions & 3 deletions docs/classbasic__example_1_1BasicProcess-members.html
Original file line number Diff line number Diff line change
Expand Up @@ -106,8 +106,8 @@
<tr><td class="entry"><a class="el" href="classelma_1_1Process.html#a8da013223752f15787a3ff5ed2190211">num_updates</a>()</td><td class="entry"><a class="el" href="classelma_1_1Process.html">elma::Process</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classelma_1_1Process.html#ad210b775ce04da6d89fdc75435bab15f">period</a>()</td><td class="entry"><a class="el" href="classelma_1_1Process.html">elma::Process</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr><td class="entry"><a class="el" href="classelma_1_1Process.html#a2252f8767f4f437297c8a342b60b484e">previous_update</a>()</td><td class="entry"><a class="el" href="classelma_1_1Process.html">elma::Process</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classelma_1_1Process.html#ae3b98871432794ea262f4a26dfeab3f7">Process</a>()</td><td class="entry"><a class="el" href="classelma_1_1Process.html">elma::Process</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr><td class="entry"><a class="el" href="classelma_1_1Process.html#a4a29af963c350ce23ae8a91109affcf5">Process</a>(std::string name)</td><td class="entry"><a class="el" href="classelma_1_1Process.html">elma::Process</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classelma_1_1Process.html#a4445d9a192df2eedfda7fe82a626dac9">Process</a>(int n=0)</td><td class="entry"><a class="el" href="classelma_1_1Process.html">elma::Process</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr><td class="entry"><a class="el" href="classelma_1_1Process.html#a27a2b4642c368f48d1a7e35e92ae8ae4">Process</a>(std::string name, int n=0)</td><td class="entry"><a class="el" href="classelma_1_1Process.html">elma::Process</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>RUNNING</b> enum value (defined in <a class="el" href="classelma_1_1Process.html">elma::Process</a>)</td><td class="entry"><a class="el" href="classelma_1_1Process.html">elma::Process</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classbasic__example_1_1BasicProcess.html#ae597a00726c51e7feff854f16d4886b2">start</a>()</td><td class="entry"><a class="el" href="classbasic__example_1_1BasicProcess.html">basic_example::BasicProcess</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classelma_1_1Process.html#a347b1fd6fd7501bfd4b3ac63a9ee811e">start_time</a>()</td><td class="entry"><a class="el" href="classelma_1_1Process.html">elma::Process</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
Expand All @@ -123,7 +123,7 @@
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Developed by <a href="http://klavinslab.org">Eric Klavins</a> for UW ECE P 520<br>
Generated on Sun Mar 10 2019 16:17:06 for Elma by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Mon Mar 11 2019 00:40:18 for Elma by &#160;<a href="http://www.doxygen.org/index.html">
Doxygen
</a> 1.8.8
</small></address>
Expand Down
16 changes: 8 additions & 8 deletions docs/classbasic__example_1_1BasicProcess.html
Original file line number Diff line number Diff line change
Expand Up @@ -137,13 +137,13 @@
<tr class="memdesc:a08fe736552a1c6b3f01d572d13bc4ca9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Nothing to do to stop. <br /></td></tr>
<tr class="separator:a08fe736552a1c6b3f01d572d13bc4ca9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classelma_1_1Process"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classelma_1_1Process')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classelma_1_1Process.html">elma::Process</a></td></tr>
<tr class="memitem:ae3b98871432794ea262f4a26dfeab3f7 inherit pub_methods_classelma_1_1Process"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae3b98871432794ea262f4a26dfeab3f7"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classelma_1_1Process.html#ae3b98871432794ea262f4a26dfeab3f7">Process</a> ()</td></tr>
<tr class="memdesc:ae3b98871432794ea262f4a26dfeab3f7 inherit pub_methods_classelma_1_1Process"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor. Names process "no name". <br /></td></tr>
<tr class="separator:ae3b98871432794ea262f4a26dfeab3f7 inherit pub_methods_classelma_1_1Process"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4a29af963c350ce23ae8a91109affcf5 inherit pub_methods_classelma_1_1Process"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classelma_1_1Process.html#a4a29af963c350ce23ae8a91109affcf5">Process</a> (std::string <a class="el" href="classelma_1_1Process.html#a7ce946a55e71578bc1d33cf0a826c0de">name</a>)</td></tr>
<tr class="memdesc:a4a29af963c350ce23ae8a91109affcf5 inherit pub_methods_classelma_1_1Process"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor that takes a name for the process. <a href="#a4a29af963c350ce23ae8a91109affcf5">More...</a><br /></td></tr>
<tr class="separator:a4a29af963c350ce23ae8a91109affcf5 inherit pub_methods_classelma_1_1Process"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4445d9a192df2eedfda7fe82a626dac9 inherit pub_methods_classelma_1_1Process"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4445d9a192df2eedfda7fe82a626dac9"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classelma_1_1Process.html#a4445d9a192df2eedfda7fe82a626dac9">Process</a> (int n=0)</td></tr>
<tr class="memdesc:a4445d9a192df2eedfda7fe82a626dac9 inherit pub_methods_classelma_1_1Process"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor. Names process "no name". <br /></td></tr>
<tr class="separator:a4445d9a192df2eedfda7fe82a626dac9 inherit pub_methods_classelma_1_1Process"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a27a2b4642c368f48d1a7e35e92ae8ae4 inherit pub_methods_classelma_1_1Process"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classelma_1_1Process.html#a27a2b4642c368f48d1a7e35e92ae8ae4">Process</a> (std::string <a class="el" href="classelma_1_1Process.html#a7ce946a55e71578bc1d33cf0a826c0de">name</a>, int n=0)</td></tr>
<tr class="memdesc:a27a2b4642c368f48d1a7e35e92ae8ae4 inherit pub_methods_classelma_1_1Process"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor that takes a name for the process. <a href="#a27a2b4642c368f48d1a7e35e92ae8ae4">More...</a><br /></td></tr>
<tr class="separator:a27a2b4642c368f48d1a7e35e92ae8ae4 inherit pub_methods_classelma_1_1Process"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7ce946a55e71578bc1d33cf0a826c0de inherit pub_methods_classelma_1_1Process"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classelma_1_1Process.html#a7ce946a55e71578bc1d33cf0a826c0de">name</a> ()</td></tr>
<tr class="separator:a7ce946a55e71578bc1d33cf0a826c0de inherit pub_methods_classelma_1_1Process"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae43200bae94b94df1ec5cc10ff6b191b inherit pub_methods_classelma_1_1Process"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classelma_1_1Process.html#a355d4150a5de734fcb8ff654b7eabf3e">status_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classelma_1_1Process.html#ae43200bae94b94df1ec5cc10ff6b191b">status</a> ()</td></tr>
Expand Down Expand Up @@ -231,7 +231,7 @@
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Developed by <a href="http://klavinslab.org">Eric Klavins</a> for UW ECE P 520<br>
Generated on Sun Mar 10 2019 16:17:06 for Elma by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Mon Mar 11 2019 00:40:18 for Elma by &#160;<a href="http://www.doxygen.org/index.html">
Doxygen
</a> 1.8.8
</small></address>
Expand Down
Loading

0 comments on commit 83b53cb

Please sign in to comment.