Skip to content

Commit a25fded

Browse files
DBenYaakovDBenYaakov
committed
Documentation updated
1 parent 00b4f65 commit a25fded

28 files changed

Lines changed: 3065 additions & 55 deletions

File tree

‎docs/Animation/index.html‎

Lines changed: 128 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1198,7 +1198,7 @@
11981198
<nav>
11991199
<div class="wrapper">
12001200
<h2>On This Page</h2>
1201-
<ol><li><a href="#relationships">Relationships</a><ul><li><a href="#relationships">Conforms To</a></li></ul></li><li><a href="#initializers">Initializers</a><ul><li class="initializer"><a href="#animation.init(tween:)">init(tween:​)</a></li></ul></li><li><a href="#properties">Properties</a><ul><li class="property"><a href="#animation.iscompleted">is​Completed</a></li></ul></li><li><a href="#methods">Methods</a><ul><li class="method"><a href="#animation.terminate()">terminate()</a></li><li class="method"><a href="#animation.pause()">pause()</a></li><li class="method"><a href="#animation.play()">play()</a></li><li class="method"><a href="#animation.==(lhs:rhs:)">==(lhs:​rhs:​)</a></li></ul></li></ol>
1201+
<ol><li><a href="#relationships">Relationships</a><ul><li><a href="#relationships">Conforms To</a></li></ul></li><li><a href="#initializers">Initializers</a><ul><li class="initializer"><a href="#animation.init(tween:)">init(tween:​)</a></li></ul></li><li><a href="#properties">Properties</a><ul><li class="property"><a href="#animation.loop">loop</a></li><li class="property"><a href="#animation.reverse">reverse</a></li><li class="property"><a href="#animation.iscompleted">is​Completed</a></li><li class="property"><a href="#animation.ispaused">is​Paused</a></li><li class="property"><a href="#animation.isplaying">is​Playing</a></li><li class="property"><a href="#animation.isqueued">is​Queued</a></li><li class="property"><a href="#animation.inverse">inverse</a></li></ul></li><li><a href="#methods">Methods</a><ul><li class="method"><a href="#animation.terminate()">terminate()</a></li><li class="method"><a href="#animation.pause()">pause()</a></li><li class="method"><a href="#animation.play()">play()</a></li><li class="method"><a href="#animation.restart()">restart()</a></li><li class="method"><a href="#animation.==(lhs:rhs:)">==(lhs:​rhs:​)</a></li></ul></li></ol>
12021202
</div>
12031203
</nav>
12041204

@@ -1210,6 +1210,10 @@ <h1>
12101210
</h1>
12111211

12121212
<html><body><pre class="highlight"><code><span class="keyword">public</span> <span class="keyword">class</span> <span class="type">Animation</span>: <span class="type">Equatable</span></code></pre></body></html>
1213+
<div class="summary" role="doc-abstract">
1214+
<p>An 'Animation' is used to animate elements using the 'AnimationManager'.</p>
1215+
1216+
</div>
12131217
<section id="relationships">
12141218
<h2 hidden>Relationships</h2>
12151219

@@ -1226,16 +1230,107 @@ <h3>
12261230
<code>init(tween:​)</code>
12271231
</h3>
12281232
<html><body><pre class="highlight"><code><span class="keyword">public</span> <span class="keyword">init</span>(<span class="variable">tween</span>: <a href="TweenProtocol"><span class="type">TweenProtocol</span></a>)</code></pre></body></html>
1233+
<div class="summary" role="doc-abstract">
1234+
<p>Creates a new 'Animation' from the specified 'Tween'</p>
1235+
1236+
</div>
1237+
<h4>Parameters</h4>
1238+
1239+
<table class="parameters">
1240+
<thead hidden>
1241+
<tr>
1242+
<th>Name</th>
1243+
<th>Type</th>
1244+
<th>Description</th>
1245+
</tr>
1246+
</thead>
1247+
<tbody>
1248+
<tr>
1249+
<th>tween</th>
1250+
<td><code class="type">Tween​Protocol</code></td></td>
1251+
<td><p>The 'Tween'</p>
1252+
</td>
1253+
</tr>
1254+
</tbody>
1255+
</table>
12291256
</div>
12301257
</section>
12311258
<section id="properties">
12321259
<h2>Properties</h2>
12331260

1234-
<div role="article" class="class" id="animation.iscompleted">
1261+
<div role="article" class="class" id="animation.loop">
1262+
<h3>
1263+
<code>loop</code>
1264+
</h3>
1265+
<html><body><pre class="highlight"><code><span class="keyword">var</span> <span class="variable">loop</span></code></pre></body></html>
1266+
<div class="summary" role="doc-abstract">
1267+
<p>Specifies whether or not to loop the animation over and over again until 'terminate()' is called.</p>
1268+
1269+
</div>
1270+
</div>
1271+
<div role="article" class="class" id="animation.reverse">
1272+
<h3>
1273+
<code>reverse</code>
1274+
</h3>
1275+
<html><body><pre class="highlight"><code><span class="keyword">var</span> <span class="variable">reverse</span></code></pre></body></html>
1276+
<div class="summary" role="doc-abstract">
1277+
<p>Specifies whether or not to reverse the animation after the animation is completete.</p>
1278+
1279+
</div>
1280+
</div>
1281+
<div role="article" class="class" id="animation.iscompleted">
12351282
<h3>
12361283
<code>is​Completed</code>
12371284
</h3>
12381285
<html><body><pre class="highlight"><code><span class="keyword">var</span> <span class="variable">isCompleted</span>: <span class="type">Bool</span></code></pre></body></html>
1286+
<div class="summary" role="doc-abstract">
1287+
<p>returns true if the animation was completed or cancelled</p>
1288+
1289+
</div>
1290+
<div class="discussion">
1291+
<html><body><p>NB: will only return true for one frame when animation is completed</p>
1292+
</body></html>
1293+
</div>
1294+
</div>
1295+
<div role="article" class="class" id="animation.ispaused">
1296+
<h3>
1297+
<code>is​Paused</code>
1298+
</h3>
1299+
<html><body><pre class="highlight"><code><span class="keyword">var</span> <span class="variable">isPaused</span>: <span class="type">Bool</span></code></pre></body></html>
1300+
<div class="summary" role="doc-abstract">
1301+
<p>returns true if the animation is currently paused</p>
1302+
1303+
</div>
1304+
</div>
1305+
<div role="article" class="class" id="animation.isplaying">
1306+
<h3>
1307+
<code>is​Playing</code>
1308+
</h3>
1309+
<html><body><pre class="highlight"><code><span class="keyword">var</span> <span class="variable">isPlaying</span>: <span class="type">Bool</span></code></pre></body></html>
1310+
<div class="summary" role="doc-abstract">
1311+
<p>returns true if the animation is currently playing</p>
1312+
1313+
</div>
1314+
</div>
1315+
<div role="article" class="class" id="animation.isqueued">
1316+
<h3>
1317+
<code>is​Queued</code>
1318+
</h3>
1319+
<html><body><pre class="highlight"><code><span class="keyword">var</span> <span class="variable">isQueued</span>: <span class="type">Bool</span></code></pre></body></html>
1320+
<div class="summary" role="doc-abstract">
1321+
<p>returns true if the animation isPlaying, isPaused, or isCompleted.</p>
1322+
1323+
</div>
1324+
</div>
1325+
<div role="article" class="class" id="animation.inverse">
1326+
<h3>
1327+
<code>inverse</code>
1328+
</h3>
1329+
<html><body><pre class="highlight"><code><span class="keyword">var</span> <span class="variable">inverse</span>: <a href="Animation"><span class="type">Animation</span></a></code></pre></body></html>
1330+
<div class="summary" role="doc-abstract">
1331+
<p>returns the inverted version of the animation ie. the 'EasingStyle' is inverted and the start and end values are swapped.</p>
1332+
1333+
</div>
12391334
</div>
12401335
</section>
12411336
<section id="methods">
@@ -1246,24 +1341,54 @@ <h3>
12461341
<code>terminate()</code>
12471342
</h3>
12481343
<html><body><pre class="highlight"><code><span class="keyword">public</span> <span class="keyword">func</span> <span class="function">terminate</span>()</code></pre></body></html>
1344+
<div class="summary" role="doc-abstract">
1345+
<p>Stops the animation and removes it from the 'AnimationManager'</p>
1346+
1347+
</div>
12491348
</div>
12501349
<div role="article" class="class" id="animation.pause()">
12511350
<h3>
12521351
<code>pause()</code>
12531352
</h3>
12541353
<html><body><pre class="highlight"><code><span class="keyword">public</span> <span class="keyword">func</span> <span class="function">pause</span>()</code></pre></body></html>
1354+
<div class="summary" role="doc-abstract">
1355+
<p>Pauses the animation</p>
1356+
1357+
</div>
12551358
</div>
12561359
<div role="article" class="class" id="animation.play()">
12571360
<h3>
12581361
<code>play()</code>
12591362
</h3>
12601363
<html><body><pre class="highlight"><code><span class="keyword">public</span> <span class="keyword">func</span> <span class="function">play</span>()</code></pre></body></html>
1364+
<div class="summary" role="doc-abstract">
1365+
<p>Plays the animation</p>
1366+
1367+
</div>
1368+
<div class="discussion">
1369+
<html><body><p>NB: Only plays if already added to 'AnimationManager'</p>
1370+
</body></html>
1371+
</div>
1372+
</div>
1373+
<div role="article" class="class" id="animation.restart()">
1374+
<h3>
1375+
<code>restart()</code>
1376+
</h3>
1377+
<html><body><pre class="highlight"><code><span class="keyword">public</span> <span class="keyword">func</span> <span class="function">restart</span>()</code></pre></body></html>
1378+
<div class="summary" role="doc-abstract">
1379+
<p>Restarts the animation to the initial value as specified in the 'Tween'.</p>
1380+
1381+
</div>
12611382
</div>
12621383
<div role="article" class="class" id="animation.==(lhs:rhs:)">
12631384
<h3>
12641385
<code>==(lhs:​rhs:​)</code>
12651386
</h3>
12661387
<html><body><pre class="highlight"><code><span class="keyword">static</span> <span class="keyword">public</span> <span class="keyword">func</span> ==(<span class="variable">lhs</span>: <a href="Animation"><span class="type">Animation</span></a>, <span class="variable">rhs</span>: <a href="Animation"><span class="type">Animation</span></a>) -&gt; <span class="type">Bool</span></code></pre></body></html>
1388+
<div class="summary" role="doc-abstract">
1389+
<p>Equivalence operator for two 'Animation's.</p>
1390+
1391+
</div>
12671392
</div>
12681393
</section>
12691394

@@ -1274,7 +1399,7 @@ <h3>
12741399

12751400
<footer>
12761401
<p>
1277-
Generated on <time datetime="2020-04-23T10:04:15-0500">April 23, 2020</time> using <a href="https://github.com/SwiftDocOrg/swift-doc">swift-doc</a>.
1402+
Generated on <time datetime="2020-04-29T20:23:08-0500">April 29, 2020</time> using <a href="https://github.com/SwiftDocOrg/swift-doc">swift-doc</a>.
12781403
</p>
12791404
</footer>
12801405
</body>

‎docs/AnimationManager/index.html‎

Lines changed: 95 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1198,7 +1198,7 @@
11981198
<nav>
11991199
<div class="wrapper">
12001200
<h2>On This Page</h2>
1201-
<ol><li><a href="#methods">Methods</a><ul><li class="method"><a href="#animationmanager.run(animation:autoplay:)">run(animation:​auto​Play:​)</a></li><li class="method"><a href="#animationmanager.getvalue(ease:percent:)">get​Value(ease:​percent:​)</a></li><li class="method"><a href="#animationmanager.terminateall()">terminate​All()</a></li><li class="method"><a href="#animationmanager.pauseall()">pause​All()</a></li><li class="method"><a href="#animationmanager.playall()">play​All()</a></li></ul></li></ol>
1201+
<ol><li><a href="#methods">Methods</a><ul><li class="method"><a href="#animationmanager.getvalue(ease:percent:)">get​Value(ease:​percent:​)</a></li><li class="method"><a href="#animationmanager.run(animation:autoplay:)">run(animation:​auto​Play:​)</a></li><li class="method"><a href="#animationmanager.terminateall()">terminate​All()</a></li><li class="method"><a href="#animationmanager.pauseall()">pause​All()</a></li><li class="method"><a href="#animationmanager.playall()">play​All()</a></li><li class="method"><a href="#animationmanager.restartall()">restart​All()</a></li></ul></li></ol>
12021202
</div>
12031203
</nav>
12041204

@@ -1210,39 +1210,126 @@ <h1>
12101210
</h1>
12111211

12121212
<html><body><pre class="highlight"><code><span class="keyword">public</span> <span class="keyword">class</span> <span class="type">AnimationManager</span></code></pre></body></html>
1213+
<div class="summary" role="doc-abstract">
1214+
<p>The 'AnimationManager' handles the queuing and updating of 'Animation's.</p>
1215+
1216+
</div>
12131217

12141218
<section id="methods">
12151219
<h2>Methods</h2>
12161220

1217-
<div role="article" class="class" id="animationmanager.run(animation:autoplay:)">
1221+
<div role="article" class="class" id="animationmanager.getvalue(ease:percent:)">
12181222
<h3>
1219-
<code>run(animation:​auto​Play:​)</code>
1223+
<code>get​Value(ease:​percent:​)</code>
12201224
</h3>
1221-
<html><body><pre class="highlight"><code><span class="keyword">public</span> <span class="keyword">func</span> <span class="function">run</span>(<span class="variable">animation</span>: <a href="Animation"><span class="type">Animation</span></a>, <span class="variable">autoPlay</span>: <span class="type">Bool</span> = <span class="keyword">true</span>)</code></pre></body></html>
1225+
<html><body><pre class="highlight"><code><span class="keyword">public</span> <span class="keyword">func</span> <span class="function">getValue</span>(<span class="variable">ease</span>: <a href="EasingStyle"><span class="type">EasingStyle</span></a>, <span class="variable">percent</span>: <span class="type">Double</span>) -&gt; <span class="type">Double</span></code></pre></body></html>
1226+
<div class="summary" role="doc-abstract">
1227+
<p>Allows for you to retrieve an altered percent represented by an 'EasingStyle'</p>
1228+
12221229
</div>
1223-
<div role="article" class="class" id="animationmanager.getvalue(ease:percent:)">
1230+
<h4>Parameters</h4>
1231+
1232+
<table class="parameters">
1233+
<thead hidden>
1234+
<tr>
1235+
<th>Name</th>
1236+
<th>Type</th>
1237+
<th>Description</th>
1238+
</tr>
1239+
</thead>
1240+
<tbody>
1241+
<tr>
1242+
<th>ease</th>
1243+
<td><code class="type">Easing​Style</code></td></td>
1244+
<td><p>The 'EasingStyle' to retrieve an altered percent from</p>
1245+
</td>
1246+
</tr>
1247+
<tr>
1248+
<th>percent</th>
1249+
<td><code class="type">Double</code></td></td>
1250+
<td><p>The percent to apply to the ease</p>
1251+
</td>
1252+
</tr>
1253+
</tbody>
1254+
</table>
1255+
<h4>Returns</h4>
1256+
<p>A new percent as altered by the ease</p>
1257+
1258+
</div>
1259+
<div role="article" class="class" id="animationmanager.run(animation:autoplay:)">
12241260
<h3>
1225-
<code>get​Value(ease:​percent:​)</code>
1261+
<code>run(animation:​auto​Play:​)</code>
12261262
</h3>
1227-
<html><body><pre class="highlight"><code><span class="keyword">public</span> <span class="keyword">func</span> <span class="function">getValue</span>(<span class="variable">ease</span>: <a href="EasingStyle"><span class="type">EasingStyle</span></a>, <span class="variable">percent</span>: <span class="type">Double</span>) -&gt; <span class="type">Double</span></code></pre></body></html>
1263+
<html><body><pre class="highlight"><code><span class="keyword">public</span> <span class="keyword">func</span> <span class="function">run</span>(<span class="variable">animation</span>: <a href="Animation"><span class="type">Animation</span></a>, <span class="variable">autoPlay</span>: <span class="type">Bool</span> = <span class="keyword">true</span>)</code></pre></body></html>
1264+
<div class="summary" role="doc-abstract">
1265+
<p>Adds a new 'Animation' to the 'AnimationManager' for updating</p>
1266+
1267+
</div>
1268+
<h4>Parameters</h4>
1269+
1270+
<table class="parameters">
1271+
<thead hidden>
1272+
<tr>
1273+
<th>Name</th>
1274+
<th>Type</th>
1275+
<th>Description</th>
1276+
</tr>
1277+
</thead>
1278+
<tbody>
1279+
<tr>
1280+
<th>animation</th>
1281+
<td><code class="type">Animation</code></td></td>
1282+
<td><p>The 'Animation' to add</p>
1283+
</td>
1284+
</tr>
1285+
<tr>
1286+
<th>auto​Play</th>
1287+
<td><code class="type">Bool</code></td></td>
1288+
<td><p>Whether or not to automatically begin playing the animation upon registering it</p>
1289+
</td>
1290+
</tr>
1291+
</tbody>
1292+
</table>
12281293
</div>
12291294
<div role="article" class="class" id="animationmanager.terminateall()">
12301295
<h3>
12311296
<code>terminate​All()</code>
12321297
</h3>
12331298
<html><body><pre class="highlight"><code><span class="keyword">public</span> <span class="keyword">func</span> <span class="function">terminateAll</span>()</code></pre></body></html>
1299+
<div class="summary" role="doc-abstract">
1300+
<p>Calls the terminate() function on all registered 'Animation's</p>
1301+
1302+
</div>
12341303
</div>
12351304
<div role="article" class="class" id="animationmanager.pauseall()">
12361305
<h3>
12371306
<code>pause​All()</code>
12381307
</h3>
12391308
<html><body><pre class="highlight"><code><span class="keyword">public</span> <span class="keyword">func</span> <span class="function">pauseAll</span>()</code></pre></body></html>
1309+
<div class="summary" role="doc-abstract">
1310+
<p>Calls the pause() function on all registered 'Animation's</p>
1311+
1312+
</div>
12401313
</div>
12411314
<div role="article" class="class" id="animationmanager.playall()">
12421315
<h3>
12431316
<code>play​All()</code>
12441317
</h3>
12451318
<html><body><pre class="highlight"><code><span class="keyword">public</span> <span class="keyword">func</span> <span class="function">playAll</span>()</code></pre></body></html>
1319+
<div class="summary" role="doc-abstract">
1320+
<p>Calls the play() function on all registered 'Animation's</p>
1321+
1322+
</div>
1323+
</div>
1324+
<div role="article" class="class" id="animationmanager.restartall()">
1325+
<h3>
1326+
<code>restart​All()</code>
1327+
</h3>
1328+
<html><body><pre class="highlight"><code><span class="keyword">public</span> <span class="keyword">func</span> <span class="function">restartAll</span>()</code></pre></body></html>
1329+
<div class="summary" role="doc-abstract">
1330+
<p>Calls the restart() function on all registered 'Animation's</p>
1331+
1332+
</div>
12461333
</div>
12471334
</section>
12481335

@@ -1253,7 +1340,7 @@ <h3>
12531340

12541341
<footer>
12551342
<p>
1256-
Generated on <time datetime="2020-04-23T10:04:15-0500">April 23, 2020</time> using <a href="https://github.com/SwiftDocOrg/swift-doc">swift-doc</a>.
1343+
Generated on <time datetime="2020-04-29T20:23:08-0500">April 29, 2020</time> using <a href="https://github.com/SwiftDocOrg/swift-doc">swift-doc</a>.
12571344
</p>
12581345
</footer>
12591346
</body>

‎docs/CanvasResizeHandler/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1237,7 +1237,7 @@ <h3>
12371237

12381238
<footer>
12391239
<p>
1240-
Generated on <time datetime="2020-04-23T10:04:15-0500">April 23, 2020</time> using <a href="https://github.com/SwiftDocOrg/swift-doc">swift-doc</a>.
1240+
Generated on <time datetime="2020-04-29T20:23:08-0500">April 29, 2020</time> using <a href="https://github.com/SwiftDocOrg/swift-doc">swift-doc</a>.
12411241
</p>
12421242
</footer>
12431243
</body>

‎docs/Director/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1359,7 +1359,7 @@ <h3>
13591359

13601360
<footer>
13611361
<p>
1362-
Generated on <time datetime="2020-04-23T10:04:15-0500">April 23, 2020</time> using <a href="https://github.com/SwiftDocOrg/swift-doc">swift-doc</a>.
1362+
Generated on <time datetime="2020-04-29T20:23:08-0500">April 29, 2020</time> using <a href="https://github.com/SwiftDocOrg/swift-doc">swift-doc</a>.
13631363
</p>
13641364
</footer>
13651365
</body>

‎docs/Dispatcher/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1385,7 +1385,7 @@ <h3>
13851385

13861386
<footer>
13871387
<p>
1388-
Generated on <time datetime="2020-04-23T10:04:15-0500">April 23, 2020</time> using <a href="https://github.com/SwiftDocOrg/swift-doc">swift-doc</a>.
1388+
Generated on <time datetime="2020-04-29T20:23:08-0500">April 29, 2020</time> using <a href="https://github.com/SwiftDocOrg/swift-doc">swift-doc</a>.
13891389
</p>
13901390
</footer>
13911391
</body>

0 commit comments

Comments
 (0)