Updated doxygen docs to latest changes

This commit is contained in:
2019-12-19 19:39:08 +01:00
parent 5073312f7a
commit 9c95059b93
239 changed files with 2996 additions and 2508 deletions

View File

@@ -30,7 +30,7 @@
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">IntelliPhoto
&#160;<span id="projectnumber">0.4</span>
&#160;<span id="projectnumber">0.5</span>
</div>
</td>
</tr>
@@ -94,6 +94,9 @@ $(document).ready(function(){initNavTree('struct_layer_object.html','');});
</div><!--header-->
<div class="contents">
<p>The <a class="el" href="struct_layer_object.html" title="The LayerObject struct holds all the information needed to construct a layer.">LayerObject</a> struct holds all the information needed to construct a layer.
<a href="struct_layer_object.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="_painting_area_8h_source.html">PaintingArea.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for LayerObject:</div>
@@ -107,18 +110,29 @@ Public Attributes</h2></td></tr>
<tr class="separator:af01a139bc8edfdbb338393874e89bd83"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af261813df52ff0b0c82bfa57efeb9897"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_layer_object.html#af261813df52ff0b0c82bfa57efeb9897">width</a></td></tr>
<tr class="separator:af261813df52ff0b0c82bfa57efeb9897"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4b1729dbf7d3490e4c2776e29ffef8b0"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_layer_object.html#a4b1729dbf7d3490e4c2776e29ffef8b0">hight</a></td></tr>
<tr class="separator:a4b1729dbf7d3490e4c2776e29ffef8b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae0003fb815e50ed587a9897988befc90"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_layer_object.html#ae0003fb815e50ed587a9897988befc90">height</a></td></tr>
<tr class="separator:ae0003fb815e50ed587a9897988befc90"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a72b44d27c7bbb60dde14f04ec240ab96"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_layer_object.html#a72b44d27c7bbb60dde14f04ec240ab96">widthOffset</a></td></tr>
<tr class="separator:a72b44d27c7bbb60dde14f04ec240ab96"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6256486a76c38baa3f1c664f4d190743"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_layer_object.html#a6256486a76c38baa3f1c664f4d190743">hightOffset</a></td></tr>
<tr class="separator:a6256486a76c38baa3f1c664f4d190743"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a08bacdcd64a0ae0eb5376f55329954bc"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_layer_object.html#a08bacdcd64a0ae0eb5376f55329954bc">heightOffset</a></td></tr>
<tr class="separator:a08bacdcd64a0ae0eb5376f55329954bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a402cb1d9f20436032fe080681b80eb56"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_layer_object.html#a402cb1d9f20436032fe080681b80eb56">alpha</a> =255</td></tr>
<tr class="separator:a402cb1d9f20436032fe080681b80eb56"><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="_painting_area_8h_source.html#l00016">16</a> of file <a class="el" href="_painting_area_8h_source.html">PaintingArea.h</a>.</p>
<div class="textblock"><p>The <a class="el" href="struct_layer_object.html" title="The LayerObject struct holds all the information needed to construct a layer.">LayerObject</a> struct holds all the information needed to construct a layer. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">width</td><td>- Stores the width of a layer in pixels </td></tr>
<tr><td class="paramname">height</td><td>- Stores the height of a layer in pixels </td></tr>
<tr><td class="paramname">alpha</td><td>- Stores the alpha value of the layer (default=255) </td></tr>
<tr><td class="paramname">widthOffset</td><td>- Stores the number of pixles from the left side of the painting area </td></tr>
<tr><td class="paramname">heightOffset</td><td>- Stores the number of pixles from the top of the painting area </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="_painting_area_8h_source.html#l00024">24</a> of file <a class="el" href="_painting_area_8h_source.html">PaintingArea.h</a>.</p>
</div><h2 class="groupheader">Member Data Documentation</h2>
<a id="a402cb1d9f20436032fe080681b80eb56"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a402cb1d9f20436032fe080681b80eb56">&#9670;&nbsp;</a></span>alpha</h2>
@@ -132,39 +146,39 @@ Public Attributes</h2></td></tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="_painting_area_8h_source.html#l00022">22</a> of file <a class="el" href="_painting_area_8h_source.html">PaintingArea.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="_painting_area_8h_source.html#l00030">30</a> of file <a class="el" href="_painting_area_8h_source.html">PaintingArea.h</a>.</p>
</div>
</div>
<a id="a4b1729dbf7d3490e4c2776e29ffef8b0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4b1729dbf7d3490e4c2776e29ffef8b0">&#9670;&nbsp;</a></span>hight</h2>
<a id="ae0003fb815e50ed587a9897988befc90"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae0003fb815e50ed587a9897988befc90">&#9670;&nbsp;</a></span>height</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int LayerObject::hight</td>
<td class="memname">int LayerObject::height</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="_painting_area_8h_source.html#l00019">19</a> of file <a class="el" href="_painting_area_8h_source.html">PaintingArea.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="_painting_area_8h_source.html#l00027">27</a> of file <a class="el" href="_painting_area_8h_source.html">PaintingArea.h</a>.</p>
</div>
</div>
<a id="a6256486a76c38baa3f1c664f4d190743"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6256486a76c38baa3f1c664f4d190743">&#9670;&nbsp;</a></span>hightOffset</h2>
<a id="a08bacdcd64a0ae0eb5376f55329954bc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a08bacdcd64a0ae0eb5376f55329954bc">&#9670;&nbsp;</a></span>heightOffset</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int LayerObject::hightOffset</td>
<td class="memname">int LayerObject::heightOffset</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="_painting_area_8h_source.html#l00021">21</a> of file <a class="el" href="_painting_area_8h_source.html">PaintingArea.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="_painting_area_8h_source.html#l00029">29</a> of file <a class="el" href="_painting_area_8h_source.html">PaintingArea.h</a>.</p>
</div>
</div>
@@ -180,7 +194,7 @@ Public Attributes</h2></td></tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="_painting_area_8h_source.html#l00017">17</a> of file <a class="el" href="_painting_area_8h_source.html">PaintingArea.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="_painting_area_8h_source.html#l00025">25</a> of file <a class="el" href="_painting_area_8h_source.html">PaintingArea.h</a>.</p>
</div>
</div>
@@ -196,7 +210,7 @@ Public Attributes</h2></td></tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="_painting_area_8h_source.html#l00018">18</a> of file <a class="el" href="_painting_area_8h_source.html">PaintingArea.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="_painting_area_8h_source.html#l00026">26</a> of file <a class="el" href="_painting_area_8h_source.html">PaintingArea.h</a>.</p>
</div>
</div>
@@ -212,7 +226,7 @@ Public Attributes</h2></td></tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="_painting_area_8h_source.html#l00020">20</a> of file <a class="el" href="_painting_area_8h_source.html">PaintingArea.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="_painting_area_8h_source.html#l00028">28</a> of file <a class="el" href="_painting_area_8h_source.html">PaintingArea.h</a>.</p>
</div>
</div>