Skip to content

Commit f536e21

Browse files
Ryan Nystromfacebook-github-bot
Ryan Nystrom
authored and
facebook-github-bot
committed
Generate 3.2 docs
Summary: Does this need to wait for #1086? Closes #1085 Differential Revision: D6917735 Pulled By: rnystrom fbshipit-source-id: 08165c8d9f1215abac1d4bc7c65c1d23e31f758a
1 parent 33807fb commit f536e21

File tree

60 files changed

+4391
-709
lines changed

Some content is hidden

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

60 files changed

+4391
-709
lines changed

‎Source/IGListAdapterUpdateListener.h‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,9 @@ typedef NS_ENUM(NSInteger, IGListAdapterUpdateType) {
3232
IGListAdapterUpdateTypeItemUpdates,
3333
};
3434

35+
/**
36+
Conform to this protocol to receive events about `IGListAdapter` updates.
37+
*/
3538
NS_SWIFT_NAME(ListAdapterUpdateListener)
3639
@protocol IGListAdapterUpdateListener <NSObject>
3740

‎Source/IGListBindingSectionControllerSelectionDelegate.h‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,8 @@ NS_SWIFT_NAME(ListBindingSectionControllerSelectionDelegate)
3030
didSelectItemAtIndex:(NSInteger)index
3131
viewModel:(id)viewModel;
3232

33+
@optional
34+
3335
/**
3436
Tells the delegate that a cell at a given index was deselected.
3537
@@ -39,7 +41,6 @@ NS_SWIFT_NAME(ListBindingSectionControllerSelectionDelegate)
3941
4042
@note Method is `@optional` until the 4.0.0 release where it will become required.
4143
*/
42-
@optional
4344
- (void)sectionController:(IGListBindingSectionController *)sectionController
4445
didDeselectItemAtIndex:(NSInteger)index
4546
viewModel:(id)viewModel;
@@ -51,7 +52,6 @@ NS_SWIFT_NAME(ListBindingSectionControllerSelectionDelegate)
5152
@param index The index of the highlighted cell.
5253
@param viewModel The view model that was bound to the cell.
5354
*/
54-
@optional
5555
- (void)sectionController:(IGListBindingSectionController *)sectionController
5656
didHighlightItemAtIndex:(NSInteger)index
5757
viewModel:(id)viewModel;
@@ -63,7 +63,6 @@ NS_SWIFT_NAME(ListBindingSectionControllerSelectionDelegate)
6363
@param index The index of the unhighlighted cell.
6464
@param viewModel The view model that was bound to the cell.
6565
*/
66-
@optional
6766
- (void)sectionController:(IGListBindingSectionController *)sectionController
6867
didUnhighlightItemAtIndex:(NSInteger)index
6968
viewModel:(id)viewModel;

‎Source/IGListCollectionView.h‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,9 @@ NS_SWIFT_NAME(ListCollectionView)
3939
*/
4040
- (instancetype)initWithFrame:(CGRect)frame collectionViewLayout:(UICollectionViewLayout *)collectionViewLayout NS_UNAVAILABLE;
4141

42+
/**
43+
:nodoc:
44+
*/
4245
- (instancetype)initWithCoder:(NSCoder *)aDecoder NS_UNAVAILABLE;
4346

4447
@end

‎Source/IGListScrollDelegate.h‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,8 @@ NS_SWIFT_NAME(ListScrollDelegate)
4646
*/
4747
- (void)listAdapter:(IGListAdapter *)listAdapter didEndDraggingSectionController:(IGListSectionController *)sectionController willDecelerate:(BOOL)decelerate;
4848

49+
@optional
50+
4951
/**
5052
Tells the delegate that the section controller did end decelerating on screen.
5153
@@ -54,7 +56,6 @@ NS_SWIFT_NAME(ListScrollDelegate)
5456
5557
@note This method is `@optional` until the next breaking-change release.
5658
*/
57-
@optional
5859
- (void)listAdapter:(IGListAdapter *)listAdapter didEndDeceleratingSectionController:(IGListSectionController *)sectionController;
5960

6061
@end

‎Source/IGListSingleSectionController.h‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,8 @@ NS_SWIFT_NAME(ListSingleSectionControllerDelegate)
5353
- (void)didSelectSectionController:(IGListSingleSectionController *)sectionController
5454
withObject:(id)object;
5555

56+
@optional
57+
5658
/**
5759
Tells the delegate that the section controller was deselected.
5860
@@ -61,7 +63,6 @@ NS_SWIFT_NAME(ListSingleSectionControllerDelegate)
6163
6264
@note Method is `@optional` until the 4.0.0 release where it will become required.
6365
*/
64-
@optional
6566
- (void)didDeselectSectionController:(IGListSingleSectionController *)sectionController
6667
withObject:(id)object;
6768

‎docs/Classes.html‎

Lines changed: 109 additions & 48 deletions
Large diffs are not rendered by default.

‎docs/Classes/IGListAdapter.html‎

Lines changed: 183 additions & 53 deletions
Large diffs are not rendered by default.

‎docs/Classes/IGListAdapterUpdater.html‎

Lines changed: 27 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,9 @@
7575
<li class="nav-group-task">
7676
<a href="../Classes/IGListBindingSectionController.html">IGListBindingSectionController</a>
7777
</li>
78+
<li class="nav-group-task">
79+
<a href="../Classes/IGListCollectionView.html">IGListCollectionView</a>
80+
</li>
7881
<li class="nav-group-task">
7982
<a href="../Classes/IGListCollectionViewLayout.html">IGListCollectionViewLayout</a>
8083
</li>
@@ -119,8 +122,11 @@
119122
</ul>
120123
</li>
121124
<li class="nav-group-name">
122-
<a href="../Enums.html">Enums</a>
125+
<a href="../Enums.html">Enumerations</a>
123126
<ul class="nav-group-tasks">
127+
<li class="nav-group-task">
128+
<a href="../Enums/IGListAdapterUpdateType.html">IGListAdapterUpdateType</a>
129+
</li>
124130
<li class="nav-group-task">
125131
<a href="../Enums/IGListDiffOption.html">IGListDiffOption</a>
126132
</li>
@@ -138,6 +144,9 @@
138144
<li class="nav-group-task">
139145
<a href="../Protocols/IGListAdapterDelegate.html">IGListAdapterDelegate</a>
140146
</li>
147+
<li class="nav-group-task">
148+
<a href="../Protocols/IGListAdapterUpdateListener.html">IGListAdapterUpdateListener</a>
149+
</li>
141150
<li class="nav-group-task">
142151
<a href="../Protocols/IGListAdapterUpdaterDelegate.html">IGListAdapterUpdaterDelegate</a>
143152
</li>
@@ -156,6 +165,9 @@
156165
<li class="nav-group-task">
157166
<a href="../Protocols/IGListCollectionContext.html">IGListCollectionContext</a>
158167
</li>
168+
<li class="nav-group-task">
169+
<a href="../Protocols/IGListCollectionViewDelegateLayout.html">IGListCollectionViewDelegateLayout</a>
170+
</li>
159171
<li class="nav-group-task">
160172
<a href="../Protocols/IGListDiffable.html">IGListDiffable</a>
161173
</li>
@@ -171,6 +183,9 @@
171183
<li class="nav-group-task">
172184
<a href="../Protocols/IGListSupplementaryViewSource.html">IGListSupplementaryViewSource</a>
173185
</li>
186+
<li class="nav-group-task">
187+
<a href="../Protocols/IGListTransitionDelegate.html">IGListTransitionDelegate</a>
188+
</li>
174189
<li class="nav-group-task">
175190
<a href="../Protocols/IGListUpdatingDelegate.html">IGListUpdatingDelegate</a>
176191
</li>
@@ -233,7 +248,7 @@
233248
<h1>IGListAdapterUpdater</h1>
234249
<div class="declaration">
235250
<div class="language">
236-
<pre class="highlight"><code>
251+
<pre class="highlight objective_c"><code>
237252
<span class="k">@interface</span> <span class="nc">IGListAdapterUpdater</span> <span class="p">:</span> <span class="nc">NSObject</span> <span class="o">&lt;</span><span class="n"><a href="../Protocols/IGListUpdatingDelegate.html">IGListUpdatingDelegate</a></span><span class="o">&gt;</span></code></pre>
238253

239254
</div>
@@ -272,13 +287,13 @@ <h1>IGListAdapterUpdater</h1>
272287
<h4>Declaration</h4>
273288
<div class="language">
274289
<p class="aside-title">Objective-C</p>
275-
<pre class="highlight"><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>
290+
<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>
276291
<span class="n">id</span><span class="o">&lt;</span><span class="n"><a href="../Protocols/IGListAdapterUpdaterDelegate.html">IGListAdapterUpdaterDelegate</a></span><span class="o">&gt;</span> <span class="n">_Nullable</span> <span class="n">delegate</span><span class="p">;</span></code></pre>
277292

278293
</div>
279294
<div class="language">
280295
<p class="aside-title">Swift</p>
281-
<pre class="highlight"><code><span class="k">weak</span> <span class="k">var</span> <span class="nv">delegate</span><span class="p">:</span> <span class="kt">ListAdapterUpdaterDelegate</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>
296+
<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">ListAdapterUpdaterDelegate</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>
282297

283298
</div>
284299
</div>
@@ -305,12 +320,12 @@ <h4>Declaration</h4>
305320
<h4>Declaration</h4>
306321
<div class="language">
307322
<p class="aside-title">Objective-C</p>
308-
<pre class="highlight"><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">movesAsDeletesInserts</span><span class="p">;</span></code></pre>
323+
<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">movesAsDeletesInserts</span><span class="p">;</span></code></pre>
309324

310325
</div>
311326
<div class="language">
312327
<p class="aside-title">Swift</p>
313-
<pre class="highlight"><code><span class="k">var</span> <span class="nv">movesAsDeletesInserts</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>
328+
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">movesAsDeletesInserts</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>
314329

315330
</div>
316331
</div>
@@ -349,12 +364,12 @@ <h4>Declaration</h4>
349364
<h4>Declaration</h4>
350365
<div class="language">
351366
<p class="aside-title">Objective-C</p>
352-
<pre class="highlight"><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">allowsBackgroundReloading</span><span class="p">;</span></code></pre>
367+
<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">allowsBackgroundReloading</span><span class="p">;</span></code></pre>
353368

354369
</div>
355370
<div class="language">
356371
<p class="aside-title">Swift</p>
357-
<pre class="highlight"><code><span class="k">var</span> <span class="nv">allowsBackgroundReloading</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>
372+
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">allowsBackgroundReloading</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>
358373

359374
</div>
360375
</div>
@@ -381,12 +396,12 @@ <h4>Declaration</h4>
381396
<h4>Declaration</h4>
382397
<div class="language">
383398
<p class="aside-title">Objective-C</p>
384-
<pre class="highlight"><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"><a href="../Enums/IGListExperiment.html">IGListExperiment</a></span> <span class="n">experiments</span><span class="p">;</span></code></pre>
399+
<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"><a href="../Enums/IGListExperiment.html">IGListExperiment</a></span> <span class="n">experiments</span><span class="p">;</span></code></pre>
385400

386401
</div>
387402
<div class="language">
388403
<p class="aside-title">Swift</p>
389-
<pre class="highlight"><code><span class="k">var</span> <span class="nv">experiments</span><span class="p">:</span> <span class="kt"><a href="../Enums/IGListExperiment.html">IGListExperiment</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
404+
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">experiments</span><span class="p">:</span> <span class="kt"><a href="../Enums/IGListExperiment.html">IGListExperiment</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
390405

391406
</div>
392407
</div>
@@ -398,8 +413,8 @@ <h4>Declaration</h4>
398413
</section>
399414
</section>
400415
<section id="footer">
401-
<p>&copy; 2017 <a class="link" href="https://twitter.com/fbOpenSource" target="_blank" rel="external">Instagram</a>. All rights reserved. (Last updated: 2017-08-31)</p>
402-
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.3</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
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>
417+
<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>
403418
</section>
404419
</article>
405420
</div>

0 commit comments

Comments
 (0)