Skip to content

Commit 28f04a8

Browse files
chrsmyschrsmys
authored
Merge pull request #9 from willowtreeapps/feature/updateDocumentation1.0.0
Update the documentation for v1.0.0.
2 parents 4547e16 + d96d020 commit 28f04a8

46 files changed

Lines changed: 744 additions & 110 deletions

Some content is hidden

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

‎docs/Classes.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ <h4>Declaration</h4>
146146
</div>
147147
</div>
148148
<div class="slightly-smaller">
149-
<a href="https://github.com/willowtreeapps/Hyperion-iOS/tree/master//Core/Public/HyperionManager.h#L33-L70">Show on GitHub</a>
149+
<a href="https://github.com/willowtreeapps/Hyperion-iOS/tree/master//Core/Public/HyperionManager.h#L34-L78">Show on GitHub</a>
150150
</div>
151151
</section>
152152
</div>
@@ -306,7 +306,7 @@ <h4>Declaration</h4>
306306
</div>
307307
</div>
308308
<div class="slightly-smaller">
309-
<a href="https://github.com/willowtreeapps/Hyperion-iOS/tree/master//Core/Public/Plugin/SnapShotPlugin/HYPSnapshotInteractionView.h#L30-L43">Show on GitHub</a>
309+
<a href="https://github.com/willowtreeapps/Hyperion-iOS/tree/master//Core/Public/Plugin/SnapShotPlugin/HYPSnapshotInteractionView.h#L30-L56">Show on GitHub</a>
310310
</div>
311311
</section>
312312
</div>
@@ -357,7 +357,7 @@ <h4>Declaration</h4>
357357
</section>
358358
</section>
359359
<section id="footer">
360-
<p>&copy; 2017 <a class="link" href="http://willowtreeapps.com" target="_blank" rel="external">WillowTree</a>. All rights reserved. (Last updated: 2017-12-01)</p>
360+
<p>&copy; 2017 <a class="link" href="http://willowtreeapps.com" target="_blank" rel="external">WillowTree</a>. All rights reserved. (Last updated: 2017-12-03)</p>
361361
<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>
362362
</section>
363363
</article>

‎docs/Classes/HYPPluginHelper.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -192,7 +192,7 @@ <h4>Parameters</h4>
192192
</section>
193193
</section>
194194
<section id="footer">
195-
<p>&copy; 2017 <a class="link" href="http://willowtreeapps.com" target="_blank" rel="external">WillowTree</a>. All rights reserved. (Last updated: 2017-12-01)</p>
195+
<p>&copy; 2017 <a class="link" href="http://willowtreeapps.com" target="_blank" rel="external">WillowTree</a>. All rights reserved. (Last updated: 2017-12-03)</p>
196196
<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>
197197
</section>
198198
</article>

‎docs/Classes/HYPPluginMenuItem.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -299,7 +299,7 @@ <h4>Declaration</h4>
299299
</section>
300300
</section>
301301
<section id="footer">
302-
<p>&copy; 2017 <a class="link" href="http://willowtreeapps.com" target="_blank" rel="external">WillowTree</a>. All rights reserved. (Last updated: 2017-12-01)</p>
302+
<p>&copy; 2017 <a class="link" href="http://willowtreeapps.com" target="_blank" rel="external">WillowTree</a>. All rights reserved. (Last updated: 2017-12-03)</p>
303303
<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>
304304
</section>
305305
</article>

‎docs/Classes/HYPSnapShotInteractionView.html‎

Lines changed: 126 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,8 @@ <h1>HYPSnapshotInteractionView</h1>
141141
<h4>Declaration</h4>
142142
<div class="language">
143143
<p class="aside-title">Objective-C</p>
144-
<pre class="highlight"><code><span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithExtension</span><span class="p">:(</span><span class="n">id</span><span class="o">&lt;</span><span class="n"><a href="../Protocols/HYPPluginExtension.html">HYPPluginExtension</a></span><span class="o">&gt;</span><span class="p">)</span><span class="nv">extension</span><span class="p">;</span></code></pre>
144+
<pre class="highlight"><code><span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span> <span class="n">_Nonnull</span><span class="p">)</span><span class="nf">initWithExtension</span><span class="p">:</span>
145+
<span class="p">(</span><span class="n">id</span><span class="o">&lt;</span><span class="n"><a href="../Protocols/HYPPluginExtension.html">HYPPluginExtension</a></span><span class="o">&gt;</span> <span class="n">_Nullable</span><span class="p">)</span><span class="nv">extension</span><span class="p">;</span></code></pre>
145146

146147
</div>
147148
</div>
@@ -170,6 +171,127 @@ <h4>Parameters</h4>
170171
</section>
171172
</div>
172173
</li>
174+
<li class="item">
175+
<div>
176+
<code>
177+
<a name="/c:objc(cs)HYPSnapshotInteractionView(im)interactionViewWillTransitionToSize:withTransitionCoordinator:"></a>
178+
<a name="//apple_ref/objc/Method/-interactionViewWillTransitionToSize:withTransitionCoordinator:" class="dashAnchor"></a>
179+
<a class="token" href="#/c:objc(cs)HYPSnapshotInteractionView(im)interactionViewWillTransitionToSize:withTransitionCoordinator:">-interactionViewWillTransitionToSize:withTransitionCoordinator:</a>
180+
</code>
181+
</div>
182+
<div class="height-container">
183+
<div class="pointer-container"></div>
184+
<section class="section">
185+
<div class="pointer"></div>
186+
<div class="abstract">
187+
<p>Called when the interaction view is about to change size.</p>
188+
189+
</div>
190+
<div class="declaration">
191+
<h4>Declaration</h4>
192+
<div class="language">
193+
<p class="aside-title">Objective-C</p>
194+
<pre class="highlight"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">interactionViewWillTransitionToSize</span><span class="p">:(</span><span class="n">CGSize</span><span class="p">)</span><span class="nv">size</span>
195+
<span class="nf">withTransitionCoordinator</span><span class="p">:(</span><span class="n">id</span> <span class="n">_Nullable</span><span class="p">)</span><span class="nv">coordinator</span><span class="p">;</span></code></pre>
196+
197+
</div>
198+
<div class="language">
199+
<p class="aside-title">Swift</p>
200+
<pre class="highlight"><code><span class="kd">func</span> <span class="nf">interactionViewWillTransition</span><span class="p">(</span><span class="n">toSize</span> <span class="nv">size</span><span class="p">:</span> <span class="kt">Any</span><span class="o">!</span><span class="p">,</span> <span class="n">withTransitionCoordinator</span> <span class="nv">coordinator</span><span class="p">:</span> <span class="kt">Any</span><span class="p">?)</span></code></pre>
201+
202+
</div>
203+
</div>
204+
<div>
205+
<h4>Parameters</h4>
206+
<table class="graybox">
207+
<tbody>
208+
<tr>
209+
<td>
210+
<code>
211+
<em>size</em>
212+
</code>
213+
</td>
214+
<td>
215+
<div>
216+
<p>The size that the interaction view is about to change to.</p>
217+
</div>
218+
</td>
219+
</tr>
220+
<tr>
221+
<td>
222+
<code>
223+
<em>coordinator</em>
224+
</code>
225+
</td>
226+
<td>
227+
<div>
228+
<p>The transition coordinator allows you to animate views in sync with the size change.</p>
229+
</div>
230+
</td>
231+
</tr>
232+
</tbody>
233+
</table>
234+
</div>
235+
<div class="slightly-smaller">
236+
<a href="https://github.com/willowtreeapps/Hyperion-iOS/tree/master//Core/Public/Plugin/SnapShotPlugin/HYPSnapshotInteractionView.h#L43">Show on GitHub</a>
237+
</div>
238+
</section>
239+
</div>
240+
</li>
241+
<li class="item">
242+
<div>
243+
<code>
244+
<a name="/c:objc(cs)HYPSnapshotInteractionView(im)interactionViewDidTransitionToSize:"></a>
245+
<a name="//apple_ref/objc/Method/-interactionViewDidTransitionToSize:" class="dashAnchor"></a>
246+
<a class="token" href="#/c:objc(cs)HYPSnapshotInteractionView(im)interactionViewDidTransitionToSize:">-interactionViewDidTransitionToSize:</a>
247+
</code>
248+
</div>
249+
<div class="height-container">
250+
<div class="pointer-container"></div>
251+
<section class="section">
252+
<div class="pointer"></div>
253+
<div class="abstract">
254+
<p>Called when the interaction view has changed size.</p>
255+
256+
</div>
257+
<div class="declaration">
258+
<h4>Declaration</h4>
259+
<div class="language">
260+
<p class="aside-title">Objective-C</p>
261+
<pre class="highlight"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">interactionViewDidTransitionToSize</span><span class="p">:(</span><span class="n">CGSize</span><span class="p">)</span><span class="nv">size</span><span class="p">;</span></code></pre>
262+
263+
</div>
264+
<div class="language">
265+
<p class="aside-title">Swift</p>
266+
<pre class="highlight"><code><span class="kd">func</span> <span class="nf">interactionViewDidTransition</span><span class="p">(</span><span class="n">toSize</span> <span class="nv">size</span><span class="p">:</span> <span class="kt">Any</span><span class="o">!</span><span class="p">)</span></code></pre>
267+
268+
</div>
269+
</div>
270+
<div>
271+
<h4>Parameters</h4>
272+
<table class="graybox">
273+
<tbody>
274+
<tr>
275+
<td>
276+
<code>
277+
<em>size</em>
278+
</code>
279+
</td>
280+
<td>
281+
<div>
282+
<p>The size that the interaction view has changed to.</p>
283+
</div>
284+
</td>
285+
</tr>
286+
</tbody>
287+
</table>
288+
</div>
289+
<div class="slightly-smaller">
290+
<a href="https://github.com/willowtreeapps/Hyperion-iOS/tree/master//Core/Public/Plugin/SnapShotPlugin/HYPSnapshotInteractionView.h#L49">Show on GitHub</a>
291+
</div>
292+
</section>
293+
</div>
294+
</li>
173295
<li class="item">
174296
<div>
175297
<code>
@@ -190,12 +312,12 @@ <h4>Parameters</h4>
190312
<h4>Declaration</h4>
191313
<div class="language">
192314
<p class="aside-title">Objective-C</p>
193-
<pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">id</span><span class="o">&lt;</span><span class="n"><a href="../Protocols/HYPPluginExtension.html">HYPPluginExtension</a></span><span class="o">&gt;</span> <span class="n">extension</span><span class="p">;</span></code></pre>
315+
<pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">id</span><span class="o">&lt;</span><span class="n"><a href="../Protocols/HYPPluginExtension.html">HYPPluginExtension</a></span><span class="o">&gt;</span> <span class="n">extension</span><span class="p">;</span></code></pre>
194316

195317
</div>
196318
</div>
197319
<div class="slightly-smaller">
198-
<a href="https://github.com/willowtreeapps/Hyperion-iOS/tree/master//Core/Public/Plugin/SnapShotPlugin/HYPSnapshotInteractionView.h#L41">Show on GitHub</a>
320+
<a href="https://github.com/willowtreeapps/Hyperion-iOS/tree/master//Core/Public/Plugin/SnapShotPlugin/HYPSnapshotInteractionView.h#L54">Show on GitHub</a>
199321
</div>
200322
</section>
201323
</div>
@@ -205,7 +327,7 @@ <h4>Declaration</h4>
205327
</section>
206328
</section>
207329
<section id="footer">
208-
<p>&copy; 2017 <a class="link" href="http://willowtreeapps.com" target="_blank" rel="external">WillowTree</a>. All rights reserved. (Last updated: 2017-12-01)</p>
330+
<p>&copy; 2017 <a class="link" href="http://willowtreeapps.com" target="_blank" rel="external">WillowTree</a>. All rights reserved. (Last updated: 2017-12-03)</p>
209331
<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>
210332
</section>
211333
</article>

‎docs/Classes/HYPSnapshotPluginModule.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -282,7 +282,7 @@ <h4>Return Value</h4>
282282
</section>
283283
</section>
284284
<section id="footer">
285-
<p>&copy; 2017 <a class="link" href="http://willowtreeapps.com" target="_blank" rel="external">WillowTree</a>. All rights reserved. (Last updated: 2017-12-01)</p>
285+
<p>&copy; 2017 <a class="link" href="http://willowtreeapps.com" target="_blank" rel="external">WillowTree</a>. All rights reserved. (Last updated: 2017-12-03)</p>
286286
<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>
287287
</section>
288288
</article>

0 commit comments

Comments
 (0)