Skip to content

Commit

Permalink
Update documentation for v3.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
Aaron McTavish committed Apr 25, 2019
1 parent b4834e1 commit f0984f6
Show file tree
Hide file tree
Showing 11 changed files with 146 additions and 107 deletions.
11 changes: 6 additions & 5 deletions docs/Classes.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
</head>
<body>

<a name="//apple_ref/swift/Section/Classes" class="dashAnchor"></a>

<a title="Classes Reference"></a>

Expand Down Expand Up @@ -76,9 +77,9 @@ <h1>Classes</h1>
<li class="item">
<div>
<code>
<a name="/s:C23BaseViewControllerSwift18BaseViewController"></a>
<a name="/s:23BaseViewControllerSwift0abC0C"></a>
<a name="//apple_ref/swift/Class/BaseViewController" class="dashAnchor"></a>
<a class="token" href="#/s:C23BaseViewControllerSwift18BaseViewController">BaseViewController</a>
<a class="token" href="#/s:23BaseViewControllerSwift0abC0C">BaseViewController</a>
</code>
</div>
<div class="height-container">
Expand All @@ -94,7 +95,7 @@ <h1>Classes</h1>
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="n">open</span> <span class="kd">class</span> <span class="kt">BaseViewController</span><span class="o">&lt;</span><span class="kt">T</span> <span class="p">:</span> <span class="kt">UIView</span><span class="o">&gt;</span><span class="p">:</span> <span class="kt">UIViewController</span></code></pre>
<pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">BaseViewController</span><span class="o">&lt;</span><span class="kt">T</span><span class="o">&gt;</span> <span class="p">:</span> <span class="kt">UIViewController</span> <span class="k">where</span> <span class="kt">T</span> <span class="p">:</span> <span class="kt">UIView</span></code></pre>

</div>
</div>
Expand All @@ -109,8 +110,8 @@ <h4>Declaration</h4>
</article>
</div>
<section class="footer">
<p>&copy; 2017 <a class="link" href="https://ustwo.com/" target="_blank" rel="external">ustwo Fampany Ltd.</a>. All rights reserved. (Last updated: 2017-03-20)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.7.4</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
<p>&copy; 2019 <a class="link" href="https://ustwo.com/" target="_blank" rel="external">ustwo Fampany Ltd.</a>. All rights reserved. (Last updated: 2019-04-25)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
</div>
Expand Down
48 changes: 24 additions & 24 deletions docs/Classes/BaseViewController.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@
<h1>BaseViewController</h1>
<div class="declaration">
<div class="language">
<pre class="highlight"><code><span class="n">open</span> <span class="kd">class</span> <span class="kt">BaseViewController</span><span class="o">&lt;</span><span class="kt">T</span> <span class="p">:</span> <span class="kt">UIView</span><span class="o">&gt;</span><span class="p">:</span> <span class="kt">UIViewController</span></code></pre>
<pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">BaseViewController</span><span class="o">&lt;</span><span class="kt">T</span><span class="o">&gt;</span> <span class="p">:</span> <span class="kt">UIViewController</span> <span class="k">where</span> <span class="kt">T</span> <span class="p">:</span> <span class="kt">UIView</span></code></pre>

</div>
</div>
Expand All @@ -90,9 +90,9 @@ <h3 class="section-name">Properties</h3>
<li class="item">
<div>
<code>
<a name="/s:vC23BaseViewControllerSwift18BaseViewController14underlyingViewx"></a>
<a name="/s:23BaseViewControllerSwift0abC0C010underlyingB0xvp"></a>
<a name="//apple_ref/swift/Property/underlyingView" class="dashAnchor"></a>
<a class="token" href="#/s:vC23BaseViewControllerSwift18BaseViewController14underlyingViewx">underlyingView</a>
<a class="token" href="#/s:23BaseViewControllerSwift0abC0C010underlyingB0xvp">underlyingView</a>
</code>
</div>
<div class="height-container">
Expand All @@ -107,7 +107,7 @@ <h3 class="section-name">Properties</h3>
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="n">open</span> <span class="k">var</span> <span class="nv">underlyingView</span><span class="p">:</span> <span class="kt">T</span></code></pre>
<pre class="highlight swift"><code><span class="kd">open</span> <span class="k">var</span> <span class="nv">underlyingView</span><span class="p">:</span> <span class="kt">T</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>

</div>
</div>
Expand All @@ -128,9 +128,9 @@ <h3 class="section-name">Initializers</h3>
<li class="item">
<div>
<code>
<a name="/s:FC23BaseViewControllerSwift18BaseViewControllercFT_GS0_x_"></a>
<a name="/s:23BaseViewControllerSwift0abC0CACyxGycfc"></a>
<a name="//apple_ref/swift/Method/init()" class="dashAnchor"></a>
<a class="token" href="#/s:FC23BaseViewControllerSwift18BaseViewControllercFT_GS0_x_">init()</a>
<a class="token" href="#/s:23BaseViewControllerSwift0abC0CACyxGycfc">init()</a>
</code>
</div>
<div class="height-container">
Expand All @@ -145,7 +145,7 @@ <h3 class="section-name">Initializers</h3>
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="n">open</span> <span class="kd">class</span> <span class="kt">BaseViewController</span><span class="o">&lt;</span><span class="kt">T</span> <span class="p">:</span> <span class="kt">UIView</span><span class="o">&gt;</span><span class="p">:</span> <span class="kt">UIViewController</span></code></pre>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="nf">init</span><span class="p">()</span></code></pre>

</div>
</div>
Expand All @@ -155,9 +155,9 @@ <h4>Declaration</h4>
<li class="item">
<div>
<code>
<a name="/s:FC23BaseViewControllerSwift18BaseViewControllercFT5coderCSo7NSCoder_GSqGS0_x__"></a>
<a name="/s:23BaseViewControllerSwift0abC0C5coderACyxGSgSo7NSCoderC_tcfc"></a>
<a name="//apple_ref/swift/Method/init(coder:)" class="dashAnchor"></a>
<a class="token" href="#/s:FC23BaseViewControllerSwift18BaseViewControllercFT5coderCSo7NSCoder_GSqGS0_x__">init(coder:)</a>
<a class="token" href="#/s:23BaseViewControllerSwift0abC0C5coderACyxGSgSo7NSCoderC_tcfc">init(coder:)</a>
</code>
</div>
<div class="height-container">
Expand All @@ -172,7 +172,7 @@ <h4>Declaration</h4>
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="n">open</span> <span class="kd">class</span> <span class="kt">BaseViewController</span><span class="o">&lt;</span><span class="kt">T</span> <span class="p">:</span> <span class="kt">UIView</span><span class="o">&gt;</span><span class="p">:</span> <span class="kt">UIViewController</span></code></pre>
<pre class="highlight swift"><code><span class="kd">required</span> <span class="kd">public</span> <span class="nf">init</span><span class="p">?(</span><span class="n">coder</span> <span class="nv">aDecoder</span><span class="p">:</span> <span class="kt">NSCoder</span><span class="p">)</span></code></pre>

</div>
</div>
Expand All @@ -193,9 +193,9 @@ <h3 class="section-name">View Lifecycle</h3>
<li class="item">
<div>
<code>
<a name="/s:FC23BaseViewControllerSwift18BaseViewController8loadViewFT_T_"></a>
<a name="/s:23BaseViewControllerSwift0abC0C04loadB0yyF"></a>
<a name="//apple_ref/swift/Method/loadView()" class="dashAnchor"></a>
<a class="token" href="#/s:FC23BaseViewControllerSwift18BaseViewController8loadViewFT_T_">loadView()</a>
<a class="token" href="#/s:23BaseViewControllerSwift0abC0C04loadB0yyF">loadView()</a>
</code>
</div>
<div class="height-container">
Expand All @@ -210,7 +210,7 @@ <h3 class="section-name">View Lifecycle</h3>
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="n">open</span> <span class="kd">class</span> <span class="kt">BaseViewController</span><span class="o">&lt;</span><span class="kt">T</span> <span class="p">:</span> <span class="kt">UIView</span><span class="o">&gt;</span><span class="p">:</span> <span class="kt">UIViewController</span></code></pre>
<pre class="highlight swift"><code><span class="kd">open</span> <span class="k">override</span> <span class="kd">func</span> <span class="nf">loadView</span><span class="p">()</span></code></pre>

</div>
</div>
Expand All @@ -220,9 +220,9 @@ <h4>Declaration</h4>
<li class="item">
<div>
<code>
<a name="/s:FC23BaseViewControllerSwift18BaseViewController11viewDidLoadFT_T_"></a>
<a name="/s:23BaseViewControllerSwift0abC0C11viewDidLoadyyF"></a>
<a name="//apple_ref/swift/Method/viewDidLoad()" class="dashAnchor"></a>
<a class="token" href="#/s:FC23BaseViewControllerSwift18BaseViewController11viewDidLoadFT_T_">viewDidLoad()</a>
<a class="token" href="#/s:23BaseViewControllerSwift0abC0C11viewDidLoadyyF">viewDidLoad()</a>
</code>
</div>
<div class="height-container">
Expand All @@ -237,7 +237,7 @@ <h4>Declaration</h4>
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="n">open</span> <span class="kd">class</span> <span class="kt">BaseViewController</span><span class="o">&lt;</span><span class="kt">T</span> <span class="p">:</span> <span class="kt">UIView</span><span class="o">&gt;</span><span class="p">:</span> <span class="kt">UIViewController</span></code></pre>
<pre class="highlight swift"><code><span class="kd">open</span> <span class="k">override</span> <span class="kd">func</span> <span class="nf">viewDidLoad</span><span class="p">()</span></code></pre>

</div>
</div>
Expand All @@ -258,9 +258,9 @@ <h3 class="section-name">Setup</h3>
<li class="item">
<div>
<code>
<a name="/s:FC23BaseViewControllerSwift18BaseViewController9setupViewFT_T_"></a>
<a name="/s:23BaseViewControllerSwift0abC0C05setupB0yyF"></a>
<a name="//apple_ref/swift/Method/setupView()" class="dashAnchor"></a>
<a class="token" href="#/s:FC23BaseViewControllerSwift18BaseViewController9setupViewFT_T_">setupView()</a>
<a class="token" href="#/s:23BaseViewControllerSwift0abC0C05setupB0yyF">setupView()</a>
</code>
</div>
<div class="height-container">
Expand All @@ -275,7 +275,7 @@ <h3 class="section-name">Setup</h3>
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="n">open</span> <span class="kd">func</span> <span class="nf">setupView</span><span class="p">()</span></code></pre>
<pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">func</span> <span class="nf">setupView</span><span class="p">()</span></code></pre>

</div>
</div>
Expand All @@ -285,9 +285,9 @@ <h4>Declaration</h4>
<li class="item">
<div>
<code>
<a name="/s:FC23BaseViewControllerSwift18BaseViewController18setupAccessibilityFT_T_"></a>
<a name="/s:23BaseViewControllerSwift0abC0C18setupAccessibilityyyF"></a>
<a name="//apple_ref/swift/Method/setupAccessibility()" class="dashAnchor"></a>
<a class="token" href="#/s:FC23BaseViewControllerSwift18BaseViewController18setupAccessibilityFT_T_">setupAccessibility()</a>
<a class="token" href="#/s:23BaseViewControllerSwift0abC0C18setupAccessibilityyyF">setupAccessibility()</a>
</code>
</div>
<div class="height-container">
Expand All @@ -302,7 +302,7 @@ <h4>Declaration</h4>
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="n">open</span> <span class="kd">func</span> <span class="nf">setupAccessibility</span><span class="p">()</span></code></pre>
<pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">func</span> <span class="nf">setupAccessibility</span><span class="p">()</span></code></pre>

</div>
</div>
Expand All @@ -317,8 +317,8 @@ <h4>Declaration</h4>
</article>
</div>
<section class="footer">
<p>&copy; 2017 <a class="link" href="https://ustwo.com/" target="_blank" rel="external">ustwo Fampany Ltd.</a>. All rights reserved. (Last updated: 2017-03-20)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.7.4</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
<p>&copy; 2019 <a class="link" href="https://ustwo.com/" target="_blank" rel="external">ustwo Fampany Ltd.</a>. All rights reserved. (Last updated: 2019-04-25)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
</div>
Expand Down
29 changes: 28 additions & 1 deletion docs/badge.svg
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit f0984f6

Please sign in to comment.