Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
phthtgvi committed Dec 10, 2023
1 parent 2f259bd commit 51a7f67
Show file tree
Hide file tree
Showing 298 changed files with 18,525 additions and 3,597 deletions.
2 changes: 1 addition & 1 deletion Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ PROJECT_NAME = "svg-reader"
# could be handy for archiving the generated documentation or if some version
# control system is used.

PROJECT_NUMBER = 0.1
PROJECT_NUMBER = 0.2

# Using the PROJECT_BRIEF tag one can provide an optional one line description
# for a project that appears at the top of each page and should give viewer a
Expand Down
18 changes: 11 additions & 7 deletions docs/html/Circle_8cpp_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">svg-reader
&#160;<span id="projectnumber">0.1</span>
&#160;<span id="projectnumber">0.2</span>
</div>
<div id="projectbrief">Parse and render SVG files, handle user interactions.</div>
</td>
Expand Down Expand Up @@ -123,12 +123,16 @@
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="preprocessor">#include &quot;Circle.hpp&quot;</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160; </div>
<div class="line"><a name="l00003"></a><span class="lineno"><a class="line" href="classCircle.html#ad89ead8bfb9ca432d954fed00d62f325"> 3</a></span>&#160;<a class="code" href="classCircle.html#ad89ead8bfb9ca432d954fed00d62f325">Circle::Circle</a>(<span class="keywordtype">float</span> radius, <span class="keyword">const</span> sf::Vector2f &amp;center, sf::Color fill,</div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160; sf::Color stroke, <span class="keywordtype">float</span> stroke_thickness)</div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160; : <a class="code" href="classEllipse.html">Ellipse</a>(sf::Vector2f(radius, radius), center, fill, stroke,</div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160; stroke_thickness) {}</div>
<div class="ttc" id="aclassCircle_html_ad89ead8bfb9ca432d954fed00d62f325"><div class="ttname"><a href="classCircle.html#ad89ead8bfb9ca432d954fed00d62f325">Circle::Circle</a></div><div class="ttdeci">Circle(float radius, const sf::Vector2f &amp;center, sf::Color fill, sf::Color stroke, float stroke_thickness)</div><div class="ttdoc">Constructs a Circle object.</div><div class="ttdef"><b>Definition:</b> <a href="Circle_8cpp_source.html#l00003">Circle.cpp:3</a></div></div>
<div class="ttc" id="aclassEllipse_html"><div class="ttname"><a href="classEllipse.html">Ellipse</a></div><div class="ttdoc">Represents an ellipse in 2D space.</div><div class="ttdef"><b>Definition:</b> <a href="Ellipse_8hpp_source.html#l00012">Ellipse.hpp:12</a></div></div>
<div class="line"><a name="l00003"></a><span class="lineno"><a class="line" href="classCircle.html#a5d018c51bfa1fa3d1081e3deef5eddc0"> 3</a></span>&#160;<a class="code" href="classCircle.html#a5d018c51bfa1fa3d1081e3deef5eddc0">Circle::Circle</a>(<span class="keywordtype">float</span> radius, <span class="keyword">const</span> <a class="code" href="classVector2D.html">Vector2Df</a> &amp;center, <a class="code" href="classmColor.html">mColor</a> fill,</div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160; <a class="code" href="classmColor.html">mColor</a> stroke, <span class="keywordtype">float</span> stroke_width)</div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160; : <a class="code" href="classEll.html">Ell</a>(<a class="code" href="classVector2D.html">Vector2Df</a>(radius, radius), center, fill, stroke, stroke_width) {}</div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160; </div>
<div class="line"><a name="l00007"></a><span class="lineno"><a class="line" href="classCircle.html#a09523e46318092d42a5969a1da5613bb"> 7</a></span>&#160;std::string <a class="code" href="classCircle.html#a09523e46318092d42a5969a1da5613bb">Circle::getClass</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <span class="stringliteral">&quot;Circle&quot;</span>; }</div>
<div class="ttc" id="aclassCircle_html_a09523e46318092d42a5969a1da5613bb"><div class="ttname"><a href="classCircle.html#a09523e46318092d42a5969a1da5613bb">Circle::getClass</a></div><div class="ttdeci">std::string getClass() const override</div><div class="ttdoc">Gets the type of the shape.</div><div class="ttdef"><b>Definition:</b> <a href="Circle_8cpp_source.html#l00007">Circle.cpp:7</a></div></div>
<div class="ttc" id="aclassCircle_html_a5d018c51bfa1fa3d1081e3deef5eddc0"><div class="ttname"><a href="classCircle.html#a5d018c51bfa1fa3d1081e3deef5eddc0">Circle::Circle</a></div><div class="ttdeci">Circle(float radius, const Vector2Df &amp;center, mColor fill, mColor stroke, float stroke_width)</div><div class="ttdoc">Constructs a Circle object.</div><div class="ttdef"><b>Definition:</b> <a href="Circle_8cpp_source.html#l00003">Circle.cpp:3</a></div></div>
<div class="ttc" id="aclassEll_html"><div class="ttname"><a href="classEll.html">Ell</a></div><div class="ttdoc">Represents an ellipse in 2D space.</div><div class="ttdef"><b>Definition:</b> <a href="Ellipse_8hpp_source.html#l00012">Ellipse.hpp:12</a></div></div>
<div class="ttc" id="aclassVector2D_html"><div class="ttname"><a href="classVector2D.html">Vector2D&lt; float &gt;</a></div></div>
<div class="ttc" id="aclassmColor_html"><div class="ttname"><a href="classmColor.html">mColor</a></div><div class="ttdoc">Utility class for manipulating RGBA mColors.</div><div class="ttdef"><b>Definition:</b> <a href="Color_8hpp_source.html#l00011">Color.hpp:11</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath">
Expand Down
28 changes: 18 additions & 10 deletions docs/html/Circle_8hpp_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">svg-reader
&#160;<span id="projectnumber">0.1</span>
&#160;<span id="projectnumber">0.2</span>
</div>
<div id="projectbrief">Parse and render SVG files, handle user interactions.</div>
</td>
Expand Down Expand Up @@ -126,17 +126,25 @@
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160; </div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="preprocessor">#include &quot;Ellipse.hpp&quot;</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160; </div>
<div class="line"><a name="l00013"></a><span class="lineno"><a class="line" href="classCircle.html"> 13</a></span>&#160;<span class="keyword">class </span><a class="code" href="classCircle.html">Circle</a> : <span class="keyword">public</span> <a class="code" href="classEllipse.html">Ellipse</a> {</div>
<div class="line"><a name="l00013"></a><span class="lineno"><a class="line" href="classCircle.html"> 13</a></span>&#160;<span class="keyword">class </span><a class="code" href="classCircle.html">Circle</a> : <span class="keyword">public</span> <a class="code" href="classEll.html">Ell</a> {</div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; <a class="code" href="classCircle.html#ad89ead8bfb9ca432d954fed00d62f325">Circle</a>(<span class="keywordtype">float</span> <a class="code" href="classEllipse.html#a5f89a170062d84b7c8b3e9e65d706ced">radius</a>, <span class="keyword">const</span> sf::Vector2f &amp;center, sf::Color fill,</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; sf::Color stroke, <span class="keywordtype">float</span> stroke_thickness);</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;};</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; </div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="preprocessor">#endif </span><span class="comment">// CIRCLE_HPP_</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; <a class="code" href="classCircle.html#a5d018c51bfa1fa3d1081e3deef5eddc0">Circle</a>(<span class="keywordtype">float</span> <a class="code" href="classEll.html#af57a48abe0e2bc8806e73dfa7762388f">radius</a>, <span class="keyword">const</span> <a class="code" href="classVector2D.html">Vector2Df</a> &amp;center, <a class="code" href="classmColor.html">mColor</a> <a class="code" href="classSVGElement.html#a6d3a39e763d3273715ea11f8959f81b1">fill</a>, <a class="code" href="classmColor.html">mColor</a> <a class="code" href="classSVGElement.html#aab937dcb566cd83d94d00d69b4083f13">stroke</a>,</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; <span class="keywordtype">float</span> <a class="code" href="classSVGElement.html#a88449b487a890e3765ae20e96ee95c06">stroke_width</a>);</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; </div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; std::string <a class="code" href="classCircle.html#a09523e46318092d42a5969a1da5613bb">getClass</a>() <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;};</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; </div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<span class="preprocessor">#endif </span><span class="comment">// CIRCLE_HPP_</span></div>
<div class="ttc" id="aclassCircle_html"><div class="ttname"><a href="classCircle.html">Circle</a></div><div class="ttdoc">Represents a circle in 2D space.</div><div class="ttdef"><b>Definition:</b> <a href="Circle_8hpp_source.html#l00013">Circle.hpp:13</a></div></div>
<div class="ttc" id="aclassCircle_html_ad89ead8bfb9ca432d954fed00d62f325"><div class="ttname"><a href="classCircle.html#ad89ead8bfb9ca432d954fed00d62f325">Circle::Circle</a></div><div class="ttdeci">Circle(float radius, const sf::Vector2f &amp;center, sf::Color fill, sf::Color stroke, float stroke_thickness)</div><div class="ttdoc">Constructs a Circle object.</div><div class="ttdef"><b>Definition:</b> <a href="Circle_8cpp_source.html#l00003">Circle.cpp:3</a></div></div>
<div class="ttc" id="aclassEllipse_html"><div class="ttname"><a href="classEllipse.html">Ellipse</a></div><div class="ttdoc">Represents an ellipse in 2D space.</div><div class="ttdef"><b>Definition:</b> <a href="Ellipse_8hpp_source.html#l00012">Ellipse.hpp:12</a></div></div>
<div class="ttc" id="aclassEllipse_html_a5f89a170062d84b7c8b3e9e65d706ced"><div class="ttname"><a href="classEllipse.html#a5f89a170062d84b7c8b3e9e65d706ced">Ellipse::radius</a></div><div class="ttdeci">sf::Vector2f radius</div><div class="ttdoc">Radii of the ellipse in the x and y directions.</div><div class="ttdef"><b>Definition:</b> <a href="Ellipse_8hpp_source.html#l00016">Ellipse.hpp:16</a></div></div>
<div class="ttc" id="aclassCircle_html_a09523e46318092d42a5969a1da5613bb"><div class="ttname"><a href="classCircle.html#a09523e46318092d42a5969a1da5613bb">Circle::getClass</a></div><div class="ttdeci">std::string getClass() const override</div><div class="ttdoc">Gets the type of the shape.</div><div class="ttdef"><b>Definition:</b> <a href="Circle_8cpp_source.html#l00007">Circle.cpp:7</a></div></div>
<div class="ttc" id="aclassCircle_html_a5d018c51bfa1fa3d1081e3deef5eddc0"><div class="ttname"><a href="classCircle.html#a5d018c51bfa1fa3d1081e3deef5eddc0">Circle::Circle</a></div><div class="ttdeci">Circle(float radius, const Vector2Df &amp;center, mColor fill, mColor stroke, float stroke_width)</div><div class="ttdoc">Constructs a Circle object.</div><div class="ttdef"><b>Definition:</b> <a href="Circle_8cpp_source.html#l00003">Circle.cpp:3</a></div></div>
<div class="ttc" id="aclassEll_html"><div class="ttname"><a href="classEll.html">Ell</a></div><div class="ttdoc">Represents an ellipse in 2D space.</div><div class="ttdef"><b>Definition:</b> <a href="Ellipse_8hpp_source.html#l00012">Ellipse.hpp:12</a></div></div>
<div class="ttc" id="aclassEll_html_af57a48abe0e2bc8806e73dfa7762388f"><div class="ttname"><a href="classEll.html#af57a48abe0e2bc8806e73dfa7762388f">Ell::radius</a></div><div class="ttdeci">Vector2Df radius</div><div class="ttdoc">Radii of the ellipse in the x and y directions.</div><div class="ttdef"><b>Definition:</b> <a href="Ellipse_8hpp_source.html#l00014">Ellipse.hpp:14</a></div></div>
<div class="ttc" id="aclassSVGElement_html_a6d3a39e763d3273715ea11f8959f81b1"><div class="ttname"><a href="classSVGElement.html#a6d3a39e763d3273715ea11f8959f81b1">SVGElement::fill</a></div><div class="ttdeci">mColor fill</div><div class="ttdoc">Fill color.</div><div class="ttdef"><b>Definition:</b> <a href="SVGElement_8hpp_source.html#l00169">SVGElement.hpp:169</a></div></div>
<div class="ttc" id="aclassSVGElement_html_a88449b487a890e3765ae20e96ee95c06"><div class="ttname"><a href="classSVGElement.html#a88449b487a890e3765ae20e96ee95c06">SVGElement::stroke_width</a></div><div class="ttdeci">float stroke_width</div><div class="ttdoc">Thickness of the shape's outline.</div><div class="ttdef"><b>Definition:</b> <a href="SVGElement_8hpp_source.html#l00171">SVGElement.hpp:171</a></div></div>
<div class="ttc" id="aclassSVGElement_html_aab937dcb566cd83d94d00d69b4083f13"><div class="ttname"><a href="classSVGElement.html#aab937dcb566cd83d94d00d69b4083f13">SVGElement::stroke</a></div><div class="ttdeci">mColor stroke</div><div class="ttdoc">Outline color.</div><div class="ttdef"><b>Definition:</b> <a href="SVGElement_8hpp_source.html#l00170">SVGElement.hpp:170</a></div></div>
<div class="ttc" id="aclassVector2D_html"><div class="ttname"><a href="classVector2D.html">Vector2D&lt; float &gt;</a></div></div>
<div class="ttc" id="aclassmColor_html"><div class="ttname"><a href="classmColor.html">mColor</a></div><div class="ttdoc">Utility class for manipulating RGBA mColors.</div><div class="ttdef"><b>Definition:</b> <a href="Color_8hpp_source.html#l00011">Color.hpp:11</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath">
Expand Down
Loading

0 comments on commit 51a7f67

Please sign in to comment.