Skip to content

Commit 360ab4f

Browse files
committed
[2.0.0] gen docs
1 parent 26544b0 commit 360ab4f

11 files changed

+287
-280
lines changed

docs/Protocols.html

+7-8
Original file line numberDiff line numberDiff line change
@@ -17,19 +17,19 @@
1717
<a title="Protocols Reference"></a>
1818
<header>
1919
<div class="content-wrapper">
20-
<p><a href="index.html">Foil 1.2.0 Docs</a> (100% documented)</p>
21-
<p class="header-right"><a href="https://github.com/jessesquires/Foil"><img src="img/gh.png"/>View on GitHub</a></p>
22-
<p class="header-right">
20+
<p><a href="index.html">Foil 2.0.0 Docs</a> (100% documented)</p>
21+
<p class="header-right"><a href="https://github.com/jessesquires/Foil"><img src="img/gh.png" alt="GitHub"/>View on GitHub</a></p>
22+
<div class="header-right">
2323
<form role="search" action="search.json">
2424
<input type="text" placeholder="Search documentation" data-typeahead>
2525
</form>
26-
</p>
26+
</div>
2727
</div>
2828
</header>
2929
<div class="content-wrapper">
3030
<p id="breadcrumbs">
3131
<a href="index.html">Foil Reference</a>
32-
<img id="carat" src="img/carat.png" />
32+
<img id="carat" src="img/carat.png" alt=""/>
3333
Protocols Reference
3434
</p>
3535
</div>
@@ -118,11 +118,10 @@ <h4>Declaration</h4>
118118
</section>
119119
</section>
120120
<section id="footer">
121-
<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>
122-
<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>
121+
<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>
122+
<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>
123123
</section>
124124
</article>
125125
</div>
126126
</body>
127-
</div>
128127
</html>

docs/Protocols/UserDefaultsSerializable.html

+7-8
Original file line numberDiff line numberDiff line change
@@ -17,19 +17,19 @@
1717
<a title="UserDefaultsSerializable Protocol Reference"></a>
1818
<header>
1919
<div class="content-wrapper">
20-
<p><a href="../index.html">Foil 1.2.0 Docs</a> (100% documented)</p>
21-
<p class="header-right"><a href="https://github.com/jessesquires/Foil"><img src="../img/gh.png"/>View on GitHub</a></p>
22-
<p class="header-right">
20+
<p><a href="../index.html">Foil 2.0.0 Docs</a> (100% documented)</p>
21+
<p class="header-right"><a href="https://github.com/jessesquires/Foil"><img src="../img/gh.png" alt="GitHub"/>View on GitHub</a></p>
22+
<div class="header-right">
2323
<form role="search" action="../search.json">
2424
<input type="text" placeholder="Search documentation" data-typeahead>
2525
</form>
26-
</p>
26+
</div>
2727
</div>
2828
</header>
2929
<div class="content-wrapper">
3030
<p id="breadcrumbs">
3131
<a href="../index.html">Foil Reference</a>
32-
<img id="carat" src="../img/carat.png" />
32+
<img id="carat" src="../img/carat.png" alt=""/>
3333
UserDefaultsSerializable Protocol Reference
3434
</p>
3535
</div>
@@ -197,11 +197,10 @@ <h4>Parameters</h4>
197197
</section>
198198
</section>
199199
<section id="footer">
200-
<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>
201-
<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>
200+
<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>
201+
<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>
202202
</section>
203203
</article>
204204
</div>
205205
</body>
206-
</div>
207206
</html>

docs/Structs.html

+7-8
Original file line numberDiff line numberDiff line change
@@ -17,19 +17,19 @@
1717
<a title="Structures Reference"></a>
1818
<header>
1919
<div class="content-wrapper">
20-
<p><a href="index.html">Foil 1.2.0 Docs</a> (100% documented)</p>
21-
<p class="header-right"><a href="https://github.com/jessesquires/Foil"><img src="img/gh.png"/>View on GitHub</a></p>
22-
<p class="header-right">
20+
<p><a href="index.html">Foil 2.0.0 Docs</a> (100% documented)</p>
21+
<p class="header-right"><a href="https://github.com/jessesquires/Foil"><img src="img/gh.png" alt="GitHub"/>View on GitHub</a></p>
22+
<div class="header-right">
2323
<form role="search" action="search.json">
2424
<input type="text" placeholder="Search documentation" data-typeahead>
2525
</form>
26-
</p>
26+
</div>
2727
</div>
2828
</header>
2929
<div class="content-wrapper">
3030
<p id="breadcrumbs">
3131
<a href="index.html">Foil Reference</a>
32-
<img id="carat" src="img/carat.png" />
32+
<img id="carat" src="img/carat.png" alt=""/>
3333
Structures Reference
3434
</p>
3535
</div>
@@ -132,11 +132,10 @@ <h4>Declaration</h4>
132132
</section>
133133
</section>
134134
<section id="footer">
135-
<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>
136-
<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>
135+
<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>
136+
<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>
137137
</section>
138138
</article>
139139
</div>
140140
</body>
141-
</div>
142141
</html>

docs/Structs/WrappedDefault.html

+16-19
Original file line numberDiff line numberDiff line change
@@ -17,19 +17,19 @@
1717
<a title="WrappedDefault Structure Reference"></a>
1818
<header>
1919
<div class="content-wrapper">
20-
<p><a href="../index.html">Foil 1.2.0 Docs</a> (100% documented)</p>
21-
<p class="header-right"><a href="https://github.com/jessesquires/Foil"><img src="../img/gh.png"/>View on GitHub</a></p>
22-
<p class="header-right">
20+
<p><a href="../index.html">Foil 2.0.0 Docs</a> (100% documented)</p>
21+
<p class="header-right"><a href="https://github.com/jessesquires/Foil"><img src="../img/gh.png" alt="GitHub"/>View on GitHub</a></p>
22+
<div class="header-right">
2323
<form role="search" action="../search.json">
2424
<input type="text" placeholder="Search documentation" data-typeahead>
2525
</form>
26-
</p>
26+
</div>
2727
</div>
2828
</header>
2929
<div class="content-wrapper">
3030
<p id="breadcrumbs">
3131
<a href="../index.html">Foil Reference</a>
32-
<img id="carat" src="../img/carat.png" />
32+
<img id="carat" src="../img/carat.png" alt=""/>
3333
WrappedDefault Structure Reference
3434
</p>
3535
</div>
@@ -116,7 +116,7 @@ <h4>Declaration</h4>
116116
<section class="section">
117117
<div class="pointer"></div>
118118
<div class="abstract">
119-
<p>The value retreived from <code>UserDefaults</code>.</p>
119+
<p>The value retrieved from <code>UserDefaults</code>.</p>
120120

121121
</div>
122122
<div class="declaration">
@@ -133,9 +133,9 @@ <h4>Declaration</h4>
133133
<li class="item">
134134
<div>
135135
<code>
136-
<a name="/s:4Foil14WrappedDefaultV7keyName12defaultValue12userDefaultsACyxGSS_xSo06NSUserI0Ctcfc"></a>
137-
<a name="//apple_ref/swift/Method/init(keyName:defaultValue:userDefaults:)" class="dashAnchor"></a>
138-
<a class="token" href="#/s:4Foil14WrappedDefaultV7keyName12defaultValue12userDefaultsACyxGSS_xSo06NSUserI0Ctcfc">init(keyName:<wbr>defaultValue:<wbr>userDefaults:<wbr>)</a>
136+
<a name="/s:4Foil14WrappedDefaultV12wrappedValue3key12userDefaultsACyxGx_SSSo06NSUserH0Ctcfc"></a>
137+
<a name="//apple_ref/swift/Method/init(wrappedValue:key:userDefaults:)" class="dashAnchor"></a>
138+
<a class="token" href="#/s:4Foil14WrappedDefaultV12wrappedValue3key12userDefaultsACyxGx_SSSo06NSUserH0Ctcfc">init(wrappedValue:<wbr>key:<wbr>userDefaults:<wbr>)</a>
139139
</code>
140140
</div>
141141
<div class="height-container">
@@ -150,9 +150,7 @@ <h4>Declaration</h4>
150150
<h4>Declaration</h4>
151151
<div class="language">
152152
<p class="aside-title">Swift</p>
153-
<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>
154-
<span class="n">defaultValue</span><span class="p">:</span> <span class="kt">T</span><span class="p">,</span>
155-
<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>
153+
<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>
156154

157155
</div>
158156
</div>
@@ -163,24 +161,24 @@ <h4>Parameters</h4>
163161
<tr>
164162
<td>
165163
<code>
166-
<em>keyName</em>
164+
<em>wrappedValue</em>
167165
</code>
168166
</td>
169167
<td>
170168
<div>
171-
<p>The key for the value in <code>UserDefaults</code>.</p>
169+
<p>The default value to register for the specified key.</p>
172170
</div>
173171
</td>
174172
</tr>
175173
<tr>
176174
<td>
177175
<code>
178-
<em>defaultValue</em>
176+
<em>keyName</em>
179177
</code>
180178
</td>
181179
<td>
182180
<div>
183-
<p>The default value to register for the specified key.</p>
181+
<p>The key for the value in <code>UserDefaults</code>.</p>
184182
</div>
185183
</td>
186184
</tr>
@@ -207,11 +205,10 @@ <h4>Parameters</h4>
207205
</section>
208206
</section>
209207
<section id="footer">
210-
<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>
211-
<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>
208+
<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>
209+
<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>
212210
</section>
213211
</article>
214212
</div>
215213
</body>
216-
</div>
217214
</html>

docs/Structs/WrappedDefaultOptional.html

+11-13
Original file line numberDiff line numberDiff line change
@@ -17,19 +17,19 @@
1717
<a title="WrappedDefaultOptional Structure Reference"></a>
1818
<header>
1919
<div class="content-wrapper">
20-
<p><a href="../index.html">Foil 1.2.0 Docs</a> (100% documented)</p>
21-
<p class="header-right"><a href="https://github.com/jessesquires/Foil"><img src="../img/gh.png"/>View on GitHub</a></p>
22-
<p class="header-right">
20+
<p><a href="../index.html">Foil 2.0.0 Docs</a> (100% documented)</p>
21+
<p class="header-right"><a href="https://github.com/jessesquires/Foil"><img src="../img/gh.png" alt="GitHub"/>View on GitHub</a></p>
22+
<div class="header-right">
2323
<form role="search" action="../search.json">
2424
<input type="text" placeholder="Search documentation" data-typeahead>
2525
</form>
26-
</p>
26+
</div>
2727
</div>
2828
</header>
2929
<div class="content-wrapper">
3030
<p id="breadcrumbs">
3131
<a href="../index.html">Foil Reference</a>
32-
<img id="carat" src="../img/carat.png" />
32+
<img id="carat" src="../img/carat.png" alt=""/>
3333
WrappedDefaultOptional Structure Reference
3434
</p>
3535
</div>
@@ -133,9 +133,9 @@ <h4>Declaration</h4>
133133
<li class="item">
134134
<div>
135135
<code>
136-
<a name="/s:4Foil22WrappedDefaultOptionalV7keyName12userDefaultsACyxGSS_So06NSUserH0Ctcfc"></a>
137-
<a name="//apple_ref/swift/Method/init(keyName:userDefaults:)" class="dashAnchor"></a>
138-
<a class="token" href="#/s:4Foil22WrappedDefaultOptionalV7keyName12userDefaultsACyxGSS_So06NSUserH0Ctcfc">init(keyName:<wbr>userDefaults:<wbr>)</a>
136+
<a name="/s:4Foil22WrappedDefaultOptionalV3key12userDefaultsACyxGSS_So06NSUserG0Ctcfc"></a>
137+
<a name="//apple_ref/swift/Method/init(key:userDefaults:)" class="dashAnchor"></a>
138+
<a class="token" href="#/s:4Foil22WrappedDefaultOptionalV3key12userDefaultsACyxGSS_So06NSUserG0Ctcfc">init(key:<wbr>userDefaults:<wbr>)</a>
139139
</code>
140140
</div>
141141
<div class="height-container">
@@ -150,8 +150,7 @@ <h4>Declaration</h4>
150150
<h4>Declaration</h4>
151151
<div class="language">
152152
<p class="aside-title">Swift</p>
153-
<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>
154-
<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>
153+
<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>
155154

156155
</div>
157156
</div>
@@ -194,11 +193,10 @@ <h4>Parameters</h4>
194193
</section>
195194
</section>
196195
<section id="footer">
197-
<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>
198-
<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>
196+
<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>
197+
<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>
199198
</section>
200199
</article>
201200
</div>
202201
</body>
203-
</div>
204202
</html>

0 commit comments

Comments
 (0)