Skip to content

Commit 76b5180

Browse files
davecomdavecom
committed
Updated HTML docs for 3.1
1 parent 6182fad commit 76b5180

Some content is hidden

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

60 files changed

+5569
-909
lines changed

‎docs/Classes.html

Lines changed: 17 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,22 @@
88
<script src="js/jquery.min.js" defer></script>
99
<script src="js/jazzy.js" defer></script>
1010

11+
<script src="js/lunr.min.js" defer></script>
12+
<script src="js/typeahead.jquery.js" defer></script>
13+
<script src="js/jazzy.search.js" defer></script>
1114
</head>
1215
<body>
1316
<a name="//apple_ref/swift/Section/Classes" class="dashAnchor"></a>
1417
<a title="Classes Reference"></a>
1518
<header>
1619
<div class="content-wrapper">
17-
<p><a href="index.html">SwiftGraph Docs</a> (72% documented)</p>
20+
<p><a href="index.html">SwiftGraph 3.1 Docs</a> (73% documented)</p>
1821
<p class="header-right"><a href="https://github.com/davecom/SwiftGraph"><img src="img/gh.png"/>View on GitHub</a></p>
22+
<p class="header-right">
23+
<form role="search" action="search.json">
24+
<input type="text" placeholder="Search documentation" data-typeahead>
25+
</form>
26+
</p>
1927
</div>
2028
</header>
2129
<div class="content-wrapper">
@@ -156,15 +164,11 @@ <h4>Declaration</h4>
156164
</div>
157165
</div>
158166
<div class="slightly-smaller">
159-
<a href="https://github.com/davecom/SwiftGraph/tree/3.0.0/Sources/SwiftGraph/WeightedGraph.swift#L20-L56">Show on GitHub</a>
167+
<a href="https://github.com/davecom/SwiftGraph/tree/3.1/Sources/SwiftGraph/WeightedGraph.swift#L20-L56">Show on GitHub</a>
160168
</div>
161169
</section>
162170
</div>
163171
</li>
164-
</ul>
165-
</div>
166-
<div class="task-group">
167-
<ul>
168172
<li class="item">
169173
<div>
170174
<code>
@@ -186,20 +190,16 @@ <h4>Declaration</h4>
186190
<h4>Declaration</h4>
187191
<div class="language">
188192
<p class="aside-title">Swift</p>
189-
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">Queue</span><span class="o">&lt;</span><span class="kt">T</span><span class="o">&gt;</span> <span class="k">where</span> <span class="kt">T</span> <span class="p">:</span> <span class="kt">Equatable</span></code></pre>
193+
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">Queue</span><span class="o">&lt;</span><span class="kt">T</span><span class="o">&gt;</span></code></pre>
190194

191195
</div>
192196
</div>
193197
<div class="slightly-smaller">
194-
<a href="https://github.com/davecom/SwiftGraph/tree/3.0.0/Sources/SwiftGraph/Queue.swift#L20-L63">Show on GitHub</a>
198+
<a href="https://github.com/davecom/SwiftGraph/tree/3.1/Sources/SwiftGraph/Queue.swift#L20-L55">Show on GitHub</a>
195199
</div>
196200
</section>
197201
</div>
198202
</li>
199-
</ul>
200-
</div>
201-
<div class="task-group">
202-
<ul>
203203
<li class="item">
204204
<div>
205205
<code>
@@ -226,15 +226,11 @@ <h4>Declaration</h4>
226226
</div>
227227
</div>
228228
<div class="slightly-smaller">
229-
<a href="https://github.com/davecom/SwiftGraph/tree/3.0.0/Sources/SwiftGraph/Stack.swift#L20-L25">Show on GitHub</a>
229+
<a href="https://github.com/davecom/SwiftGraph/tree/3.1/Sources/SwiftGraph/Stack.swift#L20-L25">Show on GitHub</a>
230230
</div>
231231
</section>
232232
</div>
233233
</li>
234-
</ul>
235-
</div>
236-
<div class="task-group">
237-
<ul>
238234
<li class="item">
239235
<div>
240236
<code>
@@ -261,15 +257,11 @@ <h4>Declaration</h4>
261257
</div>
262258
</div>
263259
<div class="slightly-smaller">
264-
<a href="https://github.com/davecom/SwiftGraph/tree/3.0.0/Sources/SwiftGraph/UniqueElementsGraph.swift#L23-L67">Show on GitHub</a>
260+
<a href="https://github.com/davecom/SwiftGraph/tree/3.1/Sources/SwiftGraph/UniqueElementsGraph.swift#L23-L67">Show on GitHub</a>
265261
</div>
266262
</section>
267263
</div>
268264
</li>
269-
</ul>
270-
</div>
271-
<div class="task-group">
272-
<ul>
273265
<li class="item">
274266
<div>
275267
<code>
@@ -296,7 +288,7 @@ <h4>Declaration</h4>
296288
</div>
297289
</div>
298290
<div class="slightly-smaller">
299-
<a href="https://github.com/davecom/SwiftGraph/tree/3.0.0/Sources/SwiftGraph/UnweightedGraph.swift#L20-L55">Show on GitHub</a>
291+
<a href="https://github.com/davecom/SwiftGraph/tree/3.1/Sources/SwiftGraph/UnweightedGraph.swift#L20-L55">Show on GitHub</a>
300292
</div>
301293
</section>
302294
</div>
@@ -306,8 +298,8 @@ <h4>Declaration</h4>
306298
</section>
307299
</section>
308300
<section id="footer">
309-
<p>&copy; 2019 <a class="link" href="https://twitter.com/davekopec" target="_blank" rel="external">David</a>. All rights reserved. (Last updated: 2019-04-12)</p>
310-
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
301+
<p>&copy; 2021 <a class="link" href="https://twitter.com/davekopec" target="_blank" rel="external">David</a>. All rights reserved. (Last updated: 2021-02-19)</p>
302+
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
311303
</section>
312304
</article>
313305
</div>

‎docs/Classes/Queue.html

Lines changed: 39 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,22 @@
88
<script src="../js/jquery.min.js" defer></script>
99
<script src="../js/jazzy.js" defer></script>
1010

11+
<script src="../js/lunr.min.js" defer></script>
12+
<script src="../js/typeahead.jquery.js" defer></script>
13+
<script src="../js/jazzy.search.js" defer></script>
1114
</head>
1215
<body>
1316
<a name="//apple_ref/swift/Class/Queue" class="dashAnchor"></a>
1417
<a title="Queue Class Reference"></a>
1518
<header>
1619
<div class="content-wrapper">
17-
<p><a href="../index.html">SwiftGraph Docs</a> (72% documented)</p>
20+
<p><a href="../index.html">SwiftGraph 3.1 Docs</a> (73% documented)</p>
1821
<p class="header-right"><a href="https://github.com/davecom/SwiftGraph"><img src="../img/gh.png"/>View on GitHub</a></p>
22+
<p class="header-right">
23+
<form role="search" action="../search.json">
24+
<input type="text" placeholder="Search documentation" data-typeahead>
25+
</form>
26+
</p>
1927
</div>
2028
</header>
2129
<div class="content-wrapper">
@@ -126,12 +134,16 @@
126134
<h1>Queue</h1>
127135
<div class="declaration">
128136
<div class="language">
129-
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">Queue</span><span class="o">&lt;</span><span class="kt">T</span><span class="o">&gt;</span> <span class="k">where</span> <span class="kt">T</span> <span class="p">:</span> <span class="kt">Equatable</span></code></pre>
137+
138+
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">Queue</span><span class="o">&lt;</span><span class="kt">T</span><span class="o">&gt;</span></code></pre>
130139

131140
</div>
132141
</div>
133142
<p>Implements a queue - helper class that uses an array internally.</p>
134143

144+
<div class="slightly-smaller">
145+
<a href="https://github.com/davecom/SwiftGraph/tree/3.1/Sources/SwiftGraph/Queue.swift#L20-L55">Show on GitHub</a>
146+
</div>
135147
</section>
136148
<section class="section task-group-section">
137149
<div class="task-group">
@@ -161,7 +173,7 @@ <h4>Declaration</h4>
161173
</div>
162174
</div>
163175
<div class="slightly-smaller">
164-
<a href="https://github.com/davecom/SwiftGraph/tree/3.0.0/Sources/SwiftGraph/Queue.swift#L">Show on GitHub</a>
176+
<a href="https://github.com/davecom/SwiftGraph/tree/3.1/Sources/SwiftGraph/Queue.swift#L">Show on GitHub</a>
165177
</div>
166178
</section>
167179
</div>
@@ -191,7 +203,7 @@ <h4>Declaration</h4>
191203
</div>
192204
</div>
193205
<div class="slightly-smaller">
194-
<a href="https://github.com/davecom/SwiftGraph/tree/3.0.0/Sources/SwiftGraph/Queue.swift#L26-L28">Show on GitHub</a>
206+
<a href="https://github.com/davecom/SwiftGraph/tree/3.1/Sources/SwiftGraph/Queue.swift#L26-L28">Show on GitHub</a>
195207
</div>
196208
</section>
197209
</div>
@@ -201,7 +213,7 @@ <h4>Declaration</h4>
201213
<code>
202214
<a name="/s:10SwiftGraph5QueueC4pushyyxF"></a>
203215
<a name="//apple_ref/swift/Method/push(_:)" class="dashAnchor"></a>
204-
<a class="token" href="#/s:10SwiftGraph5QueueC4pushyyxF">push(_:)</a>
216+
<a class="token" href="#/s:10SwiftGraph5QueueC4pushyyxF">push(_:<wbr>)</a>
205217
</code>
206218
</div>
207219
<div class="height-container">
@@ -221,7 +233,7 @@ <h4>Declaration</h4>
221233
</div>
222234
</div>
223235
<div class="slightly-smaller">
224-
<a href="https://github.com/davecom/SwiftGraph/tree/3.0.0/Sources/SwiftGraph/Queue.swift#L30-L32">Show on GitHub</a>
236+
<a href="https://github.com/davecom/SwiftGraph/tree/3.1/Sources/SwiftGraph/Queue.swift#L30-L32">Show on GitHub</a>
225237
</div>
226238
</section>
227239
</div>
@@ -251,7 +263,7 @@ <h4>Declaration</h4>
251263
</div>
252264
</div>
253265
<div class="slightly-smaller">
254-
<a href="https://github.com/davecom/SwiftGraph/tree/3.0.0/Sources/SwiftGraph/Queue.swift#L34-L46">Show on GitHub</a>
266+
<a href="https://github.com/davecom/SwiftGraph/tree/3.1/Sources/SwiftGraph/Queue.swift#L34-L46">Show on GitHub</a>
255267
</div>
256268
</section>
257269
</div>
@@ -281,7 +293,7 @@ <h4>Declaration</h4>
281293
</div>
282294
</div>
283295
<div class="slightly-smaller">
284-
<a href="https://github.com/davecom/SwiftGraph/tree/3.0.0/Sources/SwiftGraph/Queue.swift#L48-L50">Show on GitHub</a>
296+
<a href="https://github.com/davecom/SwiftGraph/tree/3.1/Sources/SwiftGraph/Queue.swift#L48-L50">Show on GitHub</a>
285297
</div>
286298
</section>
287299
</div>
@@ -311,17 +323,30 @@ <h4>Declaration</h4>
311323
</div>
312324
</div>
313325
<div class="slightly-smaller">
314-
<a href="https://github.com/davecom/SwiftGraph/tree/3.0.0/Sources/SwiftGraph/Queue.swift#L52-L54">Show on GitHub</a>
326+
<a href="https://github.com/davecom/SwiftGraph/tree/3.1/Sources/SwiftGraph/Queue.swift#L52-L54">Show on GitHub</a>
315327
</div>
316328
</section>
317329
</div>
318330
</li>
331+
</ul>
332+
</div>
333+
<div class="task-group">
334+
<div class="task-name-container">
335+
<a name="/Available%20where%20%60T%60%3A%20%60Equatable%60"></a>
336+
<a name="//apple_ref/swift/Section/Available where `T`: `Equatable`" class="dashAnchor"></a>
337+
<div class="section-name-container">
338+
<a class="section-name-link" href="#/Available%20where%20%60T%60%3A%20%60Equatable%60"></a>
339+
<h3 class="section-name"><p>Available where <code>T</code>: <code>Equatable</code></p>
340+
</h3>
341+
</div>
342+
</div>
343+
<ul>
319344
<li class="item">
320345
<div>
321346
<code>
322-
<a name="/s:10SwiftGraph5QueueC8containsySbxF"></a>
347+
<a name="/s:10SwiftGraph5QueueCAASQRzlE8containsySbxF"></a>
323348
<a name="//apple_ref/swift/Method/contains(_:)" class="dashAnchor"></a>
324-
<a class="token" href="#/s:10SwiftGraph5QueueC8containsySbxF">contains(_:)</a>
349+
<a class="token" href="#/s:10SwiftGraph5QueueCAASQRzlE8containsySbxF">contains(_:<wbr>)</a>
325350
</code>
326351
</div>
327352
<div class="height-container">
@@ -341,7 +366,7 @@ <h4>Declaration</h4>
341366
</div>
342367
</div>
343368
<div class="slightly-smaller">
344-
<a href="https://github.com/davecom/SwiftGraph/tree/3.0.0/Sources/SwiftGraph/Queue.swift#L56-L62">Show on GitHub</a>
369+
<a href="https://github.com/davecom/SwiftGraph/tree/3.1/Sources/SwiftGraph/Queue.swift#L58-L64">Show on GitHub</a>
345370
</div>
346371
</section>
347372
</div>
@@ -351,8 +376,8 @@ <h4>Declaration</h4>
351376
</section>
352377
</section>
353378
<section id="footer">
354-
<p>&copy; 2019 <a class="link" href="https://twitter.com/davekopec" target="_blank" rel="external">David</a>. All rights reserved. (Last updated: 2019-04-12)</p>
355-
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
379+
<p>&copy; 2021 <a class="link" href="https://twitter.com/davekopec" target="_blank" rel="external">David</a>. All rights reserved. (Last updated: 2021-02-19)</p>
380+
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
356381
</section>
357382
</article>
358383
</div>

‎docs/Classes/Stack.html

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,22 @@
88
<script src="../js/jquery.min.js" defer></script>
99
<script src="../js/jazzy.js" defer></script>
1010

11+
<script src="../js/lunr.min.js" defer></script>
12+
<script src="../js/typeahead.jquery.js" defer></script>
13+
<script src="../js/jazzy.search.js" defer></script>
1114
</head>
1215
<body>
1316
<a name="//apple_ref/swift/Class/Stack" class="dashAnchor"></a>
1417
<a title="Stack Class Reference"></a>
1518
<header>
1619
<div class="content-wrapper">
17-
<p><a href="../index.html">SwiftGraph Docs</a> (72% documented)</p>
20+
<p><a href="../index.html">SwiftGraph 3.1 Docs</a> (73% documented)</p>
1821
<p class="header-right"><a href="https://github.com/davecom/SwiftGraph"><img src="../img/gh.png"/>View on GitHub</a></p>
22+
<p class="header-right">
23+
<form role="search" action="../search.json">
24+
<input type="text" placeholder="Search documentation" data-typeahead>
25+
</form>
26+
</p>
1927
</div>
2028
</header>
2129
<div class="content-wrapper">
@@ -126,12 +134,16 @@
126134
<h1>Stack</h1>
127135
<div class="declaration">
128136
<div class="language">
137+
129138
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">Stack</span><span class="o">&lt;</span><span class="kt">T</span><span class="o">&gt;</span></code></pre>
130139

131140
</div>
132141
</div>
133142
<p>Implements a stack - helper class that uses an array internally.</p>
134143

144+
<div class="slightly-smaller">
145+
<a href="https://github.com/davecom/SwiftGraph/tree/3.1/Sources/SwiftGraph/Stack.swift#L20-L25">Show on GitHub</a>
146+
</div>
135147
</section>
136148
<section class="section task-group-section">
137149
<div class="task-group">
@@ -161,7 +173,7 @@ <h4>Declaration</h4>
161173
</div>
162174
</div>
163175
<div class="slightly-smaller">
164-
<a href="https://github.com/davecom/SwiftGraph/tree/3.0.0/Sources/SwiftGraph/Stack.swift#L">Show on GitHub</a>
176+
<a href="https://github.com/davecom/SwiftGraph/tree/3.1/Sources/SwiftGraph/Stack.swift#L">Show on GitHub</a>
165177
</div>
166178
</section>
167179
</div>
@@ -171,7 +183,7 @@ <h4>Declaration</h4>
171183
<code>
172184
<a name="/s:10SwiftGraph5StackC4pushyyxF"></a>
173185
<a name="//apple_ref/swift/Method/push(_:)" class="dashAnchor"></a>
174-
<a class="token" href="#/s:10SwiftGraph5StackC4pushyyxF">push(_:)</a>
186+
<a class="token" href="#/s:10SwiftGraph5StackC4pushyyxF">push(_:<wbr>)</a>
175187
</code>
176188
</div>
177189
<div class="height-container">
@@ -191,7 +203,7 @@ <h4>Declaration</h4>
191203
</div>
192204
</div>
193205
<div class="slightly-smaller">
194-
<a href="https://github.com/davecom/SwiftGraph/tree/3.0.0/Sources/SwiftGraph/Stack.swift#L">Show on GitHub</a>
206+
<a href="https://github.com/davecom/SwiftGraph/tree/3.1/Sources/SwiftGraph/Stack.swift#L">Show on GitHub</a>
195207
</div>
196208
</section>
197209
</div>
@@ -221,7 +233,7 @@ <h4>Declaration</h4>
221233
</div>
222234
</div>
223235
<div class="slightly-smaller">
224-
<a href="https://github.com/davecom/SwiftGraph/tree/3.0.0/Sources/SwiftGraph/Stack.swift#L">Show on GitHub</a>
236+
<a href="https://github.com/davecom/SwiftGraph/tree/3.1/Sources/SwiftGraph/Stack.swift#L">Show on GitHub</a>
225237
</div>
226238
</section>
227239
</div>
@@ -231,8 +243,8 @@ <h4>Declaration</h4>
231243
</section>
232244
</section>
233245
<section id="footer">
234-
<p>&copy; 2019 <a class="link" href="https://twitter.com/davekopec" target="_blank" rel="external">David</a>. All rights reserved. (Last updated: 2019-04-12)</p>
235-
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
246+
<p>&copy; 2021 <a class="link" href="https://twitter.com/davekopec" target="_blank" rel="external">David</a>. All rights reserved. (Last updated: 2021-02-19)</p>
247+
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
236248
</section>
237249
</article>
238250
</div>

0 commit comments

Comments
 (0)