Skip to content

Commit 240e52b

Browse files
committed
Update docs
1 parent b87be70 commit 240e52b

13 files changed

+422
-107
lines changed

docs/Classes/CollectionViewDiffableDataSource.html

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -235,9 +235,9 @@ <h4>Parameters</h4>
235235
<li class="item">
236236
<div>
237237
<code>
238-
<a name="/s:19DiffableDataSources014CollectionViewaB6SourceC5apply_20animatingDifferencesyAA0abF8SnapshotVyxq_G_SbtF"></a>
239-
<a name="//apple_ref/swift/Method/apply(_:animatingDifferences:)" class="dashAnchor"></a>
240-
<a class="token" href="#/s:19DiffableDataSources014CollectionViewaB6SourceC5apply_20animatingDifferencesyAA0abF8SnapshotVyxq_G_SbtF">apply(_:animatingDifferences:)</a>
238+
<a name="/s:19DiffableDataSources014CollectionViewaB6SourceC5apply_20animatingDifferences10completionyAA0abF8SnapshotVyxq_G_SbyycSgtF"></a>
239+
<a name="//apple_ref/swift/Method/apply(_:animatingDifferences:completion:)" class="dashAnchor"></a>
240+
<a class="token" href="#/s:19DiffableDataSources014CollectionViewaB6SourceC5apply_20animatingDifferences10completionyAA0abF8SnapshotVyxq_G_SbyycSgtF">apply(_:animatingDifferences:completion:)</a>
241241
</code>
242242
</div>
243243
<div class="height-container">
@@ -252,7 +252,7 @@ <h4>Parameters</h4>
252252
<h4>Declaration</h4>
253253
<div class="language">
254254
<p class="aside-title">Swift</p>
255-
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">apply</span><span class="p">(</span><span class="n">_</span> <span class="nv">snapshot</span><span class="p">:</span> <span class="kt"><a href="../Structs/DiffableDataSourceSnapshot.html">DiffableDataSourceSnapshot</a></span><span class="o">&lt;</span><span class="kt">SectionIdentifierType</span><span class="p">,</span> <span class="kt">ItemIdentifierType</span><span class="o">&gt;</span><span class="p">,</span> <span class="nv">animatingDifferences</span><span class="p">:</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="kc">true</span><span class="p">)</span></code></pre>
255+
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">apply</span><span class="p">(</span><span class="n">_</span> <span class="nv">snapshot</span><span class="p">:</span> <span class="kt"><a href="../Structs/DiffableDataSourceSnapshot.html">DiffableDataSourceSnapshot</a></span><span class="o">&lt;</span><span class="kt">SectionIdentifierType</span><span class="p">,</span> <span class="kt">ItemIdentifierType</span><span class="o">&gt;</span><span class="p">,</span> <span class="nv">animatingDifferences</span><span class="p">:</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="kc">true</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="p">(()</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre>
256256

257257
</div>
258258
</div>
@@ -285,6 +285,19 @@ <h4>Parameters</h4>
285285
</div>
286286
</td>
287287
</tr>
288+
<tr>
289+
<td>
290+
<code>
291+
<em>completion</em>
292+
</code>
293+
</td>
294+
<td>
295+
<div>
296+
<p>An optional completion block which is called when the complete
297+
performing updates.</p>
298+
</div>
299+
</td>
300+
</tr>
288301
</tbody>
289302
</table>
290303
</div>
@@ -678,8 +691,8 @@ <h4>Return Value</h4>
678691
</article>
679692
</div>
680693
<section class="footer">
681-
<p>&copy; 2019 <a class="link" href="https://github.com/ra1028" target="_blank" rel="external">Ryo Aoyama</a>. All rights reserved. (Last updated: 2019-09-02)</p>
682-
<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>
694+
<p>&copy; 2019 <a class="link" href="https://github.com/ra1028" target="_blank" rel="external">Ryo Aoyama</a>. All rights reserved. (Last updated: 2019-12-10)</p>
695+
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.11.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
683696
</section>
684697
</body>
685698
</div>

docs/Classes/TableViewDiffableDataSource.html

Lines changed: 143 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -208,9 +208,9 @@ <h4>Parameters</h4>
208208
<li class="item">
209209
<div>
210210
<code>
211-
<a name="/s:19DiffableDataSources09TableViewaB6SourceC5apply_20animatingDifferencesyAA0abF8SnapshotVyxq_G_SbtF"></a>
212-
<a name="//apple_ref/swift/Method/apply(_:animatingDifferences:)" class="dashAnchor"></a>
213-
<a class="token" href="#/s:19DiffableDataSources09TableViewaB6SourceC5apply_20animatingDifferencesyAA0abF8SnapshotVyxq_G_SbtF">apply(_:animatingDifferences:)</a>
211+
<a name="/s:19DiffableDataSources09TableViewaB6SourceC5apply_20animatingDifferences10completionyAA0abF8SnapshotVyxq_G_SbyycSgtF"></a>
212+
<a name="//apple_ref/swift/Method/apply(_:animatingDifferences:completion:)" class="dashAnchor"></a>
213+
<a class="token" href="#/s:19DiffableDataSources09TableViewaB6SourceC5apply_20animatingDifferences10completionyAA0abF8SnapshotVyxq_G_SbyycSgtF">apply(_:animatingDifferences:completion:)</a>
214214
</code>
215215
</div>
216216
<div class="height-container">
@@ -225,7 +225,7 @@ <h4>Parameters</h4>
225225
<h4>Declaration</h4>
226226
<div class="language">
227227
<p class="aside-title">Swift</p>
228-
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">apply</span><span class="p">(</span><span class="n">_</span> <span class="nv">snapshot</span><span class="p">:</span> <span class="kt"><a href="../Structs/DiffableDataSourceSnapshot.html">DiffableDataSourceSnapshot</a></span><span class="o">&lt;</span><span class="kt">SectionIdentifierType</span><span class="p">,</span> <span class="kt">ItemIdentifierType</span><span class="o">&gt;</span><span class="p">,</span> <span class="nv">animatingDifferences</span><span class="p">:</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="kc">true</span><span class="p">)</span></code></pre>
228+
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">apply</span><span class="p">(</span><span class="n">_</span> <span class="nv">snapshot</span><span class="p">:</span> <span class="kt"><a href="../Structs/DiffableDataSourceSnapshot.html">DiffableDataSourceSnapshot</a></span><span class="o">&lt;</span><span class="kt">SectionIdentifierType</span><span class="p">,</span> <span class="kt">ItemIdentifierType</span><span class="o">&gt;</span><span class="p">,</span> <span class="nv">animatingDifferences</span><span class="p">:</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="kc">true</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="p">(()</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre>
229229

230230
</div>
231231
</div>
@@ -258,6 +258,19 @@ <h4>Parameters</h4>
258258
</div>
259259
</td>
260260
</tr>
261+
<tr>
262+
<td>
263+
<code>
264+
<em>completion</em>
265+
</code>
266+
</td>
267+
<td>
268+
<div>
269+
<p>An optional completion block which is called when the complete
270+
performing updates.</p>
271+
</div>
272+
</td>
273+
</tr>
261274
</tbody>
262275
</table>
263276
</div>
@@ -507,6 +520,130 @@ <h4>Return Value</h4>
507520
</section>
508521
</div>
509522
</li>
523+
<li class="item">
524+
<div>
525+
<code>
526+
<a name="/s:19DiffableDataSources09TableViewaB6SourceC05tableE0_23titleForHeaderInSectionSSSgSo07UITableE0C_SitF"></a>
527+
<a name="//apple_ref/swift/Method/tableView(_:titleForHeaderInSection:)" class="dashAnchor"></a>
528+
<a class="token" href="#/s:19DiffableDataSources09TableViewaB6SourceC05tableE0_23titleForHeaderInSectionSSSgSo07UITableE0C_SitF">tableView(_:titleForHeaderInSection:)</a>
529+
</code>
530+
</div>
531+
<div class="height-container">
532+
<div class="pointer-container"></div>
533+
<section class="section">
534+
<div class="pointer"></div>
535+
<div class="abstract">
536+
<p>Returns the title for the specified section&rsquo;s header.</p>
537+
538+
</div>
539+
<div class="declaration">
540+
<h4>Declaration</h4>
541+
<div class="language">
542+
<p class="aside-title">Swift</p>
543+
<pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">func</span> <span class="nf">tableView</span><span class="p">(</span><span class="n">_</span> <span class="nv">tableView</span><span class="p">:</span> <span class="kt">UITableView</span><span class="p">,</span> <span class="n">titleForHeaderInSection</span> <span class="nv">section</span><span class="p">:</span> <span class="kt">Int</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">String</span><span class="p">?</span></code></pre>
544+
545+
</div>
546+
</div>
547+
<div>
548+
<h4>Parameters</h4>
549+
<table class="graybox">
550+
<tbody>
551+
<tr>
552+
<td>
553+
<code>
554+
<em>tableView</em>
555+
</code>
556+
</td>
557+
<td>
558+
<div>
559+
<p>A table view instance managed by <code>self</code>.</p>
560+
</div>
561+
</td>
562+
</tr>
563+
<tr>
564+
<td>
565+
<code>
566+
<em>section</em>
567+
</code>
568+
</td>
569+
<td>
570+
<div>
571+
<p>An index of section.</p>
572+
</div>
573+
</td>
574+
</tr>
575+
</tbody>
576+
</table>
577+
</div>
578+
<div>
579+
<h4>Return Value</h4>
580+
<p>The title for the specified section&rsquo;s header, or <code>nil</code> for no title.</p>
581+
</div>
582+
</section>
583+
</div>
584+
</li>
585+
<li class="item">
586+
<div>
587+
<code>
588+
<a name="/s:19DiffableDataSources09TableViewaB6SourceC05tableE0_23titleForFooterInSectionSSSgSo07UITableE0C_SitF"></a>
589+
<a name="//apple_ref/swift/Method/tableView(_:titleForFooterInSection:)" class="dashAnchor"></a>
590+
<a class="token" href="#/s:19DiffableDataSources09TableViewaB6SourceC05tableE0_23titleForFooterInSectionSSSgSo07UITableE0C_SitF">tableView(_:titleForFooterInSection:)</a>
591+
</code>
592+
</div>
593+
<div class="height-container">
594+
<div class="pointer-container"></div>
595+
<section class="section">
596+
<div class="pointer"></div>
597+
<div class="abstract">
598+
<p>Returns the title for the specified section&rsquo;s footer.</p>
599+
600+
</div>
601+
<div class="declaration">
602+
<h4>Declaration</h4>
603+
<div class="language">
604+
<p class="aside-title">Swift</p>
605+
<pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">func</span> <span class="nf">tableView</span><span class="p">(</span><span class="n">_</span> <span class="nv">tableView</span><span class="p">:</span> <span class="kt">UITableView</span><span class="p">,</span> <span class="n">titleForFooterInSection</span> <span class="nv">section</span><span class="p">:</span> <span class="kt">Int</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">String</span><span class="p">?</span></code></pre>
606+
607+
</div>
608+
</div>
609+
<div>
610+
<h4>Parameters</h4>
611+
<table class="graybox">
612+
<tbody>
613+
<tr>
614+
<td>
615+
<code>
616+
<em>tableView</em>
617+
</code>
618+
</td>
619+
<td>
620+
<div>
621+
<p>A table view instance managed by <code>self</code>.</p>
622+
</div>
623+
</td>
624+
</tr>
625+
<tr>
626+
<td>
627+
<code>
628+
<em>section</em>
629+
</code>
630+
</td>
631+
<td>
632+
<div>
633+
<p>An index of section.</p>
634+
</div>
635+
</td>
636+
</tr>
637+
</tbody>
638+
</table>
639+
</div>
640+
<div>
641+
<h4>Return Value</h4>
642+
<p>The title for the specified section&rsquo;s footer, or <code>nil</code> for no title.</p>
643+
</div>
644+
</section>
645+
</div>
646+
</li>
510647
<li class="item">
511648
<div>
512649
<code>
@@ -577,8 +714,8 @@ <h4>Return Value</h4>
577714
</article>
578715
</div>
579716
<section class="footer">
580-
<p>&copy; 2019 <a class="link" href="https://github.com/ra1028" target="_blank" rel="external">Ryo Aoyama</a>. All rights reserved. (Last updated: 2019-09-02)</p>
581-
<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>
717+
<p>&copy; 2019 <a class="link" href="https://github.com/ra1028" target="_blank" rel="external">Ryo Aoyama</a>. All rights reserved. (Last updated: 2019-12-10)</p>
718+
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.11.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
582719
</section>
583720
</body>
584721
</div>

docs/DataSources.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -156,8 +156,8 @@ <h4>Declaration</h4>
156156
</article>
157157
</div>
158158
<section class="footer">
159-
<p>&copy; 2019 <a class="link" href="https://github.com/ra1028" target="_blank" rel="external">Ryo Aoyama</a>. All rights reserved. (Last updated: 2019-09-02)</p>
160-
<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>
159+
<p>&copy; 2019 <a class="link" href="https://github.com/ra1028" target="_blank" rel="external">Ryo Aoyama</a>. All rights reserved. (Last updated: 2019-12-10)</p>
160+
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.11.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
161161
</section>
162162
</body>
163163
</div>

docs/Snapshot.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -121,8 +121,8 @@ <h4>Declaration</h4>
121121
</article>
122122
</div>
123123
<section class="footer">
124-
<p>&copy; 2019 <a class="link" href="https://github.com/ra1028" target="_blank" rel="external">Ryo Aoyama</a>. All rights reserved. (Last updated: 2019-09-02)</p>
125-
<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>
124+
<p>&copy; 2019 <a class="link" href="https://github.com/ra1028" target="_blank" rel="external">Ryo Aoyama</a>. All rights reserved. (Last updated: 2019-12-10)</p>
125+
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.11.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
126126
</section>
127127
</body>
128128
</div>

docs/Structs/DiffableDataSourceSnapshot.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1264,8 +1264,8 @@ <h4>Parameters</h4>
12641264
</article>
12651265
</div>
12661266
<section class="footer">
1267-
<p>&copy; 2019 <a class="link" href="https://github.com/ra1028" target="_blank" rel="external">Ryo Aoyama</a>. All rights reserved. (Last updated: 2019-09-02)</p>
1268-
<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>
1267+
<p>&copy; 2019 <a class="link" href="https://github.com/ra1028" target="_blank" rel="external">Ryo Aoyama</a>. All rights reserved. (Last updated: 2019-12-10)</p>
1268+
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.11.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
12691269
</section>
12701270
</body>
12711271
</div>

0 commit comments

Comments
 (0)