Skip to content

Commit

Permalink
Deploy docs to GitHub Pages from commit 609a084
Browse files Browse the repository at this point in the history
Commit: 609a084
GitHub Actions run: 7231406827
  • Loading branch information
Doxygen CI committed Dec 16, 2023
1 parent 9a17d90 commit dd9879b
Show file tree
Hide file tree
Showing 53 changed files with 553 additions and 1,071 deletions.
45 changes: 2 additions & 43 deletions html/_abstract_list_8hpp.html
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Arduino List Library
&#160;<span id="projectnumber">2.1.4</span>
&#160;<span id="projectnumber">3.0.0</span>
</div>
<div id="projectbrief">The Ultimate Collection of Lists</div>
</td>
Expand Down Expand Up @@ -71,9 +71,7 @@
<div class="title">AbstractList.hpp File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;stdlib.h&gt;</code><br />
<code>#include &lt;string.h&gt;</code><br />
</div>

<p><a href="_abstract_list_8hpp_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Expand All @@ -89,9 +87,6 @@
<tr class="memitem:ac74b4f20a5c40f8309c3d39cb350027a"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_abstract_list_8hpp.html#ac74b4f20a5c40f8309c3d39cb350027a">extendedIsIndexOutOfBounds</a>(index)&#160;&#160;&#160;((index) != this-&gt;getSize() &amp;&amp; this-&gt;isIndexOutOfBounds(index))</td></tr>
<tr class="memdesc:ac74b4f20a5c40f8309c3d39cb350027a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Is the list mutable or immutable. <a href="#ac74b4f20a5c40f8309c3d39cb350027a">More...</a><br /></td></tr>
<tr class="separator:ac74b4f20a5c40f8309c3d39cb350027a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2390992677b55d282b648571379cc16b"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_abstract_list_8hpp.html#a2390992677b55d282b648571379cc16b">createFinalValue</a>(value, finalValue, T)</td></tr>
<tr class="memdesc:a2390992677b55d282b648571379cc16b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a final Value from the given Value. <a href="#a2390992677b55d282b648571379cc16b">More...</a><br /></td></tr>
<tr class="separator:a2390992677b55d282b648571379cc16b"><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>This file is part of the <a class="el" href="class_list.html" title="A list with the most basic implementation as a single-linked list. ">List</a> library. It extends the arduino ecosystem with easy-to-use list implementations. They are specially designed and optimized for different purposes.</p>
Expand Down Expand Up @@ -119,42 +114,6 @@ <h2 class="memtitle"><span class="permalink"><a href="#ac74b4f20a5c40f8309c3d39c
<p>Is the list mutable or immutable. </p>
<p>Sometimes it is allowed, that index == this-&gt;getSize() to insert it behind the last entry </p>

</div>
</div>
<a id="a2390992677b55d282b648571379cc16b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2390992677b55d282b648571379cc16b">&#9670;&nbsp;</a></span>createFinalValue</h2>

<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define createFinalValue</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">value, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">finalValue, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">T&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line">finalValue = (T *)malloc(<span class="keyword">sizeof</span>(T)); \</div><div class="line"> memcpy(finalValue, &amp;value, <span class="keyword">sizeof</span>(T));</div></div><!-- fragment -->
<p>Create a final Value from the given Value. </p>

</div>
</div>
</div><!-- contents -->
Expand Down
69 changes: 30 additions & 39 deletions html/_abstract_list_8hpp_source.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions html/_double_linked_list_8hpp.html
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Arduino List Library
&#160;<span id="projectnumber">2.1.4</span>
&#160;<span id="projectnumber">3.0.0</span>
</div>
<div id="projectbrief">The Ultimate Collection of Lists</div>
</td>
Expand Down Expand Up @@ -82,7 +82,7 @@
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This file is part of the <a class="el" href="class_list.html" title="A list with the most basic implementation as a single-linked list. ">List</a> library. It extends the arduino ecosystem with easy-to-use list implementations. They are specially designed and optimized for different purposes.</p>
<p>Copyright (C) 2022 Niklas Kaaf</p>
<p>Copyright (C) 2022-2023 Niklas Kaaf</p>
<p>This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.</p>
<p>This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.</p>
<p>You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA </p>
Expand Down
30 changes: 15 additions & 15 deletions html/_double_linked_list_8hpp_source.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion html/_list_8hpp.html
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Arduino List Library
&#160;<span id="projectnumber">2.1.4</span>
&#160;<span id="projectnumber">3.0.0</span>
</div>
<div id="projectbrief">The Ultimate Collection of Lists</div>
</td>
Expand Down
6 changes: 3 additions & 3 deletions html/_list_8hpp_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Arduino List Library
&#160;<span id="projectnumber">2.1.4</span>
&#160;<span id="projectnumber">3.0.0</span>
</div>
<div id="projectbrief">The Ultimate Collection of Lists</div>
</td>
Expand Down Expand Up @@ -68,8 +68,8 @@
<div class="title">List.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="_list_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;<span class="preprocessor">#ifndef LIST_HPP</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;<span class="preprocessor">#define LIST_HPP</span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="_single_linked_list_8hpp.html">SingleLinkedList.hpp</a>&quot;</span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;</div><div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="class_list.html"> 53</a></span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt; <span class="keyword">class </span><a class="code" href="class_list.html">List</a> : <span class="keyword">public</span> <a class="code" href="class_single_linked_list.html">SingleLinkedList</a>&lt;T&gt; {</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;<span class="keyword">public</span>:</div><div class="line"><a name="l00061"></a><span class="lineno"><a class="line" href="class_list.html#aa8cc0d7a6c91a5ecec3fa56c61d0a5c6"> 61</a></span>&#160; <span class="keyword">explicit</span> <a class="code" href="class_list.html">List&lt;T&gt;</a>(<span class="keywordtype">bool</span> mutableList = <span class="keyword">false</span>)</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; : <a class="code" href="class_single_linked_list.html">SingleLinkedList&lt;T&gt;</a>(mutableList) {}</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;};</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;<span class="preprocessor">#endif // LIST_HPP</span></div><div class="ttc" id="class_list_html"><div class="ttname"><a href="class_list.html">List</a></div><div class="ttdoc">A list with the most basic implementation as a single-linked list. </div><div class="ttdef"><b>Definition:</b> List.hpp:53</div></div>
<div class="ttc" id="class_single_linked_list_html"><div class="ttname"><a href="class_single_linked_list.html">SingleLinkedList</a></div><div class="ttdoc">Implementation of a single-linked list. </div><div class="ttdef"><b>Definition:</b> SingleLinkedList.hpp:36</div></div>
<a href="_list_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;<span class="preprocessor">#ifndef LIST_HPP</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;<span class="preprocessor">#define LIST_HPP</span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="_single_linked_list_8hpp.html">SingleLinkedList.hpp</a>&quot;</span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;<span class="keyword">template</span>&lt;<span class="keyword">typename</span> T&gt;</div><div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="class_list.html"> 54</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_list.html">List</a> : <span class="keyword">public</span> <a class="code" href="class_single_linked_list.html">SingleLinkedList</a>&lt;T&gt; {</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; <span class="keyword">public</span>:</div><div class="line"><a name="l00064"></a><span class="lineno"><a class="line" href="class_list.html#aa8cc0d7a6c91a5ecec3fa56c61d0a5c6"> 64</a></span>&#160; <span class="keyword">explicit</span> <a class="code" href="class_list.html">List&lt;T&gt;</a>(<span class="keywordtype">bool</span> mutableList = <span class="keyword">false</span>)</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; : <a class="code" href="class_single_linked_list.html">SingleLinkedList&lt;T&gt;</a>(mutableList) {}</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160;};</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160;</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;<span class="preprocessor">#endif// LIST_HPP</span></div><div class="ttc" id="class_list_html"><div class="ttname"><a href="class_list.html">List</a></div><div class="ttdoc">A list with the most basic implementation as a single-linked list. </div><div class="ttdef"><b>Definition:</b> List.hpp:54</div></div>
<div class="ttc" id="class_single_linked_list_html"><div class="ttname"><a href="class_single_linked_list.html">SingleLinkedList</a></div><div class="ttdoc">Implementation of a single-linked list. </div><div class="ttdef"><b>Definition:</b> SingleLinkedList.hpp:37</div></div>
<div class="ttc" id="_single_linked_list_8hpp_html"><div class="ttname"><a href="_single_linked_list_8hpp.html">SingleLinkedList.hpp</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
Expand Down
4 changes: 2 additions & 2 deletions html/_single_linked_list_8hpp.html
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Arduino List Library
&#160;<span id="projectnumber">2.1.4</span>
&#160;<span id="projectnumber">3.0.0</span>
</div>
<div id="projectbrief">The Ultimate Collection of Lists</div>
</td>
Expand Down Expand Up @@ -82,7 +82,7 @@
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This file is part of the <a class="el" href="class_list.html" title="A list with the most basic implementation as a single-linked list. ">List</a> library. It extends the arduino ecosystem with easy-to-use list implementations. They are specially designed and optimized for different purposes.</p>
<p>Copyright (C) 2021-2022 Niklas Kaaf</p>
<p>Copyright (C) 2021-2023 Niklas Kaaf</p>
<p>This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.</p>
<p>This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.</p>
<p>You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA </p>
Expand Down
30 changes: 15 additions & 15 deletions html/_single_linked_list_8hpp_source.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion html/annotated.html
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Arduino List Library
&#160;<span id="projectnumber">2.1.4</span>
&#160;<span id="projectnumber">3.0.0</span>
</div>
<div id="projectbrief">The Ultimate Collection of Lists</div>
</td>
Expand Down
Loading

0 comments on commit dd9879b

Please sign in to comment.