Skip to content
This repository was archived by the owner on Apr 2, 2025. It is now read-only.

Commit 2e4a093

Browse files
timdonnellytimdonnelly
committed
Updated documentation generation
1 parent 3d07d9e commit 2e4a093

File tree

114 files changed

+2608
-3953
lines changed

Some content is hidden

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

114 files changed

+2608
-3953
lines changed

‎.jazzy.yaml‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@ author: Tim Donnelly
33
github_url: https://github.com/timdonnelly/Advance
44
github_file_prefix: https://github.com/timdonnelly/Advance/tree/master
55
root_url: https://timdonnelly.github.io/Advance
6-
xcodebuild_arguments: [-scheme,Advance-iOS]
7-
module_version: master
86
exclude: []
97

108
copyright: '© 2018 Tim Donnelly'

‎SampleApp/Podfile.lock‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
PODS:
2-
- Advance (2.0.0)
3-
- Advance/Tests (2.0.0)
2+
- Advance (2.1.0)
3+
- Advance/Tests (2.1.0)
44

55
DEPENDENCIES:
66
- Advance (from `../Advance.podspec`)
@@ -11,7 +11,7 @@ EXTERNAL SOURCES:
1111
:path: "../Advance.podspec"
1212

1313
SPEC CHECKSUMS:
14-
Advance: cf0cd6f6c883b734a515744e25f9e9ed7fcd8aca
14+
Advance: 53770560381b96a8525032590b36c1421943f037
1515

1616
PODFILE CHECKSUM: 47bc775798b67a5637081a07c5c3ae22fe887b80
1717

‎docs/Advanceable.html‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,11 @@
1010

1111
</head>
1212
<body>
13+
<a name="//apple_ref/swift/Section/Advanceable" class="dashAnchor"></a>
1314
<a title="Advanceable Reference"></a>
1415
<header>
1516
<div class="content-wrapper">
16-
<p><a href="index.html">Advance Docs</a> (95% documented)</p>
17+
<p><a href="index.html">Advance Docs</a> (100% documented)</p>
1718
<p class="header-right"><a href="https://github.com/timdonnelly/Advance"><img src="img/gh.png"/>View on GitHub</a></p>
1819
<p class="header-right"><a href="dash-feed://https%3A%2F%2Ftimdonnelly%2Egithub%2Eio%2Fdocsets%2FAdvance%2Exml"><img src="img/dash.png"/>Install in Dash</a></p>
1920
</div>
@@ -238,13 +239,10 @@ <h1>Advanceable</h1>
238239
<h4>Declaration</h4>
239240
<div class="language">
240241
<p class="aside-title">Swift</p>
241-
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">Advanceable</span></code></pre>
242+
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">Advanceable</span></code></pre>
242243

243244
</div>
244245
</div>
245-
<div class="slightly-smaller">
246-
<a href="https://github.com/timdonnelly/Advance/tree/master/Source/Advanceable.swift#L2-L10">Show on GitHub</a>
247-
</div>
248246
</section>
249247
</div>
250248
</li>
@@ -254,7 +252,7 @@ <h4>Declaration</h4>
254252
</section>
255253
<section id="footer">
256254
<p>© 2018 Tim Donnelly</p>
257-
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.0</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
255+
<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>
258256
</section>
259257
</article>
260258
</div>

‎docs/Animation.html‎

Lines changed: 34 additions & 51 deletions
Large diffs are not rendered by default.

‎docs/Classes/AnimationRunner.html‎

Lines changed: 66 additions & 107 deletions
Large diffs are not rendered by default.

‎docs/Classes/AnimationRunner/Result.html‎

Lines changed: 9 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
<a title="Result Enumeration Reference"></a>
1515
<header>
1616
<div class="content-wrapper">
17-
<p><a href="../../index.html">Advance Docs</a> (95% documented)</p>
17+
<p><a href="../../index.html">Advance Docs</a> (100% documented)</p>
1818
<p class="header-right"><a href="https://github.com/timdonnelly/Advance"><img src="../../img/gh.png"/>View on GitHub</a></p>
1919
<p class="header-right"><a href="dash-feed://https%3A%2F%2Ftimdonnelly%2Egithub%2Eio%2Fdocsets%2FAdvance%2Exml"><img src="../../img/dash.png"/>Install in Dash</a></p>
2020
</div>
@@ -215,7 +215,7 @@
215215
<h1>Result</h1>
216216
<div class="declaration">
217217
<div class="language">
218-
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">Result</span></code></pre>
218+
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">Result</span></code></pre>
219219

220220
</div>
221221
</div>
@@ -228,9 +228,9 @@ <h1>Result</h1>
228228
<li class="item">
229229
<div>
230230
<code>
231-
<a name="/s:7Advance15AnimationRunnerC6ResultO8finishedAEyx_GAGmAA17VectorConvertibleRzlF"></a>
231+
<a name="/s:7Advance15AnimationRunnerC6ResultO8finishedyAEyx_GAGmAA17VectorConvertibleRzlF"></a>
232232
<a name="//apple_ref/swift/Element/finished" class="dashAnchor"></a>
233-
<a class="token" href="#/s:7Advance15AnimationRunnerC6ResultO8finishedAEyx_GAGmAA17VectorConvertibleRzlF">finished</a>
233+
<a class="token" href="#/s:7Advance15AnimationRunnerC6ResultO8finishedyAEyx_GAGmAA17VectorConvertibleRzlF">finished</a>
234234
</code>
235235
</div>
236236
<div class="height-container">
@@ -245,26 +245,19 @@ <h1>Result</h1>
245245
<h4>Declaration</h4>
246246
<div class="language">
247247
<p class="aside-title">Swift</p>
248-
<pre class="highlight"><code><span class="k">case</span> <span class="n">finished</span></code></pre>
248+
<pre class="highlight swift"><code><span class="k">case</span> <span class="n">finished</span></code></pre>
249249

250250
</div>
251251
</div>
252-
<div class="slightly-smaller">
253-
<a href="https://github.com/timdonnelly/Advance/tree/master/Source/AnimationRunner.swift#L233">Show on GitHub</a>
254-
</div>
255252
</section>
256253
</div>
257254
</li>
258-
</ul>
259-
</div>
260-
<div class="task-group">
261-
<ul>
262255
<li class="item">
263256
<div>
264257
<code>
265-
<a name="/s:7Advance15AnimationRunnerC6ResultO9cancelledAEyx_GAGmAA17VectorConvertibleRzlF"></a>
258+
<a name="/s:7Advance15AnimationRunnerC6ResultO9cancelledyAEyx_GAGmAA17VectorConvertibleRzlF"></a>
266259
<a name="//apple_ref/swift/Element/cancelled" class="dashAnchor"></a>
267-
<a class="token" href="#/s:7Advance15AnimationRunnerC6ResultO9cancelledAEyx_GAGmAA17VectorConvertibleRzlF">cancelled</a>
260+
<a class="token" href="#/s:7Advance15AnimationRunnerC6ResultO9cancelledyAEyx_GAGmAA17VectorConvertibleRzlF">cancelled</a>
268261
</code>
269262
</div>
270263
<div class="height-container">
@@ -279,13 +272,10 @@ <h4>Declaration</h4>
279272
<h4>Declaration</h4>
280273
<div class="language">
281274
<p class="aside-title">Swift</p>
282-
<pre class="highlight"><code><span class="k">case</span> <span class="n">cancelled</span></code></pre>
275+
<pre class="highlight swift"><code><span class="k">case</span> <span class="n">cancelled</span></code></pre>
283276

284277
</div>
285278
</div>
286-
<div class="slightly-smaller">
287-
<a href="https://github.com/timdonnelly/Advance/tree/master/Source/AnimationRunner.swift#L236">Show on GitHub</a>
288-
</div>
289279
</section>
290280
</div>
291281
</li>
@@ -295,7 +285,7 @@ <h4>Declaration</h4>
295285
</section>
296286
<section id="footer">
297287
<p>© 2018 Tim Donnelly</p>
298-
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.0</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
288+
<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>
299289
</section>
300290
</article>
301291
</div>

‎docs/Classes/AnimationRunner/State.html‎

Lines changed: 16 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
<a title="State Enumeration Reference"></a>
1515
<header>
1616
<div class="content-wrapper">
17-
<p><a href="../../index.html">Advance Docs</a> (95% documented)</p>
17+
<p><a href="../../index.html">Advance Docs</a> (100% documented)</p>
1818
<p class="header-right"><a href="https://github.com/timdonnelly/Advance"><img src="../../img/gh.png"/>View on GitHub</a></p>
1919
<p class="header-right"><a href="dash-feed://https%3A%2F%2Ftimdonnelly%2Egithub%2Eio%2Fdocsets%2FAdvance%2Exml"><img src="../../img/dash.png"/>Install in Dash</a></p>
2020
</div>
@@ -215,7 +215,7 @@
215215
<h1>State</h1>
216216
<div class="declaration">
217217
<div class="language">
218-
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">State</span><span class="p">:</span> <span class="kt">Equatable</span></code></pre>
218+
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">State</span> <span class="p">:</span> <span class="kt">Equatable</span></code></pre>
219219

220220
</div>
221221
</div>
@@ -228,9 +228,9 @@ <h1>State</h1>
228228
<li class="item">
229229
<div>
230230
<code>
231-
<a name="/s:7Advance15AnimationRunnerC5StateO7pendingAEyx_GAGmAA17VectorConvertibleRzlF"></a>
231+
<a name="/s:7Advance15AnimationRunnerC5StateO7pendingyAEyx_GAGmAA17VectorConvertibleRzlF"></a>
232232
<a name="//apple_ref/swift/Element/pending" class="dashAnchor"></a>
233-
<a class="token" href="#/s:7Advance15AnimationRunnerC5StateO7pendingAEyx_GAGmAA17VectorConvertibleRzlF">pending</a>
233+
<a class="token" href="#/s:7Advance15AnimationRunnerC5StateO7pendingyAEyx_GAGmAA17VectorConvertibleRzlF">pending</a>
234234
</code>
235235
</div>
236236
<div class="height-container">
@@ -245,26 +245,19 @@ <h1>State</h1>
245245
<h4>Declaration</h4>
246246
<div class="language">
247247
<p class="aside-title">Swift</p>
248-
<pre class="highlight"><code><span class="k">case</span> <span class="n">pending</span></code></pre>
248+
<pre class="highlight swift"><code><span class="k">case</span> <span class="n">pending</span></code></pre>
249249

250250
</div>
251251
</div>
252-
<div class="slightly-smaller">
253-
<a href="https://github.com/timdonnelly/Advance/tree/master/Source/AnimationRunner.swift#L204">Show on GitHub</a>
254-
</div>
255252
</section>
256253
</div>
257254
</li>
258-
</ul>
259-
</div>
260-
<div class="task-group">
261-
<ul>
262255
<li class="item">
263256
<div>
264257
<code>
265-
<a name="/s:7Advance15AnimationRunnerC5StateO7runningAEyx_GAGmAA17VectorConvertibleRzlF"></a>
258+
<a name="/s:7Advance15AnimationRunnerC5StateO7runningyAEyx_GAGmAA17VectorConvertibleRzlF"></a>
266259
<a name="//apple_ref/swift/Element/running" class="dashAnchor"></a>
267-
<a class="token" href="#/s:7Advance15AnimationRunnerC5StateO7runningAEyx_GAGmAA17VectorConvertibleRzlF">running</a>
260+
<a class="token" href="#/s:7Advance15AnimationRunnerC5StateO7runningyAEyx_GAGmAA17VectorConvertibleRzlF">running</a>
268261
</code>
269262
</div>
270263
<div class="height-container">
@@ -279,26 +272,19 @@ <h4>Declaration</h4>
279272
<h4>Declaration</h4>
280273
<div class="language">
281274
<p class="aside-title">Swift</p>
282-
<pre class="highlight"><code><span class="k">case</span> <span class="n">running</span></code></pre>
275+
<pre class="highlight swift"><code><span class="k">case</span> <span class="n">running</span></code></pre>
283276

284277
</div>
285278
</div>
286-
<div class="slightly-smaller">
287-
<a href="https://github.com/timdonnelly/Advance/tree/master/Source/AnimationRunner.swift#L207">Show on GitHub</a>
288-
</div>
289279
</section>
290280
</div>
291281
</li>
292-
</ul>
293-
</div>
294-
<div class="task-group">
295-
<ul>
296282
<li class="item">
297283
<div>
298284
<code>
299-
<a name="/s:7Advance15AnimationRunnerC5StateO4doneAEyx_GAC6ResultOyx_G6result_tcAGmAA17VectorConvertibleRzlF"></a>
300-
<a name="//apple_ref/swift/Element/done" class="dashAnchor"></a>
301-
<a class="token" href="#/s:7Advance15AnimationRunnerC5StateO4doneAEyx_GAC6ResultOyx_G6result_tcAGmAA17VectorConvertibleRzlF">done</a>
285+
<a name="/s:7Advance15AnimationRunnerC5StateO4doneyAEyx_GAC6ResultOyx_G_tcAGmAA17VectorConvertibleRzlF"></a>
286+
<a name="//apple_ref/swift/Element/done(result:)" class="dashAnchor"></a>
287+
<a class="token" href="#/s:7Advance15AnimationRunnerC5StateO4doneyAEyx_GAC6ResultOyx_G_tcAGmAA17VectorConvertibleRzlF">done(result:)</a>
302288
</code>
303289
</div>
304290
<div class="height-container">
@@ -313,26 +299,19 @@ <h4>Declaration</h4>
313299
<h4>Declaration</h4>
314300
<div class="language">
315301
<p class="aside-title">Swift</p>
316-
<pre class="highlight"><code><span class="k">case</span> <span class="nf">done</span><span class="p">(</span><span class="nv">result</span><span class="p">:</span> <span class="kt"><a href="../../Classes/AnimationRunner/Result.html">Result</a></span><span class="p">)</span></code></pre>
302+
<pre class="highlight swift"><code><span class="k">case</span> <span class="nf">done</span><span class="p">(</span><span class="nv">result</span><span class="p">:</span> <span class="kt"><a href="../../Classes/AnimationRunner/Result.html">Result</a></span><span class="p">)</span></code></pre>
317303

318304
</div>
319305
</div>
320-
<div class="slightly-smaller">
321-
<a href="https://github.com/timdonnelly/Advance/tree/master/Source/AnimationRunner.swift#L210">Show on GitHub</a>
322-
</div>
323306
</section>
324307
</div>
325308
</li>
326-
</ul>
327-
</div>
328-
<div class="task-group">
329-
<ul>
330309
<li class="item">
331310
<div>
332311
<code>
333-
<a name="/s:s9EquatableP2eeoiSbx_xtFZ"></a>
312+
<a name="/s:SQ2eeoiySbx_xtFZ"></a>
334313
<a name="//apple_ref/swift/Method/==(_:_:)" class="dashAnchor"></a>
335-
<a class="token" href="#/s:s9EquatableP2eeoiSbx_xtFZ">==(_:_:)</a>
314+
<a class="token" href="#/s:SQ2eeoiySbx_xtFZ">==(_:_:)</a>
336315
</code>
337316
</div>
338317
<div class="height-container">
@@ -346,13 +325,10 @@ <h4>Declaration</h4>
346325
<h4>Declaration</h4>
347326
<div class="language">
348327
<p class="aside-title">Swift</p>
349-
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="o">==</span><span class="p">(</span><span class="nv">lhs</span><span class="p">:</span> <span class="kt">State</span><span class="p">,</span> <span class="nv">rhs</span><span class="p">:</span> <span class="kt">State</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Bool</span></code></pre>
328+
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="o">==</span> <span class="p">(</span><span class="nv">lhs</span><span class="p">:</span> <span class="kt">State</span><span class="p">,</span> <span class="nv">rhs</span><span class="p">:</span> <span class="kt">State</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Bool</span></code></pre>
350329

351330
</div>
352331
</div>
353-
<div class="slightly-smaller">
354-
<a href="https://github.com/timdonnelly/Advance/tree/master/Source/AnimationRunner.swift#L212-L223">Show on GitHub</a>
355-
</div>
356332
</section>
357333
</div>
358334
</li>
@@ -362,7 +338,7 @@ <h4>Declaration</h4>
362338
</section>
363339
<section id="footer">
364340
<p>© 2018 Tim Donnelly</p>
365-
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.0</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
341+
<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>
366342
</section>
367343
</article>
368344
</div>

0 commit comments

Comments
 (0)