Skip to content

Commit 6a521ea

Browse files
TimOliverfacebook-github-bot
TimOliver
authored and
facebook-github-bot
committed
Regenerate IGListKit documentation via jazzy
Summary: Regenerated the IGListKit documentation via jazzy. Reviewed By: fabiomassimo Differential Revision: D57263196 fbshipit-source-id: 1a649e29a4bfa0d12fa81d00f96ea9264a68f013
1 parent 33fb2f6 commit 6a521ea

File tree

67 files changed

+1615
-493
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

67 files changed

+1615
-493
lines changed

‎docs/Classes.html‎

Lines changed: 45 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
<a title="Classes Reference"></a>
1818
<header>
1919
<div class="content-wrapper">
20-
<p><a href="index.html">IGListKit 4.1.0 Docs</a> (93% documented)</p>
20+
<p><a href="index.html">IGListKit 4.1.0 Docs</a> (96% documented)</p>
2121
<p class="header-right"><a href="https://github.com/Instagram/IGListKit"><img src="img/gh.png" alt="GitHub"/>View on GitHub</a></p>
2222
<div class="header-right">
2323
<form role="search" action="search.json">
@@ -28,7 +28,7 @@
2828
</header>
2929
<div class="content-wrapper">
3030
<p id="breadcrumbs">
31-
<a href="index.html">IGListKit Reference</a>
31+
<a href="index.html">IGListKit</a>
3232
<img id="carat" src="img/carat.png" alt=""/>
3333
Classes Reference
3434
</p>
@@ -86,6 +86,9 @@
8686
<li class="nav-group-task">
8787
<a href="Classes/IGListBindingSectionController.html">IGListBindingSectionController</a>
8888
</li>
89+
<li class="nav-group-task">
90+
<a href="Classes/IGListBindingSingleSectionController.html">IGListBindingSingleSectionController</a>
91+
</li>
8992
<li class="nav-group-task">
9093
<a href="Classes/IGListCollectionView.html">IGListCollectionView</a>
9194
</li>
@@ -600,6 +603,44 @@ <h4>Declaration</h4>
600603
</section>
601604
</div>
602605
</li>
606+
<li class="item">
607+
<div>
608+
<code>
609+
<a name="/c:objc(cs)IGListBindingSingleSectionController"></a>
610+
<a name="//apple_ref/objc/Class/IGListBindingSingleSectionController" class="dashAnchor"></a>
611+
<a class="token" href="#/c:objc(cs)IGListBindingSingleSectionController">IGListBindingSingleSectionController</a>
612+
</code>
613+
</div>
614+
<div class="height-container">
615+
<div class="pointer-container"></div>
616+
<section class="section">
617+
<div class="pointer"></div>
618+
<div class="abstract">
619+
<p>Special section controller that only contains a single item, and it will apply the view model update during -didUpdateObject: call, usually happened inside -[UICollectionView performBatchUpdates:completion:].</p>
620+
621+
<p>This class is intended to be subclassed.</p>
622+
623+
<a href="Classes/IGListBindingSingleSectionController.html" class="slightly-smaller">See more</a>
624+
</div>
625+
<div class="declaration">
626+
<h4>Declaration</h4>
627+
<div class="language">
628+
<p class="aside-title">Objective-C</p>
629+
<pre class="highlight objective_c"><code>
630+
<span class="k">@interface</span> <span class="nc">IGListBindingSingleSectionController</span><span class="o">&lt;</span>
631+
<span class="n">__covariant</span> <span class="n">ViewModel</span> <span class="o">:</span> <span class="n">id</span> <span class="o">&lt;</span><span class="n"><a href="Protocols/IGListDiffable.html">IGListDiffable</a></span><span class="o">&gt;</span><span class="p">,</span> <span class="n">Cell</span> <span class="o">:</span> <span class="n">UICollectionViewCell</span> <span class="o">*&gt;</span>
632+
<span class="o">:</span> <span class="n"><a href="Classes/IGListSectionController.html">IGListSectionController</a></span></code></pre>
633+
634+
</div>
635+
<div class="language">
636+
<p class="aside-title">Swift</p>
637+
<pre class="highlight swift"><code><span class="kd">class</span> <span class="kt">ListBindingSingleSectionController</span><span class="o">&lt;</span><span class="kt">ViewModel</span><span class="p">,</span> <span class="kt">Cell</span><span class="o">&gt;</span> <span class="p">:</span> <span class="kt">ListSectionController</span> <span class="k">where</span> <span class="kt">ViewModel</span> <span class="p">:</span> <span class="kt">ListDiffable</span><span class="p">,</span> <span class="kt">Cell</span> <span class="p">:</span> <span class="kt">UICollectionViewCell</span></code></pre>
638+
639+
</div>
640+
</div>
641+
</section>
642+
</div>
643+
</li>
603644
<li class="item">
604645
<div>
605646
<code>
@@ -913,8 +954,8 @@ <h4>Declaration</h4>
913954
</section>
914955
</section>
915956
<section id="footer">
916-
<p>&copy; 2023 <a class="link" href="https://twitter.com/MetaOpenSource" target="_blank" rel="external noopener">Instagram</a>. All rights reserved. (Last updated: 2023-04-07)</p>
917-
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
957+
<p>&copy; 2024 <a class="link" href="https://twitter.com/MetaOpenSource" target="_blank" rel="external noopener">Instagram</a>. All rights reserved. (Last updated: 2024-05-13)</p>
958+
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.0</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
918959
</section>
919960
</article>
920961
</div>

‎docs/Classes/IGListAdapter.html‎

Lines changed: 32 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
<a title="IGListAdapter Class Reference"></a>
1818
<header>
1919
<div class="content-wrapper">
20-
<p><a href="../index.html">IGListKit 4.1.0 Docs</a> (93% documented)</p>
20+
<p><a href="../index.html">IGListKit 4.1.0 Docs</a> (96% documented)</p>
2121
<p class="header-right"><a href="https://github.com/Instagram/IGListKit"><img src="../img/gh.png" alt="GitHub"/>View on GitHub</a></p>
2222
<div class="header-right">
2323
<form role="search" action="../search.json">
@@ -28,7 +28,9 @@
2828
</header>
2929
<div class="content-wrapper">
3030
<p id="breadcrumbs">
31-
<a href="../index.html">IGListKit Reference</a>
31+
<a href="../index.html">IGListKit</a>
32+
<img id="carat" src="../img/carat.png" alt=""/>
33+
<a href="../Classes.html">Classes</a>
3234
<img id="carat" src="../img/carat.png" alt=""/>
3335
IGListAdapter Class Reference
3436
</p>
@@ -86,6 +88,9 @@
8688
<li class="nav-group-task">
8789
<a href="../Classes/IGListBindingSectionController.html">IGListBindingSectionController</a>
8890
</li>
91+
<li class="nav-group-task">
92+
<a href="../Classes/IGListBindingSingleSectionController.html">IGListBindingSingleSectionController</a>
93+
</li>
8994
<li class="nav-group-task">
9095
<a href="../Classes/IGListCollectionView.html">IGListCollectionView</a>
9196
</li>
@@ -404,7 +409,7 @@ <h4>Declaration</h4>
404409
</div>
405410
<div class="language">
406411
<p class="aside-title">Swift</p>
407-
<pre class="highlight swift"><code><span class="k">weak</span> <span class="k">var</span> <span class="nv">dataSource</span><span class="p">:</span> <span class="kt">ListAdapterDataSource</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
412+
<pre class="highlight swift"><code><span class="k">weak</span> <span class="k">var</span> <span class="nv">dataSource</span><span class="p">:</span> <span class="p">(</span><span class="kd">any</span> <span class="kt">ListAdapterDataSource</span><span class="p">)?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
408413

409414
</div>
410415
</div>
@@ -436,7 +441,7 @@ <h4>Declaration</h4>
436441
</div>
437442
<div class="language">
438443
<p class="aside-title">Swift</p>
439-
<pre class="highlight swift"><code><span class="k">weak</span> <span class="k">var</span> <span class="nv">delegate</span><span class="p">:</span> <span class="kt">ListAdapterDelegate</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
444+
<pre class="highlight swift"><code><span class="k">weak</span> <span class="k">var</span> <span class="nv">delegate</span><span class="p">:</span> <span class="p">(</span><span class="kd">any</span> <span class="kt">ListAdapterDelegate</span><span class="p">)?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
440445

441446
</div>
442447
</div>
@@ -473,7 +478,7 @@ <h4>Declaration</h4>
473478
</div>
474479
<div class="language">
475480
<p class="aside-title">Swift</p>
476-
<pre class="highlight swift"><code><span class="k">weak</span> <span class="k">var</span> <span class="nv">collectionViewDelegate</span><span class="p">:</span> <span class="kt">UICollectionViewDelegate</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
481+
<pre class="highlight swift"><code><span class="k">weak</span> <span class="k">var</span> <span class="nv">collectionViewDelegate</span><span class="p">:</span> <span class="p">(</span><span class="kd">any</span> <span class="kt">UICollectionViewDelegate</span><span class="p">)?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
477482

478483
</div>
479484
</div>
@@ -505,7 +510,7 @@ <h4>Declaration</h4>
505510
</div>
506511
<div class="language">
507512
<p class="aside-title">Swift</p>
508-
<pre class="highlight swift"><code><span class="k">weak</span> <span class="k">var</span> <span class="nv">scrollViewDelegate</span><span class="p">:</span> <span class="kt">UIScrollViewDelegate</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
513+
<pre class="highlight swift"><code><span class="k">weak</span> <span class="k">var</span> <span class="nv">scrollViewDelegate</span><span class="p">:</span> <span class="p">(</span><span class="kd">any</span> <span class="kt">UIScrollViewDelegate</span><span class="p">)?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
509514

510515
</div>
511516
</div>
@@ -542,7 +547,7 @@ <h4>Declaration</h4>
542547
</div>
543548
<div class="language">
544549
<p class="aside-title">Swift</p>
545-
<pre class="highlight swift"><code><span class="k">weak</span> <span class="k">var</span> <span class="nv">moveDelegate</span><span class="p">:</span> <span class="kt">ListAdapterMoveDelegate</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
550+
<pre class="highlight swift"><code><span class="k">weak</span> <span class="k">var</span> <span class="nv">moveDelegate</span><span class="p">:</span> <span class="p">(</span><span class="kd">any</span> <span class="kt">ListAdapterMoveDelegate</span><span class="p">)?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
546551

547552
</div>
548553
</div>
@@ -574,7 +579,7 @@ <h4>Declaration</h4>
574579
</div>
575580
<div class="language">
576581
<p class="aside-title">Swift</p>
577-
<pre class="highlight swift"><code><span class="k">weak</span> <span class="k">var</span> <span class="nv">performanceDelegate</span><span class="p">:</span> <span class="kt">ListAdapterPerformanceDelegate</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
582+
<pre class="highlight swift"><code><span class="k">weak</span> <span class="k">var</span> <span class="nv">performanceDelegate</span><span class="p">:</span> <span class="p">(</span><span class="kd">any</span> <span class="kt">ListAdapterPerformanceDelegate</span><span class="p">)?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
578583

579584
</div>
580585
</div>
@@ -604,6 +609,11 @@ <h4>Declaration</h4>
604609
<pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">readonly</span><span class="p">)</span> <span class="n">id</span><span class="o">&lt;</span><span class="n"><a href="../Protocols/IGListUpdatingDelegate.html">IGListUpdatingDelegate</a></span><span class="o">&gt;</span> <span class="n">_Nonnull</span> <span class="n">updater</span><span class="p">;</span></code></pre>
605610

606611
</div>
612+
<div class="language">
613+
<p class="aside-title">Swift</p>
614+
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">updater</span><span class="p">:</span> <span class="kd">any</span> <span class="kt"><a href="../Protocols/IGListUpdatingDelegate.html">IGListUpdatingDelegate</a></span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
615+
616+
</div>
607617
</div>
608618
</section>
609619
</div>
@@ -676,6 +686,11 @@ <h4>Declaration</h4>
676686
<span class="nf">workingRangeSize</span><span class="p">:(</span><span class="n">NSInteger</span><span class="p">)</span><span class="nv">workingRangeSize</span><span class="p">;</span></code></pre>
677687

678688
</div>
689+
<div class="language">
690+
<p class="aside-title">Swift</p>
691+
<pre class="highlight swift"><code><span class="nf">init</span><span class="p">(</span><span class="nv">updater</span><span class="p">:</span> <span class="kd">any</span> <span class="kt"><a href="../Protocols/IGListUpdatingDelegate.html">IGListUpdatingDelegate</a></span><span class="p">,</span> <span class="nv">viewController</span><span class="p">:</span> <span class="kt">UIViewController</span><span class="p">?,</span> <span class="nv">workingRangeSize</span><span class="p">:</span> <span class="kt">Int</span><span class="p">)</span></code></pre>
692+
693+
</div>
679694
</div>
680695
<div>
681696
<h4>Parameters</h4>
@@ -752,6 +767,11 @@ <h4>Declaration</h4>
752767
<span class="nf">viewController</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">UIViewController</span> <span class="o">*</span><span class="p">)</span><span class="nv">viewController</span><span class="p">;</span></code></pre>
753768

754769
</div>
770+
<div class="language">
771+
<p class="aside-title">Swift</p>
772+
<pre class="highlight swift"><code><span class="kd">convenience</span> <span class="nf">init</span><span class="p">(</span><span class="nv">updater</span><span class="p">:</span> <span class="kd">any</span> <span class="kt"><a href="../Protocols/IGListUpdatingDelegate.html">IGListUpdatingDelegate</a></span><span class="p">,</span> <span class="nv">viewController</span><span class="p">:</span> <span class="kt">UIViewController</span><span class="p">?)</span></code></pre>
773+
774+
</div>
755775
</div>
756776
<div>
757777
<h4>Parameters</h4>
@@ -1842,7 +1862,7 @@ <h4>Declaration</h4>
18421862
</div>
18431863
<div class="language">
18441864
<p class="aside-title">Swift</p>
1845-
<pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">add</span><span class="p">(</span><span class="n">_</span> <span class="nv">updateListener</span><span class="p">:</span> <span class="kt">ListAdapterUpdateListener</span><span class="p">)</span></code></pre>
1865+
<pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">add</span><span class="p">(</span><span class="n">_</span> <span class="nv">updateListener</span><span class="p">:</span> <span class="kd">any</span> <span class="kt">ListAdapterUpdateListener</span><span class="p">)</span></code></pre>
18461866

18471867
</div>
18481868
</div>
@@ -1894,7 +1914,7 @@ <h4>Declaration</h4>
18941914
</div>
18951915
<div class="language">
18961916
<p class="aside-title">Swift</p>
1897-
<pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">remove</span><span class="p">(</span><span class="n">_</span> <span class="nv">updateListener</span><span class="p">:</span> <span class="kt">ListAdapterUpdateListener</span><span class="p">)</span></code></pre>
1917+
<pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">remove</span><span class="p">(</span><span class="n">_</span> <span class="nv">updateListener</span><span class="p">:</span> <span class="kd">any</span> <span class="kt">ListAdapterUpdateListener</span><span class="p">)</span></code></pre>
18981918

18991919
</div>
19001920
</div>
@@ -1925,8 +1945,8 @@ <h4>Parameters</h4>
19251945
</section>
19261946
</section>
19271947
<section id="footer">
1928-
<p>&copy; 2023 <a class="link" href="https://twitter.com/MetaOpenSource" target="_blank" rel="external noopener">Instagram</a>. All rights reserved. (Last updated: 2023-04-07)</p>
1929-
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
1948+
<p>&copy; 2024 <a class="link" href="https://twitter.com/MetaOpenSource" target="_blank" rel="external noopener">Instagram</a>. All rights reserved. (Last updated: 2024-05-13)</p>
1949+
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.0</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
19301950
</section>
19311951
</article>
19321952
</div>

0 commit comments

Comments
 (0)