Skip to content

Commit c189462

Browse files
Ryan Nystromfacebook-github-bot
Ryan Nystrom
authored and
facebook-github-bot
committed
Generate docs for 3.3.0
Summary: Ran `build_docs.sh` script for 3.3.0 release Closes #1154 Differential Revision: D7728775 Pulled By: rnystrom fbshipit-source-id: 40a77e95387050a8d7c6bc4a629fdb06b7b0a7fa
1 parent 6771b41 commit c189462

File tree

55 files changed

+1824
-54
lines changed

Some content is hidden

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

55 files changed

+1824
-54
lines changed

‎docs/Classes.html

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,9 @@
3333
<li class="nav-group-task">
3434
<a href="best-practices-and-faq.html">Best Practices and FAQ</a>
3535
</li>
36+
<li class="nav-group-task">
37+
<a href="generating-your-models.html">Generating your models</a>
38+
</li>
3639
<li class="nav-group-task">
3740
<a href="getting-started.html">Getting Started</a>
3841
</li>
@@ -143,6 +146,9 @@
143146
<li class="nav-group-task">
144147
<a href="Protocols/IGListAdapterDelegate.html">IGListAdapterDelegate</a>
145148
</li>
149+
<li class="nav-group-task">
150+
<a href="Protocols/IGListAdapterMoveDelegate.html">IGListAdapterMoveDelegate</a>
151+
</li>
146152
<li class="nav-group-task">
147153
<a href="Protocols/IGListAdapterUpdateListener.html">IGListAdapterUpdateListener</a>
148154
</li>
@@ -928,7 +934,7 @@ <h4>Declaration</h4>
928934
</section>
929935
</section>
930936
<section id="footer">
931-
<p>&copy; 2018 <a class="link" href="https://twitter.com/fbOpenSource" target="_blank" rel="external">Instagram</a>. All rights reserved. (Last updated: 2018-02-06)</p>
937+
<p>&copy; 2018 <a class="link" href="https://twitter.com/fbOpenSource" target="_blank" rel="external">Instagram</a>. All rights reserved. (Last updated: 2018-04-21)</p>
932938
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
933939
</section>
934940
</article>

‎docs/Classes/IGListAdapter.html

Lines changed: 45 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,9 @@
3434
<li class="nav-group-task">
3535
<a href="../best-practices-and-faq.html">Best Practices and FAQ</a>
3636
</li>
37+
<li class="nav-group-task">
38+
<a href="../generating-your-models.html">Generating your models</a>
39+
</li>
3740
<li class="nav-group-task">
3841
<a href="../getting-started.html">Getting Started</a>
3942
</li>
@@ -144,6 +147,9 @@
144147
<li class="nav-group-task">
145148
<a href="../Protocols/IGListAdapterDelegate.html">IGListAdapterDelegate</a>
146149
</li>
150+
<li class="nav-group-task">
151+
<a href="../Protocols/IGListAdapterMoveDelegate.html">IGListAdapterMoveDelegate</a>
152+
</li>
147153
<li class="nav-group-task">
148154
<a href="../Protocols/IGListAdapterUpdateListener.html">IGListAdapterUpdateListener</a>
149155
</li>
@@ -469,6 +475,44 @@ <h4>Declaration</h4>
469475
</section>
470476
</div>
471477
</li>
478+
<li class="item">
479+
<div>
480+
<code>
481+
<a name="/c:objc(cs)IGListAdapter(py)moveDelegate"></a>
482+
<a name="//apple_ref/objc/Property/moveDelegate" class="dashAnchor"></a>
483+
<a class="token" href="#/c:objc(cs)IGListAdapter(py)moveDelegate">moveDelegate</a>
484+
</code>
485+
</div>
486+
<div class="height-container">
487+
<div class="pointer-container"></div>
488+
<section class="section">
489+
<div class="pointer"></div>
490+
<div class="abstract">
491+
<p>The object that receives <code><a href="../Protocols/IGListAdapterMoveDelegate.html">IGListAdapterMoveDelegate</a></code> events resulting from interactive reordering of sections.</p>
492+
<div class="aside aside-note">
493+
<p class="aside-title">Note</p>
494+
This works with UICollectionView interactive reordering available on iOS 9.0+
495+
496+
</div>
497+
498+
</div>
499+
<div class="declaration">
500+
<h4>Declaration</h4>
501+
<div class="language">
502+
<p class="aside-title">Objective-C</p>
503+
<pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">id</span><span class="o">&lt;</span><span class="n"><a href="../Protocols/IGListAdapterMoveDelegate.html">IGListAdapterMoveDelegate</a></span><span class="o">&gt;</span>
504+
<span class="n">moveDelegate</span><span class="p">;</span></code></pre>
505+
506+
</div>
507+
<div class="language">
508+
<p class="aside-title">Swift</p>
509+
<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>
510+
511+
</div>
512+
</div>
513+
</section>
514+
</div>
515+
</li>
472516
<li class="item">
473517
<div>
474518
<code>
@@ -1696,7 +1740,7 @@ <h4>Parameters</h4>
16961740
</section>
16971741
</section>
16981742
<section id="footer">
1699-
<p>&copy; 2018 <a class="link" href="https://twitter.com/fbOpenSource" target="_blank" rel="external">Instagram</a>. All rights reserved. (Last updated: 2018-02-06)</p>
1743+
<p>&copy; 2018 <a class="link" href="https://twitter.com/fbOpenSource" target="_blank" rel="external">Instagram</a>. All rights reserved. (Last updated: 2018-04-21)</p>
17001744
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
17011745
</section>
17021746
</article>

‎docs/Classes/IGListAdapterUpdater.html

Lines changed: 39 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,9 @@
3434
<li class="nav-group-task">
3535
<a href="../best-practices-and-faq.html">Best Practices and FAQ</a>
3636
</li>
37+
<li class="nav-group-task">
38+
<a href="../generating-your-models.html">Generating your models</a>
39+
</li>
3740
<li class="nav-group-task">
3841
<a href="../getting-started.html">Getting Started</a>
3942
</li>
@@ -144,6 +147,9 @@
144147
<li class="nav-group-task">
145148
<a href="../Protocols/IGListAdapterDelegate.html">IGListAdapterDelegate</a>
146149
</li>
150+
<li class="nav-group-task">
151+
<a href="../Protocols/IGListAdapterMoveDelegate.html">IGListAdapterMoveDelegate</a>
152+
</li>
147153
<li class="nav-group-task">
148154
<a href="../Protocols/IGListAdapterUpdateListener.html">IGListAdapterUpdateListener</a>
149155
</li>
@@ -376,6 +382,38 @@ <h4>Declaration</h4>
376382
</section>
377383
</div>
378384
</li>
385+
<li class="item">
386+
<div>
387+
<code>
388+
<a name="/c:objc(cs)IGListAdapterUpdater(py)coalescanceTime"></a>
389+
<a name="//apple_ref/objc/Property/coalescanceTime" class="dashAnchor"></a>
390+
<a class="token" href="#/c:objc(cs)IGListAdapterUpdater(py)coalescanceTime">coalescanceTime</a>
391+
</code>
392+
</div>
393+
<div class="height-container">
394+
<div class="pointer-container"></div>
395+
<section class="section">
396+
<div class="pointer"></div>
397+
<div class="abstract">
398+
<p>Time, in seconds, to wait and coalesce batch updates. Default is 0.</p>
399+
400+
</div>
401+
<div class="declaration">
402+
<h4>Declaration</h4>
403+
<div class="language">
404+
<p class="aside-title">Objective-C</p>
405+
<pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">assign</span><span class="p">,</span> <span class="n">readwrite</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSTimeInterval</span> <span class="n">coalescanceTime</span><span class="p">;</span></code></pre>
406+
407+
</div>
408+
<div class="language">
409+
<p class="aside-title">Swift</p>
410+
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">coalescanceTime</span><span class="p">:</span> <span class="kt">TimeInterval</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
411+
412+
</div>
413+
</div>
414+
</section>
415+
</div>
416+
</li>
379417
<li class="item">
380418
<div>
381419
<code>
@@ -413,7 +451,7 @@ <h4>Declaration</h4>
413451
</section>
414452
</section>
415453
<section id="footer">
416-
<p>&copy; 2018 <a class="link" href="https://twitter.com/fbOpenSource" target="_blank" rel="external">Instagram</a>. All rights reserved. (Last updated: 2018-02-06)</p>
454+
<p>&copy; 2018 <a class="link" href="https://twitter.com/fbOpenSource" target="_blank" rel="external">Instagram</a>. All rights reserved. (Last updated: 2018-04-21)</p>
417455
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
418456
</section>
419457
</article>

‎docs/Classes/IGListBatchUpdateData.html

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,9 @@
3434
<li class="nav-group-task">
3535
<a href="../best-practices-and-faq.html">Best Practices and FAQ</a>
3636
</li>
37+
<li class="nav-group-task">
38+
<a href="../generating-your-models.html">Generating your models</a>
39+
</li>
3740
<li class="nav-group-task">
3841
<a href="../getting-started.html">Getting Started</a>
3942
</li>
@@ -144,6 +147,9 @@
144147
<li class="nav-group-task">
145148
<a href="../Protocols/IGListAdapterDelegate.html">IGListAdapterDelegate</a>
146149
</li>
150+
<li class="nav-group-task">
151+
<a href="../Protocols/IGListAdapterMoveDelegate.html">IGListAdapterMoveDelegate</a>
152+
</li>
147153
<li class="nav-group-task">
148154
<a href="../Protocols/IGListAdapterUpdateListener.html">IGListAdapterUpdateListener</a>
149155
</li>
@@ -583,7 +589,7 @@ <h4>Return Value</h4>
583589
</section>
584590
</section>
585591
<section id="footer">
586-
<p>&copy; 2018 <a class="link" href="https://twitter.com/fbOpenSource" target="_blank" rel="external">Instagram</a>. All rights reserved. (Last updated: 2018-02-06)</p>
592+
<p>&copy; 2018 <a class="link" href="https://twitter.com/fbOpenSource" target="_blank" rel="external">Instagram</a>. All rights reserved. (Last updated: 2018-04-21)</p>
587593
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
588594
</section>
589595
</article>

‎docs/Classes/IGListBindingSectionController.html

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,9 @@
3434
<li class="nav-group-task">
3535
<a href="../best-practices-and-faq.html">Best Practices and FAQ</a>
3636
</li>
37+
<li class="nav-group-task">
38+
<a href="../generating-your-models.html">Generating your models</a>
39+
</li>
3740
<li class="nav-group-task">
3841
<a href="../getting-started.html">Getting Started</a>
3942
</li>
@@ -144,6 +147,9 @@
144147
<li class="nav-group-task">
145148
<a href="../Protocols/IGListAdapterDelegate.html">IGListAdapterDelegate</a>
146149
</li>
150+
<li class="nav-group-task">
151+
<a href="../Protocols/IGListAdapterMoveDelegate.html">IGListAdapterMoveDelegate</a>
152+
</li>
147153
<li class="nav-group-task">
148154
<a href="../Protocols/IGListAdapterUpdateListener.html">IGListAdapterUpdateListener</a>
149155
</li>
@@ -459,7 +465,7 @@ <h4>Parameters</h4>
459465
</section>
460466
</section>
461467
<section id="footer">
462-
<p>&copy; 2018 <a class="link" href="https://twitter.com/fbOpenSource" target="_blank" rel="external">Instagram</a>. All rights reserved. (Last updated: 2018-02-06)</p>
468+
<p>&copy; 2018 <a class="link" href="https://twitter.com/fbOpenSource" target="_blank" rel="external">Instagram</a>. All rights reserved. (Last updated: 2018-04-21)</p>
463469
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
464470
</section>
465471
</article>

‎docs/Classes/IGListCollectionView.html

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,9 @@
3434
<li class="nav-group-task">
3535
<a href="../best-practices-and-faq.html">Best Practices and FAQ</a>
3636
</li>
37+
<li class="nav-group-task">
38+
<a href="../generating-your-models.html">Generating your models</a>
39+
</li>
3740
<li class="nav-group-task">
3841
<a href="../getting-started.html">Getting Started</a>
3942
</li>
@@ -144,6 +147,9 @@
144147
<li class="nav-group-task">
145148
<a href="../Protocols/IGListAdapterDelegate.html">IGListAdapterDelegate</a>
146149
</li>
150+
<li class="nav-group-task">
151+
<a href="../Protocols/IGListAdapterMoveDelegate.html">IGListAdapterMoveDelegate</a>
152+
</li>
147153
<li class="nav-group-task">
148154
<a href="../Protocols/IGListAdapterUpdateListener.html">IGListAdapterUpdateListener</a>
149155
</li>
@@ -342,7 +348,7 @@ <h4>Parameters</h4>
342348
</section>
343349
</section>
344350
<section id="footer">
345-
<p>&copy; 2018 <a class="link" href="https://twitter.com/fbOpenSource" target="_blank" rel="external">Instagram</a>. All rights reserved. (Last updated: 2018-02-06)</p>
351+
<p>&copy; 2018 <a class="link" href="https://twitter.com/fbOpenSource" target="_blank" rel="external">Instagram</a>. All rights reserved. (Last updated: 2018-04-21)</p>
346352
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
347353
</section>
348354
</article>

‎docs/Classes/IGListCollectionViewLayout.html

Lines changed: 39 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,9 @@
3434
<li class="nav-group-task">
3535
<a href="../best-practices-and-faq.html">Best Practices and FAQ</a>
3636
</li>
37+
<li class="nav-group-task">
38+
<a href="../generating-your-models.html">Generating your models</a>
39+
</li>
3740
<li class="nav-group-task">
3841
<a href="../getting-started.html">Getting Started</a>
3942
</li>
@@ -144,6 +147,9 @@
144147
<li class="nav-group-task">
145148
<a href="../Protocols/IGListAdapterDelegate.html">IGListAdapterDelegate</a>
146149
</li>
150+
<li class="nav-group-task">
151+
<a href="../Protocols/IGListAdapterMoveDelegate.html">IGListAdapterMoveDelegate</a>
152+
</li>
147153
<li class="nav-group-task">
148154
<a href="../Protocols/IGListAdapterUpdateListener.html">IGListAdapterUpdateListener</a>
149155
</li>
@@ -382,6 +388,38 @@ <h4>Declaration</h4>
382388
</section>
383389
</div>
384390
</li>
391+
<li class="item">
392+
<div>
393+
<code>
394+
<a name="/c:objc(cs)IGListCollectionViewLayout(py)showHeaderWhenEmpty"></a>
395+
<a name="//apple_ref/objc/Property/showHeaderWhenEmpty" class="dashAnchor"></a>
396+
<a class="token" href="#/c:objc(cs)IGListCollectionViewLayout(py)showHeaderWhenEmpty">showHeaderWhenEmpty</a>
397+
</code>
398+
</div>
399+
<div class="height-container">
400+
<div class="pointer-container"></div>
401+
<section class="section">
402+
<div class="pointer"></div>
403+
<div class="abstract">
404+
<p>Set this to <code>YES</code> to show sticky header when a section had no item. Default is <code>NO</code>.</p>
405+
406+
</div>
407+
<div class="declaration">
408+
<h4>Declaration</h4>
409+
<div class="language">
410+
<p class="aside-title">Objective-C</p>
411+
<pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">assign</span><span class="p">,</span> <span class="n">readwrite</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">BOOL</span> <span class="n">showHeaderWhenEmpty</span><span class="p">;</span></code></pre>
412+
413+
</div>
414+
<div class="language">
415+
<p class="aside-title">Swift</p>
416+
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">showHeaderWhenEmpty</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
417+
418+
</div>
419+
</div>
420+
</section>
421+
</div>
422+
</li>
385423
<li class="item">
386424
<div>
387425
<code>
@@ -622,7 +660,7 @@ <h4>Return Value</h4>
622660
</section>
623661
</section>
624662
<section id="footer">
625-
<p>&copy; 2018 <a class="link" href="https://twitter.com/fbOpenSource" target="_blank" rel="external">Instagram</a>. All rights reserved. (Last updated: 2018-02-06)</p>
663+
<p>&copy; 2018 <a class="link" href="https://twitter.com/fbOpenSource" target="_blank" rel="external">Instagram</a>. All rights reserved. (Last updated: 2018-04-21)</p>
626664
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
627665
</section>
628666
</article>

0 commit comments

Comments
 (0)