lauchmelder/b15f
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

doc update

Browse source
This commit is contained in:
Tristan Krause 2019-05-23 15:08:54 +02:00
parent 90e62b739b
commit 5f48849c4e
117 changed files with 3780 additions and 2135 deletions
Download patch file Download diff file Expand all files Collapse all files

125
docs/html/classDot.html
View file

@ -69,33 +69,134 @@ $(function() {
<div class="title">Dot Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="dot_8h_source.html">dot.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ad975f119c0627a928790b3cd5ca6da05"><td class="memItemLeft" align="right" valign="top"><a id="ad975f119c0627a928790b3cd5ca6da05"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>Dot</b> (uint16_t x, uint16_t y, uint8_t curve)</td></tr>
<tr class="memitem:ad975f119c0627a928790b3cd5ca6da05"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDot.html#ad975f119c0627a928790b3cd5ca6da05">Dot</a> (uint16_t x, uint16_t y, uint8_t curve)</td></tr>
<tr class="separator:ad975f119c0627a928790b3cd5ca6da05"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a029f0cc99c474122b77a708a317e7f77"><td class="memItemLeft" align="right" valign="top"><a id="a029f0cc99c474122b77a708a317e7f77"></a>
uint16_t&#160;</td><td class="memItemRight" valign="bottom"><b>getX</b> (void) const</td></tr>
<tr class="memitem:a029f0cc99c474122b77a708a317e7f77"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDot.html#a029f0cc99c474122b77a708a317e7f77">getX</a> (void) const</td></tr>
<tr class="separator:a029f0cc99c474122b77a708a317e7f77"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8fcb987e6308d8184d1a2c8692227e58"><td class="memItemLeft" align="right" valign="top"><a id="a8fcb987e6308d8184d1a2c8692227e58"></a>
uint16_t&#160;</td><td class="memItemRight" valign="bottom"><b>getY</b> (void) const</td></tr>
<tr class="memitem:a8fcb987e6308d8184d1a2c8692227e58"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDot.html#a8fcb987e6308d8184d1a2c8692227e58">getY</a> (void) const</td></tr>
<tr class="separator:a8fcb987e6308d8184d1a2c8692227e58"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad0ae7dc1a9be3d8d985affc089b34396"><td class="memItemLeft" align="right" valign="top"><a id="ad0ae7dc1a9be3d8d985affc089b34396"></a>
uint8_t&#160;</td><td class="memItemRight" valign="bottom"><b>getCurve</b> (void) const</td></tr>
<tr class="memitem:ad0ae7dc1a9be3d8d985affc089b34396"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDot.html#ad0ae7dc1a9be3d8d985affc089b34396">getCurve</a> (void) const</td></tr>
<tr class="separator:ad0ae7dc1a9be3d8d985affc089b34396"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock">
<p class="definition">Definition at line <a class="el" href="dot_8h_source.html#l00007">7</a> of file <a class="el" href="dot_8h_source.html">dot.h</a>.</p>
</div><hr/>The documentation for this class was generated from the following files:<ul>
<div class="textblock"><p>Immutable dot class with x and y coordinate and curve index. Dots with the same curve index get the same color by plotty. </p>
<p class="definition">Definition at line <a class="el" href="dot_8h_source.html#l00012">12</a> of file <a class="el" href="dot_8h_source.html">dot.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ad975f119c0627a928790b3cd5ca6da05"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad975f119c0627a928790b3cd5ca6da05">&#9670;&nbsp;</a></span>Dot()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Dot::Dot </td>
<td>(</td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>curve</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor with x and y coordinate and curve index. </p>
<p class="definition">Definition at line <a class="el" href="dot_8cpp_source.html#l00003">3</a> of file <a class="el" href="dot_8cpp_source.html">dot.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ad0ae7dc1a9be3d8d985affc089b34396"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad0ae7dc1a9be3d8d985affc089b34396">&#9670;&nbsp;</a></span>getCurve()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t Dot::getCurve </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the curve index. </p>
<p class="definition">Definition at line <a class="el" href="dot_8cpp_source.html#l00019">19</a> of file <a class="el" href="dot_8cpp_source.html">dot.cpp</a>.</p>
</div>
</div>
<a id="a029f0cc99c474122b77a708a317e7f77"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a029f0cc99c474122b77a708a317e7f77">&#9670;&nbsp;</a></span>getX()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint16_t Dot::getX </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the x coordinate. </p>
<p class="definition">Definition at line <a class="el" href="dot_8cpp_source.html#l00009">9</a> of file <a class="el" href="dot_8cpp_source.html">dot.cpp</a>.</p>
</div>
</div>
<a id="a8fcb987e6308d8184d1a2c8692227e58"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8fcb987e6308d8184d1a2c8692227e58">&#9670;&nbsp;</a></span>getY()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint16_t Dot::getY </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the y coordinate. </p>
<p class="definition">Definition at line <a class="el" href="dot_8cpp_source.html#l00014">14</a> of file <a class="el" href="dot_8cpp_source.html">dot.cpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>drv/<a class="el" href="dot_8h_source.html">dot.h</a></li>
<li>drv/<a class="el" href="dot_8cpp_source.html">dot.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Thu May 23 2019 15:04:21 for B15F by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.16
</small></address>