Skip to content

Commit d945b3a

Browse files
davecomdavecom
committed
Generated new HTML Docs and wrote a short script to do so for future releases; Closes #20 
1 parent 9d7df73 commit d945b3a

79 files changed

Lines changed: 16776 additions & 9868 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ A breadth-first search is performed, starting from New York, for all cities in `
113113
SwiftGraph contains many more useful features, but hopefully this example was a nice quickstart.
114114

115115
## Documentation
116-
There is a large amount of documentation in the source code using the latest Apple documentation technique—so you should be able to just alt-click a method name to get a lot of great information about it in Xcode. We are looking [for a new HTML docs provider](https://github.com/davecom/SwiftGraph/issues/20) since CocoaPods no longer offers that service. In addition, here's an overview of each of SwiftGraph's components:
116+
There is a large amount of documentation in the source code using the latest Apple documentation technique—so you should be able to just alt-click a method name to get a lot of great information about it in Xcode. We also use Jazzy to produce [HTML Docs](https://davecom.github.io/SwiftGraph). In addition, here's an overview of each of SwiftGraph's components:
117117

118118
### Edges
119119
Edges connect the vertices in your graph to one another.

‎docs/Classes.html‎

Lines changed: 266 additions & 173 deletions
Large diffs are not rendered by default.

‎docs/Classes/CodableUnweightedGraph.html‎

Lines changed: 250 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,250 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<title>CodableUnweightedGraph Class Reference</title>
5+
<link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
6+
<link rel="stylesheet" type="text/css" href="../css/highlight.css" />
7+
<meta charset='utf-8'>
8+
<script src="../js/jquery.min.js" defer></script>
9+
<script src="../js/jazzy.js" defer></script>
10+
11+
</head>
12+
<body>
13+
<a name="//apple_ref/swift/Class/CodableUnweightedGraph" class="dashAnchor"></a>
14+
<a title="CodableUnweightedGraph Class Reference"></a>
15+
<header>
16+
<div class="content-wrapper">
17+
<p><a href="../index.html">SwiftGraph Docs</a> (73% documented)</p>
18+
<p class="header-right"><a href="https://github.com/davecom/SwiftGraph"><img src="../img/gh.png"/>View on GitHub</a></p>
19+
</div>
20+
</header>
21+
<div class="content-wrapper">
22+
<p id="breadcrumbs">
23+
<a href="../index.html">SwiftGraph Reference</a>
24+
<img id="carat" src="../img/carat.png" />
25+
CodableUnweightedGraph Class Reference
26+
</p>
27+
</div>
28+
<div class="content-wrapper">
29+
<nav class="sidebar">
30+
<ul class="nav-groups">
31+
<li class="nav-group-name">
32+
<a href="../Classes.html">Classes</a>
33+
<ul class="nav-group-tasks">
34+
<li class="nav-group-task">
35+
<a href="../Classes/CodableUnweightedGraph.html">CodableUnweightedGraph</a>
36+
</li>
37+
<li class="nav-group-task">
38+
<a href="../Classes/CodableWeightedGraph.html">CodableWeightedGraph</a>
39+
</li>
40+
<li class="nav-group-task">
41+
<a href="../Classes/Queue.html">Queue</a>
42+
</li>
43+
<li class="nav-group-task">
44+
<a href="../Classes/Stack.html">Stack</a>
45+
</li>
46+
<li class="nav-group-task">
47+
<a href="../Classes/UniqueElementsGraph.html">UniqueElementsGraph</a>
48+
</li>
49+
<li class="nav-group-task">
50+
<a href="../Classes/UnweightedEdge.html">UnweightedEdge</a>
51+
</li>
52+
<li class="nav-group-task">
53+
<a href="../Classes/UnweightedGraph.html">UnweightedGraph</a>
54+
</li>
55+
<li class="nav-group-task">
56+
<a href="../Classes/WeightedEdge.html">WeightedEdge</a>
57+
</li>
58+
<li class="nav-group-task">
59+
<a href="../Classes/WeightedGraph.html">WeightedGraph</a>
60+
</li>
61+
</ul>
62+
</li>
63+
<li class="nav-group-name">
64+
<a href="../Functions.html">Functions</a>
65+
<ul class="nav-group-tasks">
66+
<li class="nav-group-task">
67+
<a href="../Functions.html#/s:10SwiftGraph25distanceArrayToVertexDict9distances5graphSDyxq_SgGSayAEG_AA08WeightedB0Cyxq_GtSHRzSLR_SeR_SER_SjR_r0_lF">distanceArrayToVertexDict(distances:graph:)</a>
68+
</li>
69+
<li class="nav-group-task">
70+
<a href="../Functions.html#/s:10SwiftGraph14pathDictToPath4from2to0cD0SayAA12WeightedEdgeCyxGGSi_SiSDySiAHGtSLRzSeRzSERzSjRzlF">pathDictToPath(from:to:pathDict:)</a>
71+
</li>
72+
<li class="nav-group-task">
73+
<a href="../Functions.html#/s:10SwiftGraph14pathDictToPath4from2to0cD0SayAA4Edge_pGSi_SiSDySiAaF_pGtF">pathDictToPath(from:to:pathDict:)</a>
74+
</li>
75+
<li class="nav-group-task">
76+
<a href="../Functions.html#/s:10SwiftGraph8printMST5edges5graphySayAA12WeightedEdgeCyq_GG_AA0gB0Cyxq_GtSQRzSLR_SeR_SER_SjR_r0_lF">printMST(edges:graph:)</a>
77+
</li>
78+
<li class="nav-group-task">
79+
<a href="../Functions.html#/s:10SwiftGraph11totalWeightyxSgSayAA12WeightedEdgeCyxGGSLRzSeRzSERzSjRzlF">totalWeight(_:)</a>
80+
</li>
81+
</ul>
82+
</li>
83+
<li class="nav-group-name">
84+
<a href="../Protocols.html">Protocols</a>
85+
<ul class="nav-group-tasks">
86+
<li class="nav-group-task">
87+
<a href="../Protocols/Edge.html">Edge</a>
88+
</li>
89+
<li class="nav-group-task">
90+
<a href="../Protocols/Graph.html">Graph</a>
91+
</li>
92+
</ul>
93+
</li>
94+
<li class="nav-group-name">
95+
<a href="../Structs.html">Structures</a>
96+
<ul class="nav-group-tasks">
97+
<li class="nav-group-task">
98+
<a href="../Structs/PriorityQueue.html">PriorityQueue</a>
99+
</li>
100+
</ul>
101+
</li>
102+
</ul>
103+
</nav>
104+
<article class="main-content">
105+
<section>
106+
<section class="section">
107+
<h1>CodableUnweightedGraph</h1>
108+
<div class="declaration">
109+
<div class="language">
110+
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">final</span> <span class="kd">class</span> <span class="kt">CodableUnweightedGraph</span><span class="o">&lt;</span><span class="kt">V</span><span class="o">&gt;</span> <span class="p">:</span> <span class="kt"><a href="../Classes/UnweightedGraph.html">UnweightedGraph</a></span><span class="o">&lt;</span><span class="kt">V</span><span class="o">&gt;</span><span class="p">,</span> <span class="kt">Codable</span> <span class="k">where</span> <span class="kt">V</span> <span class="p">:</span> <span class="kt">Decodable</span><span class="p">,</span> <span class="kt">V</span> <span class="p">:</span> <span class="kt">Encodable</span><span class="p">,</span> <span class="kt">V</span> <span class="p">:</span> <span class="kt">Equatable</span></code></pre>
111+
112+
</div>
113+
</div>
114+
<p>Undocumented</p>
115+
116+
</section>
117+
<section class="section task-group-section">
118+
<div class="task-group">
119+
<ul>
120+
<li class="item">
121+
<div>
122+
<code>
123+
<a name="/s:10SwiftGraph017CodableUnweightedB0CACyxGycfc"></a>
124+
<a name="//apple_ref/swift/Method/init()" class="dashAnchor"></a>
125+
<a class="token" href="#/s:10SwiftGraph017CodableUnweightedB0CACyxGycfc">init()</a>
126+
</code>
127+
</div>
128+
<div class="height-container">
129+
<div class="pointer-container"></div>
130+
<section class="section">
131+
<div class="pointer"></div>
132+
<div class="abstract">
133+
<p>Undocumented</p>
134+
135+
</div>
136+
<div class="declaration">
137+
<h4>Declaration</h4>
138+
<div class="language">
139+
<p class="aside-title">Swift</p>
140+
<pre class="highlight swift"><code><span class="k">override</span> <span class="kd">public</span> <span class="nf">init</span><span class="p">()</span></code></pre>
141+
142+
</div>
143+
</div>
144+
<div class="slightly-smaller">
145+
<a href="https://github.com/davecom/SwiftGraph/tree/2.0.0/Sources/SwiftGraph/UnweightedGraph.swift#L116-L118">Show on GitHub</a>
146+
</div>
147+
</section>
148+
</div>
149+
</li>
150+
<li class="item">
151+
<div>
152+
<code>
153+
<a name="/s:10SwiftGraph017CodableUnweightedB0C8verticesACyxGSayxG_tcfc"></a>
154+
<a name="//apple_ref/swift/Method/init(vertices:)" class="dashAnchor"></a>
155+
<a class="token" href="#/s:10SwiftGraph017CodableUnweightedB0C8verticesACyxGSayxG_tcfc">init(vertices:)</a>
156+
</code>
157+
</div>
158+
<div class="height-container">
159+
<div class="pointer-container"></div>
160+
<section class="section">
161+
<div class="pointer"></div>
162+
<div class="abstract">
163+
<p>Undocumented</p>
164+
165+
</div>
166+
<div class="declaration">
167+
<h4>Declaration</h4>
168+
<div class="language">
169+
<p class="aside-title">Swift</p>
170+
<pre class="highlight swift"><code><span class="k">override</span> <span class="kd">public</span> <span class="nf">init</span><span class="p">(</span><span class="nv">vertices</span><span class="p">:</span> <span class="p">[</span><span class="kt">V</span><span class="p">])</span></code></pre>
171+
172+
</div>
173+
</div>
174+
<div class="slightly-smaller">
175+
<a href="https://github.com/davecom/SwiftGraph/tree/2.0.0/Sources/SwiftGraph/UnweightedGraph.swift#L120-L122">Show on GitHub</a>
176+
</div>
177+
</section>
178+
</div>
179+
</li>
180+
<li class="item">
181+
<div>
182+
<code>
183+
<a name="/s:Se4fromxs7Decoder_p_tKcfc"></a>
184+
<a name="//apple_ref/swift/Method/init(from:)" class="dashAnchor"></a>
185+
<a class="token" href="#/s:Se4fromxs7Decoder_p_tKcfc">init(from:)</a>
186+
</code>
187+
</div>
188+
<div class="height-container">
189+
<div class="pointer-container"></div>
190+
<section class="section">
191+
<div class="pointer"></div>
192+
<div class="abstract">
193+
194+
</div>
195+
<div class="declaration">
196+
<h4>Declaration</h4>
197+
<div class="language">
198+
<p class="aside-title">Swift</p>
199+
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">required</span> <span class="nf">init</span><span class="p">(</span><span class="n">from</span> <span class="nv">decoder</span><span class="p">:</span> <span class="kt">Decoder</span><span class="p">)</span> <span class="k">throws</span></code></pre>
200+
201+
</div>
202+
</div>
203+
<div class="slightly-smaller">
204+
<a href="https://github.com/davecom/SwiftGraph/tree/2.0.0/Sources/SwiftGraph/UnweightedGraph.swift#L124-L129">Show on GitHub</a>
205+
</div>
206+
</section>
207+
</div>
208+
</li>
209+
<li class="item">
210+
<div>
211+
<code>
212+
<a name="/s:SE6encode2toys7Encoder_p_tKF"></a>
213+
<a name="//apple_ref/swift/Method/encode(to:)" class="dashAnchor"></a>
214+
<a class="token" href="#/s:SE6encode2toys7Encoder_p_tKF">encode(to:)</a>
215+
</code>
216+
</div>
217+
<div class="height-container">
218+
<div class="pointer-container"></div>
219+
<section class="section">
220+
<div class="pointer"></div>
221+
<div class="abstract">
222+
223+
</div>
224+
<div class="declaration">
225+
<h4>Declaration</h4>
226+
<div class="language">
227+
<p class="aside-title">Swift</p>
228+
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">encode</span><span class="p">(</span><span class="n">to</span> <span class="nv">encoder</span><span class="p">:</span> <span class="kt">Encoder</span><span class="p">)</span> <span class="k">throws</span></code></pre>
229+
230+
</div>
231+
</div>
232+
<div class="slightly-smaller">
233+
<a href="https://github.com/davecom/SwiftGraph/tree/2.0.0/Sources/SwiftGraph/UnweightedGraph.swift#L131-L135">Show on GitHub</a>
234+
</div>
235+
</section>
236+
</div>
237+
</li>
238+
</ul>
239+
</div>
240+
</section>
241+
</section>
242+
<section id="footer">
243+
<p>&copy; 2018 <a class="link" href="https://twitter.com/davekopec" target="_blank" rel="external">David</a>. All rights reserved. (Last updated: 2018-10-19)</p>
244+
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
245+
</section>
246+
</article>
247+
</div>
248+
</body>
249+
</div>
250+
</html>

0 commit comments

Comments
 (0)