added inline documentation

adrelino · Dec 30, 2016 · fdd549f · fdd549f
1 parent ab31513
commit fdd549f
Show file tree

Hide file tree

Showing 57 changed files with 32,271 additions and 1 deletion.
diff --git a/implementation-doc/AlgorithmTab.html b/implementation-doc/AlgorithmTab.html
diff --git a/implementation-doc/GoldbergTarjanPushRelabelAlgorithm.html b/implementation-doc/GoldbergTarjanPushRelabelAlgorithm.html
diff --git a/implementation-doc/Graph.Edge.html b/implementation-doc/Graph.Edge.html
@@ -0,0 +1,298 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <title>JSDoc: Class: Edge</title>
+
+    <script src="scripts/prettify/prettify.js"> </script>
+    <script src="scripts/prettify/lang-css.js"> </script>
+    <!--[if lt IE 9]>
+      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+    <![endif]-->
+    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
+    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
+</head>
+
+<body>
+
+<div id="main">
+
+    <h1 class="page-title">Class: Edge</h1>
+
+
+
+
+
+
+<section>
+
+<header>
+
+        <h2>
+            <span class="ancestors"><a href="Graph.html">Graph</a>.</span>Edge</h2>
+
+
+</header>
+
+<article>
+    <div class="container-overview">
+
+
+
+
+
+    <h4 class="name" id="Edge"><span class="type-signature"></span>new Edge<span class="signature">()</span><span class="type-signature"></span></h4>
+
+
+
+
+
+<div class="description">
+    Represents a graph edge
+</div>
+
+
+
+
+
+
+
+
+
+
+
+
+
+<dl class="details">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="library-d3-svg_js_Graph.js.html">library-d3-svg/js/Graph.js</a>, <a href="library-d3-svg_js_Graph.js.html#line85">line 85</a>
+    </li></ul></dd>
+
+
+
+
+
+
+
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+    </div>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+        <h3 class="subsection-title">Methods</h3>
+
+
+
+
+
+
+    <h4 class="name" id="toString"><span class="type-signature"></span>toString<span class="signature">(full)</span><span class="type-signature"></span></h4>
+
+
+
+
+
+<div class="description">
+    Returns a string representation of this edge together with its resources
+</div>
+
+
+
+
+
+
+
+
+
+    <h5>Parameters:</h5>
+
+
+<table class="params">
+    <thead>
+    <tr>
+
+        <th>Name</th>
+
+
+        <th>Type</th>
+
+
+
+
+
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+
+    <tbody>
+
+
+        <tr>
+
+                <td class="name"><code>full</code></td>
+
+
+            <td class="type">
+
+
+<span class="param-type">boolean</span>
+
+
+
+            </td>
+
+
+
+
+
+            <td class="description last">wheater to include the start and end node ids in the form start->end</td>
+        </tr>
+
+
+    </tbody>
+</table>
+
+
+
+
+
+
+<dl class="details">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="library-d3-svg_js_Graph.js.html">library-d3-svg/js/Graph.js</a>, <a href="library-d3-svg_js_Graph.js.html#line98">line 98</a>
+    </li></ul></dd>
+
+
+
+
+
+
+
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+</article>
+
+</section>
+
+
+
+
+</div>
+
+<nav>
+    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AlgorithmTab.html">AlgorithmTab</a></li><li><a href="GoldbergTarjanPushRelabelAlgorithm.html">GoldbergTarjanPushRelabelAlgorithm</a></li><li><a href="Graph.html">Graph</a></li><li><a href="Graph.Edge.html">Edge</a></li><li><a href="Graph.Label.html">Label</a></li><li><a href="Graph.Node.html">Node</a></li><li><a href="Graph.ResidualEdge.html">ResidualEdge</a></li><li><a href="GraphDrawer.html">GraphDrawer</a></li><li><a href="GraphEditorTab.html">GraphEditorTab</a></li><li><a href="LabelDrawer.html">LabelDrawer</a></li><li><a href="Logger.html">Logger</a></li><li><a href="ResidualGraphDrawer.html">ResidualGraphDrawer</a></li><li><a href="SPPRCLabelSettingAlgorithm.html">SPPRCLabelSettingAlgorithm</a></li><li><a href="Tab.html">Tab</a></li></ul><h3>Global</h3><ul><li><a href="global.html#const_Colors">const_Colors</a></li><li><a href="global.html#global_Edgelayout">global_Edgelayout</a></li><li><a href="global.html#global_KnotenRadius">global_KnotenRadius</a></li><li><a href="global.html#global_NodeLayout">global_NodeLayout</a></li><li><a href="global.html#GraphAlgos">GraphAlgos</a></li><li><a href="global.html#initializeSiteLayout">initializeSiteLayout</a></li><li><a href="global.html#translate">translate</a></li></ul>
+</nav>
+
+<br class="clear">
+
+<footer>
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Fri Dec 30 2016 16:31:49 GMT+0100 (CET)
+</footer>
+
+<script> prettyPrint(); </script>
+<script src="scripts/linenumber.js"> </script>
+</body>
+</html>