Skip to content

Commit

Permalink
Updated Doxygen Documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@ZigRazor
ZigRazor committed Sep 9, 2021
1 parent 76756cc commit 0527010
Show file tree
Hide file tree
Showing 247 changed files with 10,701 additions and 2,919 deletions.
45 changes: 28 additions & 17 deletions docs/html/annotated.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -69,24 +69,35 @@
</div><!--header-->
<div class="contents">
<div class="textblock">Here are the classes, structs, unions and interfaces with brief descriptions:</div><div class="directory">
<div class="levels">[detail level <span onclick="javascript:toggleLevel(1);">1</span><span onclick="javascript:toggleLevel(2);">2</span>]</div><table class="directory">
<div class="levels">[detail level <span onclick="javascript:toggleLevel(1);">1</span><span onclick="javascript:toggleLevel(2);">2</span><span onclick="javascript:toggleLevel(3);">3</span>]</div><table class="directory">
<tr id="row_0_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_0_" class="arrow" onclick="toggleFolder('0_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><b>CXXGRAPH</b></td><td class="desc"></td></tr>
<tr id="row_0_0_"><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="d3/dd2/classCXXGRAPH_1_1Node.html" target="_self">Node</a></td><td class="desc"></td></tr>
<tr id="row_0_1_" 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/d2a/classCXXGRAPH_1_1Edge.html" target="_self">Edge</a></td><td class="desc"></td></tr>
<tr id="row_0_2_"><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="de/df5/classCXXGRAPH_1_1DirectedEdge.html" target="_self">DirectedEdge</a></td><td class="desc"></td></tr>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<tr id="row_0_0_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_0_0_" class="arrow" onclick="toggleFolder('0_0_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><b>PARTITIONING</b></td><td class="desc"></td></tr>
<tr id="row_0_0_0_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="de/d59/classCXXGRAPH_1_1PARTITIONING_1_1Partition.html" target="_self">Partition</a></td><td class="desc"></td></tr>
<tr id="row_0_0_1_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="d0/d70/classCXXGRAPH_1_1PARTITIONING_1_1CoordinatedPartitionState.html" target="_self">CoordinatedPartitionState</a></td><td class="desc"></td></tr>
<tr id="row_0_0_2_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="de/d1d/classCXXGRAPH_1_1PARTITIONING_1_1CoordinatedRecord.html" target="_self">CoordinatedRecord</a></td><td class="desc"></td></tr>
<tr id="row_0_0_3_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="d1/d63/classCXXGRAPH_1_1PARTITIONING_1_1HDRF.html" target="_self">HDRF</a></td><td class="desc"></td></tr>
<tr id="row_0_0_4_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="d8/d6d/classCXXGRAPH_1_1PARTITIONING_1_1Partitioner.html" target="_self">Partitioner</a></td><td class="desc"></td></tr>
<tr id="row_0_0_5_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="d7/d1b/classCXXGRAPH_1_1PARTITIONING_1_1PartitionerThread.html" target="_self">PartitionerThread</a></td><td class="desc"></td></tr>
<tr id="row_0_0_6_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="da/d71/classCXXGRAPH_1_1PARTITIONING_1_1PartitioningStats.html" target="_self">PartitioningStats</a></td><td class="desc"></td></tr>
<tr id="row_0_0_7_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="df/d6f/classCXXGRAPH_1_1PARTITIONING_1_1PartitionState.html" target="_self">PartitionState</a></td><td class="desc"></td></tr>
<tr id="row_0_0_8_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="de/deb/classCXXGRAPH_1_1PARTITIONING_1_1PartitionStrategy.html" target="_self">PartitionStrategy</a></td><td class="desc"></td></tr>
<tr id="row_0_0_9_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="d3/de1/classCXXGRAPH_1_1PARTITIONING_1_1Record.html" target="_self">Record</a></td><td class="desc"></td></tr>
<tr id="row_0_0_10_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="db/d5b/classCXXGRAPH_1_1PARTITIONING_1_1Globals.html" target="_self">Globals</a></td><td class="desc"></td></tr>
<tr id="row_0_1_"><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>
<tr id="row_0_2_" 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="de/df5/classCXXGRAPH_1_1DirectedEdge.html" target="_self">DirectedEdge</a></td><td class="desc"></td></tr>
<tr id="row_0_3_"><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>
<tr id="row_0_4_" 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/d55/classCXXGRAPH_1_1DirectedWeightedEdge.html" target="_self">DirectedWeightedEdge</a></td><td class="desc"></td></tr>
<tr id="row_0_5_"><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/d2a/classCXXGRAPH_1_1Edge.html" target="_self">Edge</a></td><td class="desc"></td></tr>
<tr id="row_0_6_" 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>
<tr id="row_0_7_"><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>
<tr id="row_0_8_" 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>
<tr id="row_0_9_"><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="d3/dd2/classCXXGRAPH_1_1Node.html" target="_self">Node</a></td><td class="desc"></td></tr>
<tr id="row_0_10_" 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>
<tr id="row_0_11_"><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/d2e/classCXXGRAPH_1_1Runnable.html" target="_self">Runnable</a></td><td class="desc"></td></tr>
<tr id="row_0_12_" 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="d9/d2f/classCXXGRAPH_1_1ThreadSafe.html" target="_self">ThreadSafe</a></td><td class="desc"></td></tr>
<tr id="row_0_13_"><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>
<tr id="row_0_14_" 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>
<tr id="row_0_15_"><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>
</table>
</div><!-- directory -->
</div><!-- contents -->
Expand Down
18 changes: 12 additions & 6 deletions docs/html/classes.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -68,26 +68,32 @@
<div class="title">Class Index</div> </div>
</div><!--header-->
<div class="contents">
<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>
<div class="qindex"><a class="qindex" href="#letter_C">C</a>&#160;|&#160;<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_H">H</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>
<div class="classindex">
<dl class="classindex even">
<dt class="alphachar"><a name="letter_C">C</a></dt>
<dd><a class="el" href="d0/d70/classCXXGRAPH_1_1PARTITIONING_1_1CoordinatedPartitionState.html">CoordinatedPartitionState</a> (CXXGRAPH::PARTITIONING)</dd><dd><a class="el" href="de/d1d/classCXXGRAPH_1_1PARTITIONING_1_1CoordinatedRecord.html">CoordinatedRecord</a> (CXXGRAPH::PARTITIONING)</dd></dl>
<dl class="classindex odd">
<dt class="alphachar"><a name="letter_D">D</a></dt>
<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>
<dl class="classindex odd">
<dl class="classindex even">
<dt class="alphachar"><a name="letter_E">E</a></dt>
<dd><a class="el" href="d7/d2a/classCXXGRAPH_1_1Edge.html">Edge</a> (CXXGRAPH)</dd></dl>
<dl class="classindex even">
<dl class="classindex odd">
<dt class="alphachar"><a name="letter_G">G</a></dt>
<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>
<dd><a class="el" href="db/d5b/classCXXGRAPH_1_1PARTITIONING_1_1Globals.html">Globals</a> (CXXGRAPH::PARTITIONING)</dd><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>
<dl class="classindex even">
<dt class="alphachar"><a name="letter_H">H</a></dt>
<dd><a class="el" href="d1/d63/classCXXGRAPH_1_1PARTITIONING_1_1HDRF.html">HDRF</a> (CXXGRAPH::PARTITIONING)</dd></dl>
<dl class="classindex odd">
<dt class="alphachar"><a name="letter_N">N</a></dt>
<dd><a class="el" href="d3/dd2/classCXXGRAPH_1_1Node.html">Node</a> (CXXGRAPH)</dd></dl>
<dl class="classindex even">
<dt class="alphachar"><a name="letter_P">P</a></dt>
<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>
<dd><a class="el" href="de/d59/classCXXGRAPH_1_1PARTITIONING_1_1Partition.html">Partition</a> (CXXGRAPH::PARTITIONING)</dd><dd><a class="el" href="d8/d6d/classCXXGRAPH_1_1PARTITIONING_1_1Partitioner.html">Partitioner</a> (CXXGRAPH::PARTITIONING)</dd><dd><a class="el" href="d7/d1b/classCXXGRAPH_1_1PARTITIONING_1_1PartitionerThread.html">PartitionerThread</a> (CXXGRAPH::PARTITIONING)</dd><dd><a class="el" href="da/d71/classCXXGRAPH_1_1PARTITIONING_1_1PartitioningStats.html">PartitioningStats</a> (CXXGRAPH::PARTITIONING)</dd><dd><a class="el" href="df/d6f/classCXXGRAPH_1_1PARTITIONING_1_1PartitionState.html">PartitionState</a> (CXXGRAPH::PARTITIONING)</dd><dd><a class="el" href="de/deb/classCXXGRAPH_1_1PARTITIONING_1_1PartitionStrategy.html">PartitionStrategy</a> (CXXGRAPH::PARTITIONING)</dd></dl>
<dl class="classindex odd">
<dt class="alphachar"><a name="letter_R">R</a></dt>
<dd><a class="el" href="d2/d3f/classCXXGRAPH_1_1Reader.html">Reader</a> (CXXGRAPH)</dd></dl>
<dd><a class="el" href="d2/d3f/classCXXGRAPH_1_1Reader.html">Reader</a> (CXXGRAPH)</dd><dd><a class="el" href="d3/de1/classCXXGRAPH_1_1PARTITIONING_1_1Record.html">Record</a> (CXXGRAPH::PARTITIONING)</dd><dd><a class="el" href="d5/d2e/classCXXGRAPH_1_1Runnable.html">Runnable</a> (CXXGRAPH)</dd></dl>
<dl class="classindex even">
<dt class="alphachar"><a name="letter_T">T</a></dt>
<dd><a class="el" href="d9/d2f/classCXXGRAPH_1_1ThreadSafe.html">ThreadSafe</a> (CXXGRAPH)</dd></dl>
Expand Down
4 changes: 4 additions & 0 deletions ...tml/d0/d69/classCXXGRAPH_1_1PARTITIONING_1_1CoordinatedPartitionState__inherit__graph.map
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
<map id="CXXGRAPH::PARTITIONING::CoordinatedPartitionState&lt; T &gt;" name="CXXGRAPH::PARTITIONING::CoordinatedPartitionState&lt; T &gt;">
<area shape="rect" id="node1" title=" " alt="" coords="5,95,212,136"/>
<area shape="rect" id="node2" href="$df/d6f/classCXXGRAPH_1_1PARTITIONING_1_1PartitionState.html" title=" " alt="" coords="10,5,207,47"/>
</map>
1 change: 1 addition & 0 deletions ...tml/d0/d69/classCXXGRAPH_1_1PARTITIONING_1_1CoordinatedPartitionState__inherit__graph.md5
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
7b2859755e79dd0c86a1a9919e3e96cc
Binary file added .../classCXXGRAPH_1_1PARTITIONING_1_1CoordinatedPartitionState__inherit__graph.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 0527010

Please sign in to comment.