Merge pull request #15 from ZigRazor/documentation-update-5

Documentation Update

docs/html/d0/df2/classCXXGRAPH_1_1Graph.html

@@ -132,9 +132,9 @@
 <tr class="memitem:a30f4e26af431457ff30c15804888e318"><td class="memItemLeft" align="right" valign="top">const bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/df2/classCXXGRAPH_1_1Graph.html#a30f4e26af431457ff30c15804888e318">isDirectedGraph</a> () const</td></tr>
 <tr class="memdesc:a30f4e26af431457ff30c15804888e318"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function checks if a graph is directed.  <a href="../../d0/df2/classCXXGRAPH_1_1Graph.html#a30f4e26af431457ff30c15804888e318">More...</a><br /></td></tr>
 <tr class="separator:a30f4e26af431457ff30c15804888e318"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a24d74ebc6dae9c8b5ec889ccbf4f1f6c"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/df2/classCXXGRAPH_1_1Graph.html#a24d74ebc6dae9c8b5ec889ccbf4f1f6c">writeToFile</a> (OutputFormat format=OutputFormat::STANDARD, std::string OFileName=&quot;graph.csv&quot;, bool compress=false) const</td></tr>
-<tr class="memdesc:a24d74ebc6dae9c8b5ec889ccbf4f1f6c"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function write the graph in an output file.  <a href="../../d0/df2/classCXXGRAPH_1_1Graph.html#a24d74ebc6dae9c8b5ec889ccbf4f1f6c">More...</a><br /></td></tr>
-<tr class="separator:a24d74ebc6dae9c8b5ec889ccbf4f1f6c"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:aee3c26cd7be1503096b6728756d5a971"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/df2/classCXXGRAPH_1_1Graph.html#aee3c26cd7be1503096b6728756d5a971">writeToFile</a> (OutputFormat format=OutputFormat::STANDARD, std::string OFileName=&quot;graph.csv&quot;, bool compress=false, bool writeNodeFeat=false, bool writeEdgeWeight=false) const</td></tr>
+<tr class="memdesc:aee3c26cd7be1503096b6728756d5a971"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function write the graph in an output file.  <a href="../../d0/df2/classCXXGRAPH_1_1Graph.html#aee3c26cd7be1503096b6728756d5a971">More...</a><br /></td></tr>
+<tr class="separator:aee3c26cd7be1503096b6728756d5a971"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table><table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
 Friends</h2></td></tr>
@@ -301,8 +301,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#a30f4e26af431457ff30c1580
 
 </div>
 </div>
-<a id="a24d74ebc6dae9c8b5ec889ccbf4f1f6c"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#a24d74ebc6dae9c8b5ec889ccbf4f1f6c">&#9670;&nbsp;</a></span>writeToFile()</h2>
+<a id="aee3c26cd7be1503096b6728756d5a971"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#aee3c26cd7be1503096b6728756d5a971">&#9670;&nbsp;</a></span>writeToFile()</h2>
 
 <div class="memitem">
 <div class="memproto">
@@ -325,7 +325,19 @@ <h2 class="memtitle"><span class="permalink"><a href="#a24d74ebc6dae9c8b5ec889cc
           <td class="paramkey"></td>
           <td></td>
           <td class="paramtype">bool&#160;</td>
-          <td class="paramname"><em>compress</em> = <code>false</code>&#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>
@@ -339,7 +351,10 @@ <h2 class="memtitle"><span class="permalink"><a href="#a24d74ebc6dae9c8b5ec889cc
 <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">OFileName</td><td>The Output File Name </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 </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>