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>
@@ -97,27 +97,27 @@ $(document).ready(function(){initNavTree('_intelli_tool_rectangle_8h_source.html
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160; </div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="preprocessor">#include &quot;QColor&quot;</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="preprocessor">#include &quot;QPoint&quot;</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"><a class="line" href="class_intelli_tool_rectangle.html"> 11</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_intelli_tool_rectangle.html">IntelliToolRectangle</a> : <span class="keyword">public</span> <a class="code" href="class_intelli_tool.html">IntelliTool</a>{</div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160; <span class="keywordtype">void</span> drawRectangle(QPoint otherCornor);</div>
<div class="line"><a name="l00011"></a><span class="lineno"><a class="line" href="class_intelli_tool_rectangle.html"> 11</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_intelli_tool_rectangle.html">IntelliToolRectangle</a> : <span class="keyword">public</span> <a class="code" href="class_intelli_tool.html">IntelliTool</a> {</div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="keywordtype">void</span> drawRectangle(QPoint otherCornor);</div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; </div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; QPoint originCornor;</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; <span class="keywordtype">int</span> alphaInner;</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; <span class="keywordtype">int</span> edgeWidth;</div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;QPoint originCornor;</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="keywordtype">int</span> alphaInner;</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="keywordtype">int</span> edgeWidth;</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <a class="code" href="class_intelli_tool_rectangle.html#aa9823939a8b8924520a2943cf6335c11">IntelliToolRectangle</a>(<a class="code" href="class_painting_area.html">PaintingArea</a>* <a class="code" href="class_intelli_tool.html#ab4c2698a0f9f25fb6639ec760d2d0289">Area</a>, <a class="code" href="class_intelli_color_picker.html">IntelliColorPicker</a>* <a class="code" href="class_intelli_tool.html#ae2e0ac394611a361ab4ef2fe55c03fef">colorPicker</a>);</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <span class="keyword">virtual</span> <a class="code" href="class_intelli_tool_rectangle.html#a7dc1463e726a21255e6297241dc71fb1">~IntelliToolRectangle</a>() <span class="keyword">override</span>;</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<a class="code" href="class_intelli_tool_rectangle.html#aa9823939a8b8924520a2943cf6335c11">IntelliToolRectangle</a>(<a class="code" href="class_painting_area.html">PaintingArea</a>* <a class="code" href="class_intelli_tool.html#ab4c2698a0f9f25fb6639ec760d2d0289">Area</a>, <a class="code" href="class_intelli_color_picker.html">IntelliColorPicker</a>* <a class="code" href="class_intelli_tool.html#ae2e0ac394611a361ab4ef2fe55c03fef">colorPicker</a>);</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;<span class="keyword">virtual</span> <a class="code" href="class_intelli_tool_rectangle.html#a7dc1463e726a21255e6297241dc71fb1">~IntelliToolRectangle</a>() <span class="keyword">override</span>;</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; </div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_intelli_tool_rectangle.html#a480c6804a4963c5a1c3f7ef84b63c1a8">onMouseRightPressed</a>(<span class="keywordtype">int</span> x, <span class="keywordtype">int</span> y) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;<span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_intelli_tool_rectangle.html#a480c6804a4963c5a1c3f7ef84b63c1a8">onMouseRightPressed</a>(<span class="keywordtype">int</span> x, <span class="keywordtype">int</span> y) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; </div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_intelli_tool_rectangle.html#ad43f653256a6516b9398f82054be0d7f">onMouseRightReleased</a>(<span class="keywordtype">int</span> x, <span class="keywordtype">int</span> y) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;<span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_intelli_tool_rectangle.html#ad43f653256a6516b9398f82054be0d7f">onMouseRightReleased</a>(<span class="keywordtype">int</span> x, <span class="keywordtype">int</span> y) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; </div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_intelli_tool_rectangle.html#ae03c307ccf66cbe3fd59e3657712368d">onMouseLeftPressed</a>(<span class="keywordtype">int</span> x, <span class="keywordtype">int</span> y) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;<span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_intelli_tool_rectangle.html#ae03c307ccf66cbe3fd59e3657712368d">onMouseLeftPressed</a>(<span class="keywordtype">int</span> x, <span class="keywordtype">int</span> y) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; </div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_intelli_tool_rectangle.html#a94460e3ff1c19e80bde922c55f53cc43">onMouseLeftReleased</a>(<span class="keywordtype">int</span> x, <span class="keywordtype">int</span> y) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;<span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_intelli_tool_rectangle.html#a94460e3ff1c19e80bde922c55f53cc43">onMouseLeftReleased</a>(<span class="keywordtype">int</span> x, <span class="keywordtype">int</span> y) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; </div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_intelli_tool_rectangle.html#a445c53a56e859f970e59f5036e221e0c">onWheelScrolled</a>(<span class="keywordtype">int</span> value) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160;<span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_intelli_tool_rectangle.html#a445c53a56e859f970e59f5036e221e0c">onWheelScrolled</a>(<span class="keywordtype">int</span> value) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; </div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_intelli_tool_rectangle.html#a4b5931071e21eb6949ffe357315e408b">onMouseMoved</a>(<span class="keywordtype">int</span> x, <span class="keywordtype">int</span> y) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160;<span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_intelli_tool_rectangle.html#a4b5931071e21eb6949ffe357315e408b">onMouseMoved</a>(<span class="keywordtype">int</span> x, <span class="keywordtype">int</span> y) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160;};</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; </div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;<span class="preprocessor">#endif // INTELLIRECTANGLETOOL_H</span></div>
@@ -131,7 +131,7 @@ $(document).ready(function(){initNavTree('_intelli_tool_rectangle_8h_source.html
<div class="ttc" id="aclass_intelli_tool_rectangle_html_ae03c307ccf66cbe3fd59e3657712368d"><div class="ttname"><a href="class_intelli_tool_rectangle.html#ae03c307ccf66cbe3fd59e3657712368d">IntelliToolRectangle::onMouseLeftPressed</a></div><div class="ttdeci">virtual void onMouseLeftPressed(int x, int y) override</div><div class="ttdoc">A function managing the left click pressed of a mouse. Setting the originCorner and draws a rectangle...</div><div class="ttdef"><b>Definition:</b> <a href="_intelli_tool_rectangle_8cpp_source.html#l00041">IntelliToolRectangle.cpp:41</a></div></div>
<div class="ttc" id="aclass_intelli_tool_html_ab4c2698a0f9f25fb6639ec760d2d0289"><div class="ttname"><a href="class_intelli_tool.html#ab4c2698a0f9f25fb6639ec760d2d0289">IntelliTool::Area</a></div><div class="ttdeci">PaintingArea * Area</div><div class="ttdoc">A pointer to the general PaintingArea to interact with.</div><div class="ttdef"><b>Definition:</b> <a href="_intelli_tool_8h_source.html#l00033">IntelliTool.h:33</a></div></div>
<div class="ttc" id="aclass_intelli_tool_rectangle_html_a480c6804a4963c5a1c3f7ef84b63c1a8"><div class="ttname"><a href="class_intelli_tool_rectangle.html#a480c6804a4963c5a1c3f7ef84b63c1a8">IntelliToolRectangle::onMouseRightPressed</a></div><div class="ttdeci">virtual void onMouseRightPressed(int x, int y) override</div><div class="ttdoc">A function managing the right click pressed of a mouse.Resetting the current draw.</div><div class="ttdef"><b>Definition:</b> <a href="_intelli_tool_rectangle_8cpp_source.html#l00033">IntelliToolRectangle.cpp:33</a></div></div>
<div class="ttc" id="aclass_painting_area_html"><div class="ttname"><a href="class_painting_area.html">PaintingArea</a></div><div class="ttdef"><b>Definition:</b> <a href="_painting_area_8h_source.html#l00025">PaintingArea.h:25</a></div></div>
<div class="ttc" id="aclass_painting_area_html"><div class="ttname"><a href="class_painting_area.html">PaintingArea</a></div><div class="ttdoc">The PaintingArea class manages the methods and stores information about the current painting area,...</div><div class="ttdef"><b>Definition:</b> <a href="_painting_area_8h_source.html#l00036">PaintingArea.h:36</a></div></div>
<div class="ttc" id="aclass_intelli_tool_rectangle_html"><div class="ttname"><a href="class_intelli_tool_rectangle.html">IntelliToolRectangle</a></div><div class="ttdoc">The IntelliToolRectangle class represents a tool to draw a rectangle.</div><div class="ttdef"><b>Definition:</b> <a href="_intelli_tool_rectangle_8h_source.html#l00011">IntelliToolRectangle.h:11</a></div></div>
<div class="ttc" id="aclass_intelli_tool_html"><div class="ttname"><a href="class_intelli_tool.html">IntelliTool</a></div><div class="ttdoc">An abstract class that manages the basic events, like mouse clicks or scrolls events.</div><div class="ttdef"><b>Definition:</b> <a href="_intelli_tool_8h_source.html#l00013">IntelliTool.h:13</a></div></div>
<div class="ttc" id="aclass_intelli_tool_rectangle_html_a4b5931071e21eb6949ffe357315e408b"><div class="ttname"><a href="class_intelli_tool_rectangle.html#a4b5931071e21eb6949ffe357315e408b">IntelliToolRectangle::onMouseMoved</a></div><div class="ttdeci">virtual void onMouseMoved(int x, int y) override</div><div class="ttdoc">A function managing the mouse moved event.Drawing a rectangle to currrent mouse position.</div><div class="ttdef"><b>Definition:</b> <a href="_intelli_tool_rectangle_8cpp_source.html#l00052">IntelliToolRectangle.cpp:52</a></div></div>