Skip to content

Commit 59d1afc

Browse files
committed
Add jsdocs
1 parent c5afad9 commit 59d1afc

26 files changed

+3972
-0
lines changed

Edge.html

Lines changed: 246 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,246 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="utf-8">
5+
<title>JSDoc: Class: Edge</title>
6+
7+
<script src="scripts/prettify/prettify.js"> </script>
8+
<script src="scripts/prettify/lang-css.js"> </script>
9+
<!--[if lt IE 9]>
10+
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
11+
<![endif]-->
12+
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
13+
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
14+
</head>
15+
16+
<body>
17+
18+
<div id="main">
19+
20+
<h1 class="page-title">Class: Edge</h1>
21+
22+
23+
24+
25+
26+
<section>
27+
28+
<header>
29+
<h2>
30+
Edge
31+
</h2>
32+
33+
</header>
34+
35+
<article>
36+
<div class="container-overview">
37+
38+
39+
40+
41+
<dt>
42+
<h4 class="name" id="Edge"><span class="type-signature"></span>new Edge<span class="signature">(e, v, distance)</span><span class="type-signature"></span></h4>
43+
44+
45+
</dt>
46+
<dd>
47+
48+
49+
<div class="description">
50+
Graph edge
51+
</div>
52+
53+
54+
55+
56+
57+
58+
59+
<h5>Parameters:</h5>
60+
61+
62+
<table class="params">
63+
<thead>
64+
<tr>
65+
66+
<th>Name</th>
67+
68+
69+
<th>Type</th>
70+
71+
72+
73+
74+
75+
<th class="last">Description</th>
76+
</tr>
77+
</thead>
78+
79+
<tbody>
80+
81+
82+
<tr>
83+
84+
<td class="name"><code>e</code></td>
85+
86+
87+
<td class="type">
88+
89+
90+
<span class="param-type"><a href="Vertex.html">Vertex</a></span>
91+
92+
93+
94+
</td>
95+
96+
97+
98+
99+
100+
<td class="description last">Vertex which this edge connects</td>
101+
</tr>
102+
103+
104+
105+
<tr>
106+
107+
<td class="name"><code>v</code></td>
108+
109+
110+
<td class="type">
111+
112+
113+
<span class="param-type"><a href="Vertex.html">Vertex</a></span>
114+
115+
116+
117+
</td>
118+
119+
120+
121+
122+
123+
<td class="description last">Vertex which this edge connects</td>
124+
</tr>
125+
126+
127+
128+
<tr>
129+
130+
<td class="name"><code>distance</code></td>
131+
132+
133+
<td class="type">
134+
135+
136+
<span class="param-type">number</span>
137+
138+
139+
140+
</td>
141+
142+
143+
144+
145+
146+
<td class="description last">Weight of the node</td>
147+
</tr>
148+
149+
150+
</tbody>
151+
</table>
152+
153+
154+
155+
<dl class="details">
156+
157+
158+
159+
160+
161+
162+
163+
164+
165+
166+
167+
168+
169+
170+
171+
172+
173+
174+
175+
<dt class="tag-source">Source:</dt>
176+
<dd class="tag-source"><ul class="dummy"><li>
177+
<a href="prim.js.html">graphs/spanning-trees/prim.js</a>, <a href="prim.js.html#line24">line 24</a>
178+
</li></ul></dd>
179+
180+
181+
182+
183+
184+
185+
186+
</dl>
187+
188+
189+
190+
191+
192+
193+
194+
195+
196+
197+
198+
199+
200+
201+
202+
</dd>
203+
204+
205+
</div>
206+
207+
208+
209+
210+
211+
212+
213+
214+
215+
216+
217+
218+
219+
220+
221+
222+
223+
224+
</article>
225+
226+
</section>
227+
228+
229+
230+
231+
</div>
232+
233+
<nav>
234+
<h2><a href="index.html">Index</a></h2><h3>Modules</h3><ul><li><a href="searching.html">graphs/searching</a></li></ul><h3>Classes</h3><ul><li><a href="Edge.html">Edge</a></li><li><a href="Graph.html">Graph</a></li><li><a href="Vertex.html">Vertex</a></li></ul>
235+
</nav>
236+
237+
<br clear="both">
238+
239+
<footer>
240+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha5</a> on Fri Jan 09 2015 19:15:14 GMT+0200 (EET)
241+
</footer>
242+
243+
<script> prettyPrint(); </script>
244+
<script src="scripts/linenumber.js"> </script>
245+
</body>
246+
</html>

0 commit comments

Comments
 (0)