Skip to content

Commit

Permalink
[2.0.0] gen docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@jessesquires
jessesquires committed Nov 20, 2021
1 parent 26544b0 commit 360ab4f
Show file tree
Hide file tree
Showing 11 changed files with 287 additions and 280 deletions.
15 changes: 7 additions & 8 deletions docs/Protocols.html
View file
Expand Up @@ -17,19 +17,19 @@
<a title="Protocols Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="index.html">Foil 1.2.0 Docs</a> (100% documented)</p>
<p class="header-right"><a href="https://github.com/jessesquires/Foil"><img src="img/gh.png"/>View on GitHub</a></p>
<p class="header-right">
<p><a href="index.html">Foil 2.0.0 Docs</a> (100% documented)</p>
<p class="header-right"><a href="https://github.com/jessesquires/Foil"><img src="img/gh.png" alt="GitHub"/>View on GitHub</a></p>
<div class="header-right">
<form role="search" action="search.json">
<input type="text" placeholder="Search documentation" data-typeahead>
</form>
</p>
</div>
</div>
</header>
<div class="content-wrapper">
<p id="breadcrumbs">
<a href="index.html">Foil Reference</a>
<img id="carat" src="img/carat.png" />
<img id="carat" src="img/carat.png" alt=""/>
Protocols Reference
</p>
</div>
Expand Down Expand Up @@ -118,11 +118,10 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2021 <a class="link" href="https://jessesquires.com" target="_blank" rel="external">Jesse Squires</a>. All rights reserved. (Last updated: 2021-08-08)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.7</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
<p>&copy; 2021 <a class="link" href="https://jessesquires.com" target="_blank" rel="external noopener">Jesse Squires</a>. All rights reserved. (Last updated: 2021-11-19)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.1</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
</section>
</article>
</div>
</body>
</div>
</html>
15 changes: 7 additions & 8 deletions docs/Protocols/UserDefaultsSerializable.html
View file
Expand Up @@ -17,19 +17,19 @@
<a title="UserDefaultsSerializable Protocol Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">Foil 1.2.0 Docs</a> (100% documented)</p>
<p class="header-right"><a href="https://github.com/jessesquires/Foil"><img src="../img/gh.png"/>View on GitHub</a></p>
<p class="header-right">
<p><a href="../index.html">Foil 2.0.0 Docs</a> (100% documented)</p>
<p class="header-right"><a href="https://github.com/jessesquires/Foil"><img src="../img/gh.png" alt="GitHub"/>View on GitHub</a></p>
<div class="header-right">
<form role="search" action="../search.json">
<input type="text" placeholder="Search documentation" data-typeahead>
</form>
</p>
</div>
</div>
</header>
<div class="content-wrapper">
<p id="breadcrumbs">
<a href="../index.html">Foil Reference</a>
<img id="carat" src="../img/carat.png" />
<img id="carat" src="../img/carat.png" alt=""/>
UserDefaultsSerializable Protocol Reference
</p>
</div>
Expand Down Expand Up @@ -197,11 +197,10 @@ <h4>Parameters</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2021 <a class="link" href="https://jessesquires.com" target="_blank" rel="external">Jesse Squires</a>. All rights reserved. (Last updated: 2021-08-08)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.7</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
<p>&copy; 2021 <a class="link" href="https://jessesquires.com" target="_blank" rel="external noopener">Jesse Squires</a>. All rights reserved. (Last updated: 2021-11-19)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.1</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
</section>
</article>
</div>
</body>
</div>
</html>
15 changes: 7 additions & 8 deletions docs/Structs.html
View file
Expand Up @@ -17,19 +17,19 @@
<a title="Structures Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="index.html">Foil 1.2.0 Docs</a> (100% documented)</p>
<p class="header-right"><a href="https://github.com/jessesquires/Foil"><img src="img/gh.png"/>View on GitHub</a></p>
<p class="header-right">
<p><a href="index.html">Foil 2.0.0 Docs</a> (100% documented)</p>
<p class="header-right"><a href="https://github.com/jessesquires/Foil"><img src="img/gh.png" alt="GitHub"/>View on GitHub</a></p>
<div class="header-right">
<form role="search" action="search.json">
<input type="text" placeholder="Search documentation" data-typeahead>
</form>
</p>
</div>
</div>
</header>
<div class="content-wrapper">
<p id="breadcrumbs">
<a href="index.html">Foil Reference</a>
<img id="carat" src="img/carat.png" />
<img id="carat" src="img/carat.png" alt=""/>
Structures Reference
</p>
</div>
Expand Down Expand Up @@ -132,11 +132,10 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2021 <a class="link" href="https://jessesquires.com" target="_blank" rel="external">Jesse Squires</a>. All rights reserved. (Last updated: 2021-08-08)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.7</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
<p>&copy; 2021 <a class="link" href="https://jessesquires.com" target="_blank" rel="external noopener">Jesse Squires</a>. All rights reserved. (Last updated: 2021-11-19)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.1</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
</section>
</article>
</div>
</body>
</div>
</html>
35 changes: 16 additions & 19 deletions docs/Structs/WrappedDefault.html
View file
Expand Up @@ -17,19 +17,19 @@
<a title="WrappedDefault Structure Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">Foil 1.2.0 Docs</a> (100% documented)</p>
<p class="header-right"><a href="https://github.com/jessesquires/Foil"><img src="../img/gh.png"/>View on GitHub</a></p>
<p class="header-right">
<p><a href="../index.html">Foil 2.0.0 Docs</a> (100% documented)</p>
<p class="header-right"><a href="https://github.com/jessesquires/Foil"><img src="../img/gh.png" alt="GitHub"/>View on GitHub</a></p>
<div class="header-right">
<form role="search" action="../search.json">
<input type="text" placeholder="Search documentation" data-typeahead>
</form>
</p>
</div>
</div>
</header>
<div class="content-wrapper">
<p id="breadcrumbs">
<a href="../index.html">Foil Reference</a>
<img id="carat" src="../img/carat.png" />
<img id="carat" src="../img/carat.png" alt=""/>
WrappedDefault Structure Reference
</p>
</div>
Expand Down Expand Up @@ -116,7 +116,7 @@ <h4>Declaration</h4>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The value retreived from <code>UserDefaults</code>.</p>
<p>The value retrieved from <code>UserDefaults</code>.</p>

</div>
<div class="declaration">
Expand All @@ -133,9 +133,9 @@ <h4>Declaration</h4>
<li class="item">
<div>
<code>
<a name="/s:4Foil14WrappedDefaultV7keyName12defaultValue12userDefaultsACyxGSS_xSo06NSUserI0Ctcfc"></a>
<a name="//apple_ref/swift/Method/init(keyName:defaultValue:userDefaults:)" class="dashAnchor"></a>
<a class="token" href="#/s:4Foil14WrappedDefaultV7keyName12defaultValue12userDefaultsACyxGSS_xSo06NSUserI0Ctcfc">init(keyName:<wbr>defaultValue:<wbr>userDefaults:<wbr>)</a>
<a name="/s:4Foil14WrappedDefaultV12wrappedValue3key12userDefaultsACyxGx_SSSo06NSUserH0Ctcfc"></a>
<a name="//apple_ref/swift/Method/init(wrappedValue:key:userDefaults:)" class="dashAnchor"></a>
<a class="token" href="#/s:4Foil14WrappedDefaultV12wrappedValue3key12userDefaultsACyxGx_SSSo06NSUserH0Ctcfc">init(wrappedValue:<wbr>key:<wbr>userDefaults:<wbr>)</a>
</code>
</div>
<div class="height-container">
Expand All @@ -150,9 +150,7 @@ <h4>Declaration</h4>
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="nf">init</span><span class="p">(</span><span class="nv">keyName</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span>
<span class="n">defaultValue</span><span class="p">:</span> <span class="kt">T</span><span class="p">,</span>
<span class="nv">userDefaults</span><span class="p">:</span> <span class="kt">UserDefaults</span> <span class="o">=</span> <span class="o">.</span><span class="n">standard</span><span class="p">)</span></code></pre>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="nf">init</span><span class="p">(</span><span class="nv">wrappedValue</span><span class="p">:</span> <span class="kt">T</span><span class="p">,</span> <span class="n"><a href="../Structs/WrappedDefault.html#/s:4Foil14WrappedDefaultV3keySSvp">key</a></span> <span class="nv">keyName</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">userDefaults</span><span class="p">:</span> <span class="kt">UserDefaults</span> <span class="o">=</span> <span class="o">.</span><span class="n">standard</span><span class="p">)</span></code></pre>

</div>
</div>
Expand All @@ -163,24 +161,24 @@ <h4>Parameters</h4>
<tr>
<td>
<code>
<em>keyName</em>
<em>wrappedValue</em>
</code>
</td>
<td>
<div>
<p>The key for the value in <code>UserDefaults</code>.</p>
<p>The default value to register for the specified key.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>defaultValue</em>
<em>keyName</em>
</code>
</td>
<td>
<div>
<p>The default value to register for the specified key.</p>
<p>The key for the value in <code>UserDefaults</code>.</p>
</div>
</td>
</tr>
Expand All @@ -207,11 +205,10 @@ <h4>Parameters</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2021 <a class="link" href="https://jessesquires.com" target="_blank" rel="external">Jesse Squires</a>. All rights reserved. (Last updated: 2021-08-08)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.7</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
<p>&copy; 2021 <a class="link" href="https://jessesquires.com" target="_blank" rel="external noopener">Jesse Squires</a>. All rights reserved. (Last updated: 2021-11-19)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.1</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
</section>
</article>
</div>
</body>
</div>
</html>
24 changes: 11 additions & 13 deletions docs/Structs/WrappedDefaultOptional.html
View file
Expand Up @@ -17,19 +17,19 @@
<a title="WrappedDefaultOptional Structure Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">Foil 1.2.0 Docs</a> (100% documented)</p>
<p class="header-right"><a href="https://github.com/jessesquires/Foil"><img src="../img/gh.png"/>View on GitHub</a></p>
<p class="header-right">
<p><a href="../index.html">Foil 2.0.0 Docs</a> (100% documented)</p>
<p class="header-right"><a href="https://github.com/jessesquires/Foil"><img src="../img/gh.png" alt="GitHub"/>View on GitHub</a></p>
<div class="header-right">
<form role="search" action="../search.json">
<input type="text" placeholder="Search documentation" data-typeahead>
</form>
</p>
</div>
</div>
</header>
<div class="content-wrapper">
<p id="breadcrumbs">
<a href="../index.html">Foil Reference</a>
<img id="carat" src="../img/carat.png" />
<img id="carat" src="../img/carat.png" alt=""/>
WrappedDefaultOptional Structure Reference
</p>
</div>
Expand Down Expand Up @@ -133,9 +133,9 @@ <h4>Declaration</h4>
<li class="item">
<div>
<code>
<a name="/s:4Foil22WrappedDefaultOptionalV7keyName12userDefaultsACyxGSS_So06NSUserH0Ctcfc"></a>
<a name="//apple_ref/swift/Method/init(keyName:userDefaults:)" class="dashAnchor"></a>
<a class="token" href="#/s:4Foil22WrappedDefaultOptionalV7keyName12userDefaultsACyxGSS_So06NSUserH0Ctcfc">init(keyName:<wbr>userDefaults:<wbr>)</a>
<a name="/s:4Foil22WrappedDefaultOptionalV3key12userDefaultsACyxGSS_So06NSUserG0Ctcfc"></a>
<a name="//apple_ref/swift/Method/init(key:userDefaults:)" class="dashAnchor"></a>
<a class="token" href="#/s:4Foil22WrappedDefaultOptionalV3key12userDefaultsACyxGSS_So06NSUserG0Ctcfc">init(key:<wbr>userDefaults:<wbr>)</a>
</code>
</div>
<div class="height-container">
Expand All @@ -150,8 +150,7 @@ <h4>Declaration</h4>
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="nf">init</span><span class="p">(</span><span class="nv">keyName</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span>
<span class="nv">userDefaults</span><span class="p">:</span> <span class="kt">UserDefaults</span> <span class="o">=</span> <span class="o">.</span><span class="n">standard</span><span class="p">)</span></code></pre>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="nf">init</span><span class="p">(</span><span class="n"><a href="../Structs/WrappedDefaultOptional.html#/s:4Foil22WrappedDefaultOptionalV3keySSvp">key</a></span> <span class="nv">keyName</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">userDefaults</span><span class="p">:</span> <span class="kt">UserDefaults</span> <span class="o">=</span> <span class="o">.</span><span class="n">standard</span><span class="p">)</span></code></pre>

</div>
</div>
Expand Down Expand Up @@ -194,11 +193,10 @@ <h4>Parameters</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2021 <a class="link" href="https://jessesquires.com" target="_blank" rel="external">Jesse Squires</a>. All rights reserved. (Last updated: 2021-08-08)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.7</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
<p>&copy; 2021 <a class="link" href="https://jessesquires.com" target="_blank" rel="external noopener">Jesse Squires</a>. All rights reserved. (Last updated: 2021-11-19)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.1</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
</section>
</article>
</div>
</body>
</div>
</html>

0 comments on commit 360ab4f

Please sign in to comment.