Skip to content

Commit

Permalink
Update the documentation for v1.0.0.
Browse files Browse the repository at this point in the history
  • Loading branch information
@chrsmys
chrsmys committed Dec 4, 2017
1 parent 82e35f9 commit d96d020
Show file tree
Hide file tree
Showing 46 changed files with 744 additions and 110 deletions.
6 changes: 3 additions & 3 deletions docs/Classes.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ <h4>Declaration</h4>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/willowtreeapps/Hyperion-iOS/tree/master//Core/Public/HyperionManager.h#L33-L70">Show on GitHub</a>
<a href="https://github.com/willowtreeapps/Hyperion-iOS/tree/master//Core/Public/HyperionManager.h#L34-L78">Show on GitHub</a>
</div>
</section>
</div>
Expand Down Expand Up @@ -306,7 +306,7 @@ <h4>Declaration</h4>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/willowtreeapps/Hyperion-iOS/tree/master//Core/Public/Plugin/SnapShotPlugin/HYPSnapshotInteractionView.h#L30-L43">Show on GitHub</a>
<a href="https://github.com/willowtreeapps/Hyperion-iOS/tree/master//Core/Public/Plugin/SnapShotPlugin/HYPSnapshotInteractionView.h#L30-L56">Show on GitHub</a>
</div>
</section>
</div>
Expand Down Expand Up @@ -357,7 +357,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<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>
<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>
<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>
</section>
</article>
Expand Down
2 changes: 1 addition & 1 deletion docs/Classes/HYPPluginHelper.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,7 @@ <h4>Parameters</h4>
</section>
</section>
<section id="footer">
<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>
<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>
<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>
</section>
</article>
Expand Down
2 changes: 1 addition & 1 deletion docs/Classes/HYPPluginMenuItem.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -299,7 +299,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<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>
<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>
<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>
</section>
</article>
Expand Down
130 changes: 126 additions & 4 deletions docs/Classes/HYPSnapShotInteractionView.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,8 @@ <h1>HYPSnapshotInteractionView</h1>
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Objective-C</p>
<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>
<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>
<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>

</div>
</div>
Expand Down Expand Up @@ -170,6 +171,127 @@ <h4>Parameters</h4>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/c:objc(cs)HYPSnapshotInteractionView(im)interactionViewWillTransitionToSize:withTransitionCoordinator:"></a>
<a name="//apple_ref/objc/Method/-interactionViewWillTransitionToSize:withTransitionCoordinator:" class="dashAnchor"></a>
<a class="token" href="#/c:objc(cs)HYPSnapshotInteractionView(im)interactionViewWillTransitionToSize:withTransitionCoordinator:">-interactionViewWillTransitionToSize:withTransitionCoordinator:</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Called when the interaction view is about to change size.</p>

</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Objective-C</p>
<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>
<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>

</div>
<div class="language">
<p class="aside-title">Swift</p>
<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>

</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>size</em>
</code>
</td>
<td>
<div>
<p>The size that the interaction view is about to change to.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>coordinator</em>
</code>
</td>
<td>
<div>
<p>The transition coordinator allows you to animate views in sync with the size change.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="slightly-smaller">
<a href="https://github.com/willowtreeapps/Hyperion-iOS/tree/master//Core/Public/Plugin/SnapShotPlugin/HYPSnapshotInteractionView.h#L43">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/c:objc(cs)HYPSnapshotInteractionView(im)interactionViewDidTransitionToSize:"></a>
<a name="//apple_ref/objc/Method/-interactionViewDidTransitionToSize:" class="dashAnchor"></a>
<a class="token" href="#/c:objc(cs)HYPSnapshotInteractionView(im)interactionViewDidTransitionToSize:">-interactionViewDidTransitionToSize:</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Called when the interaction view has changed size.</p>

</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Objective-C</p>
<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>

</div>
<div class="language">
<p class="aside-title">Swift</p>
<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>

</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>size</em>
</code>
</td>
<td>
<div>
<p>The size that the interaction view has changed to.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="slightly-smaller">
<a href="https://github.com/willowtreeapps/Hyperion-iOS/tree/master//Core/Public/Plugin/SnapShotPlugin/HYPSnapshotInteractionView.h#L49">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
Expand All @@ -190,12 +312,12 @@ <h4>Parameters</h4>
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Objective-C</p>
<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>
<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>

</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/willowtreeapps/Hyperion-iOS/tree/master//Core/Public/Plugin/SnapShotPlugin/HYPSnapshotInteractionView.h#L41">Show on GitHub</a>
<a href="https://github.com/willowtreeapps/Hyperion-iOS/tree/master//Core/Public/Plugin/SnapShotPlugin/HYPSnapshotInteractionView.h#L54">Show on GitHub</a>
</div>
</section>
</div>
Expand All @@ -205,7 +327,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<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>
<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>
<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>
</section>
</article>
Expand Down
2 changes: 1 addition & 1 deletion docs/Classes/HYPSnapshotPluginModule.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -282,7 +282,7 @@ <h4>Return Value</h4>
</section>
</section>
<section id="footer">
<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>
<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>
<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>
</section>
</article>
Expand Down
Loading

0 comments on commit d96d020

Please sign in to comment.