Skip to content

Commit

Permalink
Added oxygen documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
TDHolmes committed Sep 11, 2016
1 parent b695eff commit 3391b42
Show file tree
Hide file tree
Showing 705 changed files with 62,284 additions and 599 deletions.
2,487 changes: 2,487 additions & 0 deletions Doxyfile

Large diffs are not rendered by default.

3 changes: 0 additions & 3 deletions binaryclock_2_0.sublime-project
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,6 @@
{
"path": "/usr/local/CrossPack-AVR-20131216/avr/include"
},
{
"path": "software"
},
{
"path": "."
}
Expand Down
Binary file modified documents/.DS_Store
Binary file not shown.
421 changes: 421 additions & 0 deletions documents/CodeDocumentation/html/_l_e_d_8c.html

Large diffs are not rendered by default.

832 changes: 832 additions & 0 deletions documents/CodeDocumentation/html/_l_e_d_8h.html

Large diffs are not rendered by default.

89 changes: 89 additions & 0 deletions documents/CodeDocumentation/html/_l_e_d_8h_source.html

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -0,0 +1,166 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.12"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>binary Clock: firmware/LED_drvr_STP16CPC26.c 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">binary Clock
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.12 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</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_d9edf6c004b4a7ff14fe9ae7a92214ee.html">firmware</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">LED_drvr_STP16CPC26.c File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &quot;<a class="el" href="_l_e_d__drvr___s_t_p16_c_p_c26_8h_source.html">LED_drvr_STP16CPC26.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="_l_e_d_8h_source.html">LED.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="ports_8h_source.html">ports.h</a>&quot;</code><br />
<code>#include &lt;stdint.h&gt;</code><br />
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a70d330906276a996f7dab090a03ce2a5"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_l_e_d__drvr___s_t_p16_c_p_c26_8c.html#a70d330906276a996f7dab090a03ce2a5">COLOR_DEPTH</a>&#160;&#160;&#160;4</td></tr>
<tr class="memdesc:a70d330906276a996f7dab090a03ce2a5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of bits of color to multiplex. <a href="#a70d330906276a996f7dab090a03ce2a5">More...</a><br /></td></tr>
<tr class="separator:a70d330906276a996f7dab090a03ce2a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a114c987dc587d53f9c53173afe4f9a54"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_l_e_d__drvr___s_t_p16_c_p_c26_8c.html#a114c987dc587d53f9c53173afe4f9a54">LED_drvr_init</a> (<a class="el" href="struct_l_e_d__drvr__t.html">LED_drvr_t</a> *LED_ptr)</td></tr>
<tr class="separator:a114c987dc587d53f9c53173afe4f9a54"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a649a79cad2b9aae395acbbd8612cc970"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_l_e_d__drvr___s_t_p16_c_p_c26_8c.html#a649a79cad2b9aae395acbbd8612cc970">LED_drvr_run</a> (<a class="el" href="struct_l_e_d__drvr__t.html">LED_drvr_t</a> *LED_ptr)</td></tr>
<tr class="separator:a649a79cad2b9aae395acbbd8612cc970"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a70d330906276a996f7dab090a03ce2a5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a70d330906276a996f7dab090a03ce2a5">&sect;&nbsp;</a></span>COLOR_DEPTH</h2>

<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define COLOR_DEPTH&#160;&#160;&#160;4</td>
</tr>
</table>
</div><div class="memdoc">

<p>Number of bits of color to multiplex. </p>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a114c987dc587d53f9c53173afe4f9a54"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a114c987dc587d53f9c53173afe4f9a54">&sect;&nbsp;</a></span>LED_drvr_init()</h2>

<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void LED_drvr_init </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_l_e_d__drvr__t.html">LED_drvr_t</a> *&#160;</td>
<td class="paramname"><em>LED_ptr</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initializes the LED driver structure and drives the anode port high to avoid LEDs turning on.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">LED_ptr</td><td>(<a class="el" href="struct_l_e_d__drvr__t.html" title="LED driver structure to keep track of pertinant LED variables. ">LED_drvr_t</a> *): pointer to the LED driver structure. </td></tr>
</table>
</dd>
</dl>

</div>
</div>
<a id="a649a79cad2b9aae395acbbd8612cc970"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a649a79cad2b9aae395acbbd8612cc970">&sect;&nbsp;</a></span>LED_drvr_run()</h2>

<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void LED_drvr_run </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_l_e_d__drvr__t.html">LED_drvr_t</a> *&#160;</td>
<td class="paramname"><em>LED_ptr</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Runs the LED multiplexing code. Generates a bitstream to send to the LED driver, then activates the corresponding column.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">LED_ptr</td><td>(<a class="el" href="struct_l_e_d__drvr__t.html" title="LED driver structure to keep track of pertinant LED variables. ">LED_drvr_t</a> *): pointer to the LED driver structure. </td></tr>
</table>
</dd>
</dl>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.12
</small></address>
</body>
</html>
Loading

0 comments on commit 3391b42

Please sign in to comment.