Documentation Update (#50)

* Updated Doxygen Documentation

* [CodeFactor] Apply fixes to commit 68749f0

Co-authored-by: codefactor-io <support@codefactor.io>

Author: ZigRazor

docs/html/annotated.html

@@ -23,9 +23,9 @@
   <td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">CXXGraph
-   &#160;<span id="projectnumber">0.1.5</span>
+   &#160;<span id="projectnumber">0.1.6</span>
    </div>
-   <div id="projectbrief">CXXGraph is a small library, header only, that manages the Graph and it&#39;s algorithm in C++</div>
+   <div id="projectbrief">CXXGraph is a header only, that manages the Graphs and it&#39;s algorithm in C++</div>
   </td>
  </tr>
  </tbody>

docs/html/classes.html

@@ -23,9 +23,9 @@
   <td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">CXXGraph
-   &#160;<span id="projectnumber">0.1.5</span>
+   &#160;<span id="projectnumber">0.1.6</span>
    </div>
-   <div id="projectbrief">CXXGraph is a small library, header only, that manages the Graph and it&#39;s algorithm in C++</div>
+   <div id="projectbrief">CXXGraph is a header only, that manages the Graphs and it&#39;s algorithm in C++</div>
   </td>
  </tr>
  </tbody>

docs/html/d0/d0d/classCXXGRAPH_1_1Writer-members.html

@@ -23,9 +23,9 @@
   <td id="projectlogo"><img alt="Logo" src="../../logo.png"/></td>
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">CXXGraph
-   &#160;<span id="projectnumber">0.1.5</span>
+   &#160;<span id="projectnumber">0.1.6</span>
    </div>
-   <div id="projectbrief">CXXGraph is a small library, header only, that manages the Graph and it&#39;s algorithm in C++</div>
+   <div id="projectbrief">CXXGraph is a header only, that manages the Graphs and it&#39;s algorithm in C++</div>
   </td>
  </tr>
  </tbody>

docs/html/d0/dca/classCXXGRAPH_1_1Reader-members.html

@@ -23,9 +23,9 @@
   <td id="projectlogo"><img alt="Logo" src="../../logo.png"/></td>
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">CXXGraph
-   &#160;<span id="projectnumber">0.1.5</span>
+   &#160;<span id="projectnumber">0.1.6</span>
    </div>
-   <div id="projectbrief">CXXGraph is a small library, header only, that manages the Graph and it&#39;s algorithm in C++</div>
+   <div id="projectbrief">CXXGraph is a header only, that manages the Graphs and it&#39;s algorithm in C++</div>
   </td>
  </tr>
  </tbody>

docs/html/d0/df2/classCXXGRAPH_1_1Graph.html

@@ -23,9 +23,9 @@
   <td id="projectlogo"><img alt="Logo" src="../../logo.png"/></td>
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">CXXGraph
-   &#160;<span id="projectnumber">0.1.5</span>
+   &#160;<span id="projectnumber">0.1.6</span>
    </div>
-   <div id="projectbrief">CXXGraph is a small library, header only, that manages the Graph and it&#39;s algorithm in C++</div>
+   <div id="projectbrief">CXXGraph is a header only, that manages the Graphs and it&#39;s algorithm in C++</div>
   </td>
  </tr>
  </tbody>
@@ -163,11 +163,11 @@
 <tr class="memitem:a662a0e15cd997252639e7a257b830190"><td class="memItemLeft" align="right" valign="top">virtual const <a class="el" href="../../d5/d93/structCXXGRAPH_1_1DialResult__struct.html">DialResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/df2/classCXXGRAPH_1_1Graph.html#a662a0e15cd997252639e7a257b830190">dial</a> (const <a class="el" href="../../d3/dd2/classCXXGRAPH_1_1Node.html">Node</a>&lt; T &gt; &amp;source, int maxWeight) const</td></tr>
 <tr class="memdesc:a662a0e15cd997252639e7a257b830190"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function write the graph in an output file Note: No Thread Safe.  <a href="../../d0/df2/classCXXGRAPH_1_1Graph.html#a662a0e15cd997252639e7a257b830190">More...</a><br /></td></tr>
 <tr class="separator:a662a0e15cd997252639e7a257b830190"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a5a1ffeb9ef3b62b38c10bd84b44170a0"><td class="memItemLeft" align="right" valign="top"><a id="a5a1ffeb9ef3b62b38c10bd84b44170a0"></a>
-virtual int&#160;</td><td class="memItemRight" valign="bottom"><b>writeToFile</b> (<a class="el" href="../../d0/df2/classCXXGRAPH_1_1Graph.html#af40584c5cd15ce35ad36a736b3429c71">InputOutputFormat</a> format=InputOutputFormat::STANDARD_CSV, const std::string &amp;workingDir=&quot;.&quot;, const std::string &amp;OFileName=&quot;graph&quot;, bool compress=false, bool writeNodeFeat=false, bool writeEdgeWeight=false) const</td></tr>
+<tr class="memitem:a5a1ffeb9ef3b62b38c10bd84b44170a0"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/df2/classCXXGRAPH_1_1Graph.html#a5a1ffeb9ef3b62b38c10bd84b44170a0">writeToFile</a> (<a class="el" href="../../d0/df2/classCXXGRAPH_1_1Graph.html#af40584c5cd15ce35ad36a736b3429c71">InputOutputFormat</a> format=InputOutputFormat::STANDARD_CSV, const std::string &amp;workingDir=&quot;.&quot;, const std::string &amp;OFileName=&quot;graph&quot;, bool compress=false, bool writeNodeFeat=false, bool writeEdgeWeight=false) const</td></tr>
+<tr class="memdesc:a5a1ffeb9ef3b62b38c10bd84b44170a0"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function write the graph in an output file Note: No Thread Safe.  <a href="../../d0/df2/classCXXGRAPH_1_1Graph.html#a5a1ffeb9ef3b62b38c10bd84b44170a0">More...</a><br /></td></tr>
 <tr class="separator:a5a1ffeb9ef3b62b38c10bd84b44170a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:abd5baeb88c2b588c14383155fff4ec3e"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/df2/classCXXGRAPH_1_1Graph.html#abd5baeb88c2b588c14383155fff4ec3e">readFromFile</a> (<a class="el" href="../../d0/df2/classCXXGRAPH_1_1Graph.html#af40584c5cd15ce35ad36a736b3429c71">InputOutputFormat</a> format=InputOutputFormat::STANDARD_CSV, const std::string &amp;workingDir=&quot;.&quot;, const std::string &amp;OFileName=&quot;graph&quot;, bool compress=false, bool readNodeFeat=false, bool readEdgeWeight=false)</td></tr>
-<tr class="memdesc:abd5baeb88c2b588c14383155fff4ec3e"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function write the graph in an output file Note: No Thread Safe.  <a href="../../d0/df2/classCXXGRAPH_1_1Graph.html#abd5baeb88c2b588c14383155fff4ec3e">More...</a><br /></td></tr>
+<tr class="memdesc:abd5baeb88c2b588c14383155fff4ec3e"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function read the graph from an input file Note: No Thread Safe.  <a href="../../d0/df2/classCXXGRAPH_1_1Graph.html#abd5baeb88c2b588c14383155fff4ec3e">More...</a><br /></td></tr>
 <tr class="separator:abd5baeb88c2b588c14383155fff4ec3e"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:abb1d335334b510d037729719e8f579b6"><td class="memItemLeft" align="right" valign="top">virtual PartitionMap&lt; T &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/df2/classCXXGRAPH_1_1Graph.html#abb1d335334b510d037729719e8f579b6">partitionGraph</a> (<a class="el" href="../../d0/df2/classCXXGRAPH_1_1Graph.html#a1549d3208d57a922c72d0885894f1c32">PartitionAlgorithm</a> algorithm, unsigned int numberOfPartitions) const</td></tr>
 <tr class="memdesc:abb1d335334b510d037729719e8f579b6"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function partition a graph in a set of partitions Note: No Thread Safe.  <a href="../../d0/df2/classCXXGRAPH_1_1Graph.html#abb1d335334b510d037729719e8f579b6">More...</a><br /></td></tr>
@@ -756,7 +756,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#abd5baeb88c2b588c14383155
 </table>
 </div><div class="memdoc">
 
-<p>This function write the graph in an output file Note: No Thread Safe. </p>
+<p>This function read the graph from an input file Note: No Thread Safe. </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
     <tr><td class="paramname">format</td><td>The Input format of the file </td></tr>
@@ -846,6 +846,82 @@ <h2 class="memtitle"><span class="permalink"><a href="#af2cd256d3638bf15ea926b6d
 
 <p>Reimplemented in <a class="el" href="../../da/da5/classCXXGRAPH_1_1Graph__TS.html#a2fc8067ede63880fd645206ef9a23380">CXXGRAPH::Graph_TS&lt; T &gt;</a>.</p>
 
+</div>
+</div>
+<a id="a5a1ffeb9ef3b62b38c10bd84b44170a0"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a5a1ffeb9ef3b62b38c10bd84b44170a0">&#9670;&nbsp;</a></span>writeToFile()</h2>
+
+<div class="memitem">
+<div class="memproto">
+<div class="memtemplate">
+template&lt;typename T &gt; </div>
+<table class="mlabels">
+  <tr>
+  <td class="mlabels-left">
+      <table class="memname">
+        <tr>
+          <td class="memname">int <a class="el" href="../../d0/df2/classCXXGRAPH_1_1Graph.html">CXXGRAPH::Graph</a>&lt; T &gt;::writeToFile </td>
+          <td>(</td>
+          <td class="paramtype"><a class="el" href="../../d0/df2/classCXXGRAPH_1_1Graph.html#af40584c5cd15ce35ad36a736b3429c71">InputOutputFormat</a>&#160;</td>
+          <td class="paramname"><em>format</em> = <code>InputOutputFormat::STANDARD_CSV</code>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">const std::string &amp;&#160;</td>
+          <td class="paramname"><em>workingDir</em> = <code>&quot;.&quot;</code>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">const std::string &amp;&#160;</td>
+          <td class="paramname"><em>OFileName</em> = <code>&quot;graph&quot;</code>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">bool&#160;</td>
+          <td class="paramname"><em>compress</em> = <code>false</code>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">bool&#160;</td>
+          <td class="paramname"><em>writeNodeFeat</em> = <code>false</code>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">bool&#160;</td>
+          <td class="paramname"><em>writeEdgeWeight</em> = <code>false</code>&#160;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td> const</td>
+        </tr>
+      </table>
+  </td>
+  <td class="mlabels-right">
+<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
+  </tr>
+</table>
+</div><div class="memdoc">
+
+<p>This function write the graph in an output file Note: No Thread Safe. </p>
+<dl class="params"><dt>Parameters</dt><dd>
+  <table class="params">
+    <tr><td class="paramname">format</td><td>The Output format of the file </td></tr>
+    <tr><td class="paramname">workingDir</td><td>The path to the directory in which is placed the Output file </td></tr>
+    <tr><td class="paramname">OFileName</td><td>The Output File Name ( ) </td></tr>
+    <tr><td class="paramname">compress</td><td>Indicates if the Output will be compressed ( Pay Attention if compress flag is true, not compressed files will be deleted [ #48 ] ) </td></tr>
+    <tr><td class="paramname">writeNodeFeat</td><td>Indicates if export also <a class="el" href="../../d3/dd2/classCXXGRAPH_1_1Node.html">Node</a> Features </td></tr>
+    <tr><td class="paramname">writeEdgeWeight</td><td>Indicates if export also <a class="el" href="../../d7/d2a/classCXXGRAPH_1_1Edge.html">Edge</a> Weights </td></tr>
+  </table>
+  </dd>
+</dl>
+<dl class="section return"><dt>Returns</dt><dd>0 if all OK, else return a negative value </dd></dl>
+
 </div>
 </div>
 <hr/>The documentation for this class was generated from the following file:<ul>

docs/html/d2/d3f/classCXXGRAPH_1_1Reader.html

@@ -23,9 +23,9 @@
   <td id="projectlogo"><img alt="Logo" src="../../logo.png"/></td>
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">CXXGraph
-   &#160;<span id="projectnumber">0.1.5</span>
+   &#160;<span id="projectnumber">0.1.6</span>
    </div>
-   <div id="projectbrief">CXXGraph is a small library, header only, that manages the Graph and it&#39;s algorithm in C++</div>
+   <div id="projectbrief">CXXGraph is a header only, that manages the Graphs and it&#39;s algorithm in C++</div>
   </td>
  </tr>
  </tbody>

docs/html/d2/d6c/classCXXGRAPH_1_1Graph__TS-members.html

@@ -23,9 +23,9 @@
   <td id="projectlogo"><img alt="Logo" src="../../logo.png"/></td>
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">CXXGraph
-   &#160;<span id="projectnumber">0.1.5</span>
+   &#160;<span id="projectnumber">0.1.6</span>
    </div>
-   <div id="projectbrief">CXXGraph is a small library, header only, that manages the Graph and it&#39;s algorithm in C++</div>
+   <div id="projectbrief">CXXGraph is a header only, that manages the Graphs and it&#39;s algorithm in C++</div>
   </td>
  </tr>
  </tbody>
@@ -112,8 +112,8 @@
   <tr class="even"><td class="entry"><a class="el" href="../../da/da5/classCXXGRAPH_1_1Graph__TS.html#a2fc8067ede63880fd645206ef9a23380">setEdgeSet</a>(std::list&lt; const Edge&lt; T &gt; * &gt; &amp;edgeSet) override</td><td class="entry"><a class="el" href="../../da/da5/classCXXGRAPH_1_1Graph__TS.html">CXXGRAPH::Graph_TS&lt; T &gt;</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
   <tr><td class="entry"><a class="el" href="../../d0/df2/classCXXGRAPH_1_1Graph.html#af40584c5cd15ce35ad36a736b3429c71a12e3f194ab31b8c22b5789dda8d4645c">STANDARD_CSV</a> enum value</td><td class="entry"><a class="el" href="../../d0/df2/classCXXGRAPH_1_1Graph.html">CXXGRAPH::Graph&lt; T &gt;</a></td><td class="entry"></td></tr>
   <tr class="even"><td class="entry"><a class="el" href="../../d0/df2/classCXXGRAPH_1_1Graph.html#af40584c5cd15ce35ad36a736b3429c71a28e4461e98949e163fe3ad5982065d76">STANDARD_TSV</a> enum value</td><td class="entry"><a class="el" href="../../d0/df2/classCXXGRAPH_1_1Graph.html">CXXGRAPH::Graph&lt; T &gt;</a></td><td class="entry"></td></tr>
-  <tr bgcolor="#f0f0f0"><td class="entry"><b>writeToFile</b>(typename Graph&lt; T &gt;::InputOutputFormat format=Graph&lt; T &gt;::InputOutputFormat::STANDARD_CSV, const std::string &amp;workingDir=&quot;.&quot;, const std::string &amp;OFileName=&quot;graph&quot;, bool compress=false, bool writeNodeFeat=false, bool writeEdgeWeight=false) const override (defined in <a class="el" href="../../da/da5/classCXXGRAPH_1_1Graph__TS.html">CXXGRAPH::Graph_TS&lt; T &gt;</a>)</td><td class="entry"><a class="el" href="../../da/da5/classCXXGRAPH_1_1Graph__TS.html">CXXGRAPH::Graph_TS&lt; T &gt;</a></td><td class="entry"></td></tr>
-  <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>writeToFile</b>(InputOutputFormat format=InputOutputFormat::STANDARD_CSV, const std::string &amp;workingDir=&quot;.&quot;, const std::string &amp;OFileName=&quot;graph&quot;, bool compress=false, bool writeNodeFeat=false, bool writeEdgeWeight=false) const (defined in <a class="el" href="../../d0/df2/classCXXGRAPH_1_1Graph.html">CXXGRAPH::Graph&lt; T &gt;</a>)</td><td class="entry"><a class="el" href="../../d0/df2/classCXXGRAPH_1_1Graph.html">CXXGRAPH::Graph&lt; T &gt;</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
+  <tr><td class="entry"><a class="el" href="../../da/da5/classCXXGRAPH_1_1Graph__TS.html#a440ba5244ff714629df57f8a341a7c27">writeToFile</a>(typename Graph&lt; T &gt;::InputOutputFormat format=Graph&lt; T &gt;::InputOutputFormat::STANDARD_CSV, const std::string &amp;workingDir=&quot;.&quot;, const std::string &amp;OFileName=&quot;graph&quot;, bool compress=false, bool writeNodeFeat=false, bool writeEdgeWeight=false) const override</td><td class="entry"><a class="el" href="../../da/da5/classCXXGRAPH_1_1Graph__TS.html">CXXGRAPH::Graph_TS&lt; T &gt;</a></td><td class="entry"></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="../../d0/df2/classCXXGRAPH_1_1Graph.html#a5a1ffeb9ef3b62b38c10bd84b44170a0">CXXGRAPH::Graph::writeToFile</a>(InputOutputFormat format=InputOutputFormat::STANDARD_CSV, const std::string &amp;workingDir=&quot;.&quot;, const std::string &amp;OFileName=&quot;graph&quot;, bool compress=false, bool writeNodeFeat=false, bool writeEdgeWeight=false) const</td><td class="entry"><a class="el" href="../../d0/df2/classCXXGRAPH_1_1Graph.html">CXXGRAPH::Graph&lt; T &gt;</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
   <tr bgcolor="#f0f0f0"><td class="entry"><b>~Graph</b>()=default (defined in <a class="el" href="../../d0/df2/classCXXGRAPH_1_1Graph.html">CXXGRAPH::Graph&lt; T &gt;</a>)</td><td class="entry"><a class="el" href="../../d0/df2/classCXXGRAPH_1_1Graph.html">CXXGRAPH::Graph&lt; T &gt;</a></td><td class="entry"></td></tr>
   <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>~Graph_TS</b>()=default (defined in <a class="el" href="../../da/da5/classCXXGRAPH_1_1Graph__TS.html">CXXGRAPH::Graph_TS&lt; T &gt;</a>)</td><td class="entry"><a class="el" href="../../da/da5/classCXXGRAPH_1_1Graph__TS.html">CXXGRAPH::Graph_TS&lt; T &gt;</a></td><td class="entry"></td></tr>
 </table></div><!-- contents -->

docs/html/d2/def/structCXXGRAPH_1_1PartitioningStats__struct.html

@@ -23,9 +23,9 @@
   <td id="projectlogo"><img alt="Logo" src="../../logo.png"/></td>
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">CXXGraph
-   &#160;<span id="projectnumber">0.1.5</span>
+   &#160;<span id="projectnumber">0.1.6</span>
    </div>
-   <div id="projectbrief">CXXGraph is a small library, header only, that manages the Graph and it&#39;s algorithm in C++</div>
+   <div id="projectbrief">CXXGraph is a header only, that manages the Graphs and it&#39;s algorithm in C++</div>
   </td>
  </tr>
  </tbody>

docs/html/d3/dd2/classCXXGRAPH_1_1Node.html

@@ -23,9 +23,9 @@
   <td id="projectlogo"><img alt="Logo" src="../../logo.png"/></td>
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">CXXGraph
-   &#160;<span id="projectnumber">0.1.5</span>
+   &#160;<span id="projectnumber">0.1.6</span>
    </div>
-   <div id="projectbrief">CXXGraph is a small library, header only, that manages the Graph and it&#39;s algorithm in C++</div>
+   <div id="projectbrief">CXXGraph is a header only, that manages the Graphs and it&#39;s algorithm in C++</div>
   </td>
  </tr>
  </tbody>