Skip to content

Commit 8e74afe

Browse files
Documentation Update (#38)
* Updated Doxygen Documentation * [CodeFactor] Apply fixes to commit f2accb3 Co-authored-by: codefactor-io <support@codefactor.io>
1 parent 60eb076 commit 8e74afe

149 files changed

Lines changed: 5901 additions & 2244 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/html/annotated.html

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
<td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
2424
<td id="projectalign" style="padding-left: 0.5em;">
2525
<div id="projectname">CXXGraph
26-
&#160;<span id="projectnumber">0.1.3</span>
26+
&#160;<span id="projectnumber">0.1.4</span>
2727
</div>
2828
<div id="projectbrief">CXXGraph is a small library, header only, that manages the Graph and it&#39;s algorithm in C++</div>
2929
</td>
@@ -77,11 +77,16 @@
7777
<tr id="row_0_3_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="df/d71/classCXXGRAPH_1_1UndirectedEdge.html" target="_self">UndirectedEdge</a></td><td class="desc"></td></tr>
7878
<tr id="row_0_4_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="da/d55/classCXXGRAPH_1_1DirectedWeightedEdge.html" target="_self">DirectedWeightedEdge</a></td><td class="desc"></td></tr>
7979
<tr id="row_0_5_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="d7/d24/classCXXGRAPH_1_1UndirectedWeightedEdge.html" target="_self">UndirectedWeightedEdge</a></td><td class="desc"></td></tr>
80-
<tr id="row_0_6_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="d0/df2/classCXXGRAPH_1_1Graph.html" target="_self">Graph</a></td><td class="desc"></td></tr>
80+
<tr id="row_0_6_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="d0/df2/classCXXGRAPH_1_1Graph.html" target="_self">Graph</a></td><td class="desc">Class that implement the <a class="el" href="d0/df2/classCXXGRAPH_1_1Graph.html" title="Class that implement the Graph. ( This class is not Thread Safe )">Graph</a>. ( This class is not Thread Safe ) </td></tr>
8181
<tr id="row_0_7_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="d4/d32/classCXXGRAPH_1_1Partition.html" target="_self">Partition</a></td><td class="desc"></td></tr>
82-
<tr id="row_0_8_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="dd/d6c/structCXXGRAPH_1_1DijkstraResult__struct.html" target="_self">DijkstraResult_struct</a></td><td class="desc">Struct that contains the information about Dijsktra's Algorithm results </td></tr>
83-
<tr id="row_0_9_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="d2/def/structCXXGRAPH_1_1PartitioningStats__struct.html" target="_self">PartitioningStats_struct</a></td><td class="desc">Struct that contains the information about the partitioning statistics </td></tr>
84-
<tr id="row_0_10_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="db/d54/classCXXGRAPH_1_1Weighted.html" target="_self">Weighted</a></td><td class="desc"></td></tr>
82+
<tr id="row_0_8_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="d7/dde/classCXXGRAPH_1_1Writer.html" target="_self">Writer</a></td><td class="desc"></td></tr>
83+
<tr id="row_0_9_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="d2/d3f/classCXXGRAPH_1_1Reader.html" target="_self">Reader</a></td><td class="desc"></td></tr>
84+
<tr id="row_0_10_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="dd/d6c/structCXXGRAPH_1_1DijkstraResult__struct.html" target="_self">DijkstraResult_struct</a></td><td class="desc">Struct that contains the information about Dijsktra's Algorithm results </td></tr>
85+
<tr id="row_0_11_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="d5/d93/structCXXGRAPH_1_1DialResult__struct.html" target="_self">DialResult_struct</a></td><td class="desc">Struct that contains the information about Dijsktra's Algorithm results </td></tr>
86+
<tr id="row_0_12_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="d2/def/structCXXGRAPH_1_1PartitioningStats__struct.html" target="_self">PartitioningStats_struct</a></td><td class="desc">Struct that contains the information about the partitioning statistics </td></tr>
87+
<tr id="row_0_13_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="db/d54/classCXXGRAPH_1_1Weighted.html" target="_self">Weighted</a></td><td class="desc"></td></tr>
88+
<tr id="row_0_14_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="d9/d2f/classCXXGRAPH_1_1ThreadSafe.html" target="_self">ThreadSafe</a></td><td class="desc"></td></tr>
89+
<tr id="row_0_15_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="da/da5/classCXXGRAPH_1_1Graph__TS.html" target="_self">Graph_TS</a></td><td class="desc">Class that implement the Thread Safe <a class="el" href="d0/df2/classCXXGRAPH_1_1Graph.html" title="Class that implement the Graph. ( This class is not Thread Safe )">Graph</a> </td></tr>
8590
</table>
8691
</div><!-- directory -->
8792
</div><!-- contents -->

docs/html/classes.html

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
<td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
2424
<td id="projectalign" style="padding-left: 0.5em;">
2525
<div id="projectname">CXXGraph
26-
&#160;<span id="projectnumber">0.1.3</span>
26+
&#160;<span id="projectnumber">0.1.4</span>
2727
</div>
2828
<div id="projectbrief">CXXGraph is a small library, header only, that manages the Graph and it&#39;s algorithm in C++</div>
2929
</td>
@@ -68,29 +68,35 @@
6868
<div class="title">Class Index</div> </div>
6969
</div><!--header-->
7070
<div class="contents">
71-
<div class="qindex"><a class="qindex" href="#letter_D">D</a>&#160;|&#160;<a class="qindex" href="#letter_E">E</a>&#160;|&#160;<a class="qindex" href="#letter_G">G</a>&#160;|&#160;<a class="qindex" href="#letter_N">N</a>&#160;|&#160;<a class="qindex" href="#letter_P">P</a>&#160;|&#160;<a class="qindex" href="#letter_U">U</a>&#160;|&#160;<a class="qindex" href="#letter_W">W</a></div>
71+
<div class="qindex"><a class="qindex" href="#letter_D">D</a>&#160;|&#160;<a class="qindex" href="#letter_E">E</a>&#160;|&#160;<a class="qindex" href="#letter_G">G</a>&#160;|&#160;<a class="qindex" href="#letter_N">N</a>&#160;|&#160;<a class="qindex" href="#letter_P">P</a>&#160;|&#160;<a class="qindex" href="#letter_R">R</a>&#160;|&#160;<a class="qindex" href="#letter_T">T</a>&#160;|&#160;<a class="qindex" href="#letter_U">U</a>&#160;|&#160;<a class="qindex" href="#letter_W">W</a></div>
7272
<div class="classindex">
7373
<dl class="classindex even">
7474
<dt class="alphachar"><a name="letter_D">D</a></dt>
75-
<dd><a class="el" href="dd/d6c/structCXXGRAPH_1_1DijkstraResult__struct.html">DijkstraResult_struct</a> (CXXGRAPH)</dd><dd><a class="el" href="de/df5/classCXXGRAPH_1_1DirectedEdge.html">DirectedEdge</a> (CXXGRAPH)</dd><dd><a class="el" href="da/d55/classCXXGRAPH_1_1DirectedWeightedEdge.html">DirectedWeightedEdge</a> (CXXGRAPH)</dd></dl>
75+
<dd><a class="el" href="d5/d93/structCXXGRAPH_1_1DialResult__struct.html">DialResult_struct</a> (CXXGRAPH)</dd><dd><a class="el" href="dd/d6c/structCXXGRAPH_1_1DijkstraResult__struct.html">DijkstraResult_struct</a> (CXXGRAPH)</dd><dd><a class="el" href="de/df5/classCXXGRAPH_1_1DirectedEdge.html">DirectedEdge</a> (CXXGRAPH)</dd><dd><a class="el" href="da/d55/classCXXGRAPH_1_1DirectedWeightedEdge.html">DirectedWeightedEdge</a> (CXXGRAPH)</dd></dl>
7676
<dl class="classindex odd">
7777
<dt class="alphachar"><a name="letter_E">E</a></dt>
7878
<dd><a class="el" href="d7/d2a/classCXXGRAPH_1_1Edge.html">Edge</a> (CXXGRAPH)</dd></dl>
7979
<dl class="classindex even">
8080
<dt class="alphachar"><a name="letter_G">G</a></dt>
81-
<dd><a class="el" href="d0/df2/classCXXGRAPH_1_1Graph.html">Graph</a> (CXXGRAPH)</dd></dl>
81+
<dd><a class="el" href="d0/df2/classCXXGRAPH_1_1Graph.html">Graph</a> (CXXGRAPH)</dd><dd><a class="el" href="da/da5/classCXXGRAPH_1_1Graph__TS.html">Graph_TS</a> (CXXGRAPH)</dd></dl>
8282
<dl class="classindex odd">
8383
<dt class="alphachar"><a name="letter_N">N</a></dt>
8484
<dd><a class="el" href="d3/dd2/classCXXGRAPH_1_1Node.html">Node</a> (CXXGRAPH)</dd></dl>
8585
<dl class="classindex even">
8686
<dt class="alphachar"><a name="letter_P">P</a></dt>
8787
<dd><a class="el" href="d4/d32/classCXXGRAPH_1_1Partition.html">Partition</a> (CXXGRAPH)</dd><dd><a class="el" href="d2/def/structCXXGRAPH_1_1PartitioningStats__struct.html">PartitioningStats_struct</a> (CXXGRAPH)</dd></dl>
8888
<dl class="classindex odd">
89+
<dt class="alphachar"><a name="letter_R">R</a></dt>
90+
<dd><a class="el" href="d2/d3f/classCXXGRAPH_1_1Reader.html">Reader</a> (CXXGRAPH)</dd></dl>
91+
<dl class="classindex even">
92+
<dt class="alphachar"><a name="letter_T">T</a></dt>
93+
<dd><a class="el" href="d9/d2f/classCXXGRAPH_1_1ThreadSafe.html">ThreadSafe</a> (CXXGRAPH)</dd></dl>
94+
<dl class="classindex odd">
8995
<dt class="alphachar"><a name="letter_U">U</a></dt>
9096
<dd><a class="el" href="df/d71/classCXXGRAPH_1_1UndirectedEdge.html">UndirectedEdge</a> (CXXGRAPH)</dd><dd><a class="el" href="d7/d24/classCXXGRAPH_1_1UndirectedWeightedEdge.html">UndirectedWeightedEdge</a> (CXXGRAPH)</dd></dl>
9197
<dl class="classindex even">
9298
<dt class="alphachar"><a name="letter_W">W</a></dt>
93-
<dd><a class="el" href="db/d54/classCXXGRAPH_1_1Weighted.html">Weighted</a> (CXXGRAPH)</dd></dl>
99+
<dd><a class="el" href="db/d54/classCXXGRAPH_1_1Weighted.html">Weighted</a> (CXXGRAPH)</dd><dd><a class="el" href="d7/dde/classCXXGRAPH_1_1Writer.html">Writer</a> (CXXGRAPH)</dd></dl>
94100
</div>
95101
</div><!-- contents -->
96102
<!-- start footer part -->
Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2+
<html xmlns="http://www.w3.org/1999/xhtml">
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5+
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6+
<meta name="generator" content="Doxygen 1.9.1"/>
7+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8+
<title>CXXGraph: Member List</title>
9+
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
10+
<script type="text/javascript" src="../../jquery.js"></script>
11+
<script type="text/javascript" src="../../dynsections.js"></script>
12+
<link href="../../search/search.css" rel="stylesheet" type="text/css"/>
13+
<script type="text/javascript" src="../../search/searchdata.js"></script>
14+
<script type="text/javascript" src="../../search/search.js"></script>
15+
<link href="../../doxygen.css" rel="stylesheet" type="text/css" />
16+
</head>
17+
<body>
18+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
19+
<div id="titlearea">
20+
<table cellspacing="0" cellpadding="0">
21+
<tbody>
22+
<tr style="height: 56px;">
23+
<td id="projectlogo"><img alt="Logo" src="../../logo.png"/></td>
24+
<td id="projectalign" style="padding-left: 0.5em;">
25+
<div id="projectname">CXXGraph
26+
&#160;<span id="projectnumber">0.1.4</span>
27+
</div>
28+
<div id="projectbrief">CXXGraph is a small library, header only, that manages the Graph and it&#39;s algorithm in C++</div>
29+
</td>
30+
</tr>
31+
</tbody>
32+
</table>
33+
</div>
34+
<!-- end header part -->
35+
<!-- Generated by Doxygen 1.9.1 -->
36+
<script type="text/javascript">
37+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
38+
var searchBox = new SearchBox("searchBox", "../../search",false,'Search','.html');
39+
/* @license-end */
40+
</script>
41+
<script type="text/javascript" src="../../menudata.js"></script>
42+
<script type="text/javascript" src="../../menu.js"></script>
43+
<script type="text/javascript">
44+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
45+
$(function() {
46+
initMenu('../../',true,false,'search.php','Search');
47+
$(document).ready(function() { init_search(); });
48+
});
49+
/* @license-end */</script>
50+
<div id="main-nav"></div>
51+
<!-- window showing the filter options -->
52+
<div id="MSearchSelectWindow"
53+
onmouseover="return searchBox.OnSearchSelectShow()"
54+
onmouseout="return searchBox.OnSearchSelectHide()"
55+
onkeydown="return searchBox.OnSearchSelectKey(event)">
56+
</div>
57+
58+
<!-- iframe showing the search results (closed by default) -->
59+
<div id="MSearchResultsWindow">
60+
<iframe src="javascript:void(0)" frameborder="0"
61+
name="MSearchResults" id="MSearchResults">
62+
</iframe>
63+
</div>
64+
65+
<div id="nav-path" class="navpath">
66+
<ul>
67+
<li class="navelem"><b>CXXGRAPH</b></li><li class="navelem"><a class="el" href="../../d7/dde/classCXXGRAPH_1_1Writer.html">Writer</a></li> </ul>
68+
</div>
69+
</div><!-- top -->
70+
<div class="header">
71+
<div class="headertitle">
72+
<div class="title">CXXGRAPH::Writer&lt; T &gt; Member List</div> </div>
73+
</div><!--header-->
74+
<div class="contents">
75+
76+
<p>This is the complete list of members for <a class="el" href="../../d7/dde/classCXXGRAPH_1_1Writer.html">CXXGRAPH::Writer&lt; T &gt;</a>, including all inherited members.</p>
77+
<table class="directory">
78+
<tr class="even"><td class="entry"><a class="el" href="../../d7/dde/classCXXGRAPH_1_1Writer.html#aee299d7e7dbda1ca99c35b9f2d92149c">writeGraph</a>(const Graph&lt; T &gt; &amp;graph, std::ofstream &amp;file)=0</td><td class="entry"><a class="el" href="../../d7/dde/classCXXGRAPH_1_1Writer.html">CXXGRAPH::Writer&lt; T &gt;</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr>
79+
</table></div><!-- contents -->
80+
<!-- start footer part -->
81+
<hr class="footer"/><address class="footer"><small>
82+
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="../../doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
83+
</small></address>
84+
</body>
85+
</html>
Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2+
<html xmlns="http://www.w3.org/1999/xhtml">
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5+
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6+
<meta name="generator" content="Doxygen 1.9.1"/>
7+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8+
<title>CXXGraph: Member List</title>
9+
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
10+
<script type="text/javascript" src="../../jquery.js"></script>
11+
<script type="text/javascript" src="../../dynsections.js"></script>
12+
<link href="../../search/search.css" rel="stylesheet" type="text/css"/>
13+
<script type="text/javascript" src="../../search/searchdata.js"></script>
14+
<script type="text/javascript" src="../../search/search.js"></script>
15+
<link href="../../doxygen.css" rel="stylesheet" type="text/css" />
16+
</head>
17+
<body>
18+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
19+
<div id="titlearea">
20+
<table cellspacing="0" cellpadding="0">
21+
<tbody>
22+
<tr style="height: 56px;">
23+
<td id="projectlogo"><img alt="Logo" src="../../logo.png"/></td>
24+
<td id="projectalign" style="padding-left: 0.5em;">
25+
<div id="projectname">CXXGraph
26+
&#160;<span id="projectnumber">0.1.4</span>
27+
</div>
28+
<div id="projectbrief">CXXGraph is a small library, header only, that manages the Graph and it&#39;s algorithm in C++</div>
29+
</td>
30+
</tr>
31+
</tbody>
32+
</table>
33+
</div>
34+
<!-- end header part -->
35+
<!-- Generated by Doxygen 1.9.1 -->
36+
<script type="text/javascript">
37+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
38+
var searchBox = new SearchBox("searchBox", "../../search",false,'Search','.html');
39+
/* @license-end */
40+
</script>
41+
<script type="text/javascript" src="../../menudata.js"></script>
42+
<script type="text/javascript" src="../../menu.js"></script>
43+
<script type="text/javascript">
44+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
45+
$(function() {
46+
initMenu('../../',true,false,'search.php','Search');
47+
$(document).ready(function() { init_search(); });
48+
});
49+
/* @license-end */</script>
50+
<div id="main-nav"></div>
51+
<!-- window showing the filter options -->
52+
<div id="MSearchSelectWindow"
53+
onmouseover="return searchBox.OnSearchSelectShow()"
54+
onmouseout="return searchBox.OnSearchSelectHide()"
55+
onkeydown="return searchBox.OnSearchSelectKey(event)">
56+
</div>
57+
58+
<!-- iframe showing the search results (closed by default) -->
59+
<div id="MSearchResultsWindow">
60+
<iframe src="javascript:void(0)" frameborder="0"
61+
name="MSearchResults" id="MSearchResults">
62+
</iframe>
63+
</div>
64+
65+
<div id="nav-path" class="navpath">
66+
<ul>
67+
<li class="navelem"><b>CXXGRAPH</b></li><li class="navelem"><a class="el" href="../../d2/d3f/classCXXGRAPH_1_1Reader.html">Reader</a></li> </ul>
68+
</div>
69+
</div><!-- top -->
70+
<div class="header">
71+
<div class="headertitle">
72+
<div class="title">CXXGRAPH::Reader&lt; T &gt; Member List</div> </div>
73+
</div><!--header-->
74+
<div class="contents">
75+
76+
<p>This is the complete list of members for <a class="el" href="../../d2/d3f/classCXXGRAPH_1_1Reader.html">CXXGRAPH::Reader&lt; T &gt;</a>, including all inherited members.</p>
77+
</div><!-- contents -->
78+
<!-- start footer part -->
79+
<hr class="footer"/><address class="footer"><small>
80+
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="../../doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
81+
</small></address>
82+
</body>
83+
</html>

0 commit comments

Comments
 (0)