From f536e2136d1f395efec5f17020710c678de0fbd5 Mon Sep 17 00:00:00 2001 From: Ryan Nystrom Date: Tue, 6 Feb 2018 15:42:25 -0800 Subject: [PATCH] Generate 3.2 docs Summary: Does this need to wait for #1086? Closes https://github.com/Instagram/IGListKit/pull/1085 Differential Revision: D6917735 Pulled By: rnystrom fbshipit-source-id: 08165c8d9f1215abac1d4bc7c65c1d23e31f758a --- Source/IGListAdapterUpdateListener.h | 3 + ...indingSectionControllerSelectionDelegate.h | 5 +- Source/IGListCollectionView.h | 3 + Source/IGListScrollDelegate.h | 3 +- Source/IGListSingleSectionController.h | 3 +- docs/Classes.html | 157 ++++-- docs/Classes/IGListAdapter.html | 236 +++++++-- docs/Classes/IGListAdapterUpdater.html | 39 +- docs/Classes/IGListBatchUpdateData.html | 51 +- .../IGListBindingSectionController.html | 45 +- docs/Classes/IGListCollectionView.html | 352 ++++++++++++++ docs/Classes/IGListCollectionViewLayout.html | 122 ++++- .../IGListGenericSectionController.html | 31 +- docs/Classes/IGListIndexPathResult.html | 55 ++- docs/Classes/IGListIndexSetResult.html | 55 ++- docs/Classes/IGListMoveIndex.html | 31 +- docs/Classes/IGListMoveIndexPath.html | 31 +- docs/Classes/IGListSectionController.html | 249 ++++++++-- .../IGListSingleSectionController.html | 39 +- .../IGListStackedSectionController.html | 27 +- docs/Constants.html | 27 +- docs/Enums.html | 76 ++- docs/Enums/IGListAdapterUpdateType.html | 369 ++++++++++++++ docs/Enums/IGListDiffOption.html | 37 +- docs/Enums/IGListExperiment.html | 105 +++- docs/Functions.html | 41 +- docs/Guides.html | 21 +- docs/Protocols.html | 193 ++++++-- docs/Protocols/IGListAdapterDataSource.html | 35 +- docs/Protocols/IGListAdapterDelegate.html | 31 +- .../IGListAdapterUpdateListener.html | 357 ++++++++++++++ .../IGListAdapterUpdaterDelegate.html | 82 ++-- docs/Protocols/IGListBatchContext.html | 43 +- docs/Protocols/IGListBindable.html | 27 +- ...istBindingSectionControllerDataSource.html | 33 +- ...ingSectionControllerSelectionDelegate.html | 243 +++++++++- docs/Protocols/IGListCollectionContext.html | 149 ++++-- .../IGListCollectionViewDelegateLayout.html | 456 ++++++++++++++++++ docs/Protocols/IGListDiffable.html | 31 +- docs/Protocols/IGListDisplayDelegate.html | 39 +- docs/Protocols/IGListScrollDelegate.html | 82 +++- ...IGListSingleSectionControllerDelegate.html | 97 +++- .../IGListSupplementaryViewSource.html | 35 +- docs/Protocols/IGListTransitionDelegate.html | 455 +++++++++++++++++ docs/Protocols/IGListUpdatingDelegate.html | 61 ++- .../Protocols/IGListWorkingRangeDelegate.html | 31 +- docs/Type Definitions.html | 49 +- docs/badge.svg | 29 +- docs/best-practices-and-faq.html | 27 +- docs/getting-started.html | 51 +- docs/iglistdiffable-and-equality.html | 33 +- docs/index.html | 27 +- docs/installation.html | 21 +- docs/migration.html | 59 ++- docs/modeling-and-binding.html | 21 +- docs/search.json | 2 +- docs/undocumented.json | 15 +- docs/vision.html | 21 +- docs/working-with-core-data.html | 27 +- docs/working-with-uicollectionview.html | 25 +- 60 files changed, 4391 insertions(+), 709 deletions(-) create mode 100644 docs/Classes/IGListCollectionView.html create mode 100644 docs/Enums/IGListAdapterUpdateType.html create mode 100644 docs/Protocols/IGListAdapterUpdateListener.html create mode 100644 docs/Protocols/IGListCollectionViewDelegateLayout.html create mode 100644 docs/Protocols/IGListTransitionDelegate.html diff --git a/Source/IGListAdapterUpdateListener.h b/Source/IGListAdapterUpdateListener.h index ddfe96986..9c8aad2bd 100644 --- a/Source/IGListAdapterUpdateListener.h +++ b/Source/IGListAdapterUpdateListener.h @@ -32,6 +32,9 @@ typedef NS_ENUM(NSInteger, IGListAdapterUpdateType) { IGListAdapterUpdateTypeItemUpdates, }; +/** + Conform to this protocol to receive events about `IGListAdapter` updates. + */ NS_SWIFT_NAME(ListAdapterUpdateListener) @protocol IGListAdapterUpdateListener diff --git a/Source/IGListBindingSectionControllerSelectionDelegate.h b/Source/IGListBindingSectionControllerSelectionDelegate.h index ae5992e54..5eef5aa6c 100644 --- a/Source/IGListBindingSectionControllerSelectionDelegate.h +++ b/Source/IGListBindingSectionControllerSelectionDelegate.h @@ -30,6 +30,8 @@ NS_SWIFT_NAME(ListBindingSectionControllerSelectionDelegate) didSelectItemAtIndex:(NSInteger)index viewModel:(id)viewModel; +@optional + /** Tells the delegate that a cell at a given index was deselected. @@ -39,7 +41,6 @@ NS_SWIFT_NAME(ListBindingSectionControllerSelectionDelegate) @note Method is `@optional` until the 4.0.0 release where it will become required. */ -@optional - (void)sectionController:(IGListBindingSectionController *)sectionController didDeselectItemAtIndex:(NSInteger)index viewModel:(id)viewModel; @@ -51,7 +52,6 @@ NS_SWIFT_NAME(ListBindingSectionControllerSelectionDelegate) @param index The index of the highlighted cell. @param viewModel The view model that was bound to the cell. */ -@optional - (void)sectionController:(IGListBindingSectionController *)sectionController didHighlightItemAtIndex:(NSInteger)index viewModel:(id)viewModel; @@ -63,7 +63,6 @@ NS_SWIFT_NAME(ListBindingSectionControllerSelectionDelegate) @param index The index of the unhighlighted cell. @param viewModel The view model that was bound to the cell. */ -@optional - (void)sectionController:(IGListBindingSectionController *)sectionController didUnhighlightItemAtIndex:(NSInteger)index viewModel:(id)viewModel; diff --git a/Source/IGListCollectionView.h b/Source/IGListCollectionView.h index 5fb505954..c9e9a961d 100644 --- a/Source/IGListCollectionView.h +++ b/Source/IGListCollectionView.h @@ -39,6 +39,9 @@ NS_SWIFT_NAME(ListCollectionView) */ - (instancetype)initWithFrame:(CGRect)frame collectionViewLayout:(UICollectionViewLayout *)collectionViewLayout NS_UNAVAILABLE; +/** + :nodoc: + */ - (instancetype)initWithCoder:(NSCoder *)aDecoder NS_UNAVAILABLE; @end diff --git a/Source/IGListScrollDelegate.h b/Source/IGListScrollDelegate.h index 6ce78366f..f2546e21e 100644 --- a/Source/IGListScrollDelegate.h +++ b/Source/IGListScrollDelegate.h @@ -46,6 +46,8 @@ NS_SWIFT_NAME(ListScrollDelegate) */ - (void)listAdapter:(IGListAdapter *)listAdapter didEndDraggingSectionController:(IGListSectionController *)sectionController willDecelerate:(BOOL)decelerate; +@optional + /** Tells the delegate that the section controller did end decelerating on screen. @@ -54,7 +56,6 @@ NS_SWIFT_NAME(ListScrollDelegate) @note This method is `@optional` until the next breaking-change release. */ -@optional - (void)listAdapter:(IGListAdapter *)listAdapter didEndDeceleratingSectionController:(IGListSectionController *)sectionController; @end diff --git a/Source/IGListSingleSectionController.h b/Source/IGListSingleSectionController.h index 5b3627143..745d45062 100644 --- a/Source/IGListSingleSectionController.h +++ b/Source/IGListSingleSectionController.h @@ -53,6 +53,8 @@ NS_SWIFT_NAME(ListSingleSectionControllerDelegate) - (void)didSelectSectionController:(IGListSingleSectionController *)sectionController withObject:(id)object; +@optional + /** Tells the delegate that the section controller was deselected. @@ -61,7 +63,6 @@ NS_SWIFT_NAME(ListSingleSectionControllerDelegate) @note Method is `@optional` until the 4.0.0 release where it will become required. */ -@optional - (void)didDeselectSectionController:(IGListSingleSectionController *)sectionController withObject:(id)object; diff --git a/docs/Classes.html b/docs/Classes.html index 2ecb9d343..9ae1dfeb3 100644 --- a/docs/Classes.html +++ b/docs/Classes.html @@ -74,6 +74,9 @@ + @@ -118,8 +121,11 @@ + @@ -119,8 +122,11 @@ + @@ -119,8 +122,11 @@ +
  • +
    + + + + -didModifySection: + +
    +
    +
    +
    +
    +
    +

    Notify the layout that a specific section was modified before invalidation. Used to optimize layout re-calculation.

    +
    +

    Note

    +

    When updating a collection view (ex: calling -insertSections), -invalidateLayoutWithContext gets called on +the layout object. However, the invalidation context doesn’t provide details on which index paths are being modified, +which typically forces a full layout re-calculation. We can use this method to keep track of which section actually +needs to be updated on the following -invalidateLayoutWithContext. See IGListCollectionView.

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    +
    - (void)didModifySection:(NSInteger)modifiedSection;
    + +
    +
    +

    Swift

    +
    func didModifySection(_ modifiedSection: Int)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + modifiedSection + + +
    +

    The section that was modified.

    +
    +
    +
    +
    +
    +
  • @@ -387,7 +461,7 @@

    Declaration

    Declaration

    Objective-C

    -
    - (nonnull instancetype)
    +                          
    - (nonnull instancetype)
     initWithStickyHeaders:(BOOL)stickyHeaders
           scrollDirection:(UICollectionViewScrollDirection)scrollDirection
           topContentInset:(CGFloat)topContentInset
    @@ -396,7 +470,7 @@ 

    Declaration

    Swift

    -
    init(stickyHeaders: Bool, scrollDirection: UICollectionViewScrollDirection, topContentInset: CGFloat, stretchToEdge: Bool)
    +
    init(stickyHeaders: Bool, scrollDirection: UICollectionViewScrollDirection, topContentInset: CGFloat, stretchToEdge: Bool)
    @@ -482,14 +556,14 @@

    Return Value

    Declaration

    Objective-C

    -
    - (nonnull instancetype)initWithStickyHeaders:(BOOL)stickyHeaders
    +                          
    - (nonnull instancetype)initWithStickyHeaders:(BOOL)stickyHeaders
                                   topContentInset:(CGFloat)topContentInset
                                     stretchToEdge:(BOOL)stretchToEdge;

    Swift

    -
    convenience init(stickyHeaders: Bool, topContentInset: CGFloat, stretchToEdge: Bool)
    +
    convenience init(stickyHeaders: Bool, topContentInset: CGFloat, stretchToEdge: Bool)
    @@ -548,8 +622,8 @@

    Return Value

    diff --git a/docs/Classes/IGListGenericSectionController.html b/docs/Classes/IGListGenericSectionController.html index 159764603..8f5b3ff6b 100644 --- a/docs/Classes/IGListGenericSectionController.html +++ b/docs/Classes/IGListGenericSectionController.html @@ -75,6 +75,9 @@
  • + @@ -119,8 +122,11 @@ + @@ -119,8 +122,11 @@ + + +
    +
      +
    • + +
      +
      +
      +
      +
      +

      Conform to IGListCollectionViewDelegateLayout to provide customized layout information for a collection view.

      + + See more +
      +
      +

      Declaration

      +
      +

      Objective-C

      +
      @protocol
      +    IGListCollectionViewDelegateLayout <UICollectionViewDelegateFlowLayout>

      Swift

      -
      protocol ListCollectionContext : NSObjectProtocol
      +
      protocol IGListCollectionViewDelegateLayout : UICollectionViewDelegateFlowLayout
      @@ -555,12 +645,12 @@

      Declaration

      Declaration

      Objective-C

      -
      @protocol IGListDiffable
      +
      @protocol IGListDiffable

      Swift

      -
      protocol ListDiffable
      +
      protocol ListDiffable
      @@ -592,12 +682,12 @@

      Declaration

      Declaration

      Objective-C

      -
      @protocol IGListDisplayDelegate <NSObject>
      +
      @protocol IGListDisplayDelegate <NSObject>

      Swift

      -
      protocol ListDisplayDelegate : NSObjectProtocol
      +
      protocol ListDisplayDelegate : NSObjectProtocol
    @@ -629,12 +719,12 @@

    Declaration

    Declaration

    Objective-C

    -
    @protocol IGListScrollDelegate <NSObject>
    +
    @protocol IGListScrollDelegate <NSObject>

    Swift

    -
    protocol ListScrollDelegate : NSObjectProtocol
    +
    protocol ListScrollDelegate : NSObjectProtocol
    @@ -666,12 +756,12 @@

    Declaration

    Declaration

    Objective-C

    -
    @protocol IGListSingleSectionControllerDelegate <NSObject>
    +
    @protocol IGListSingleSectionControllerDelegate <NSObject>

    Swift

    -
    protocol ListSingleSectionControllerDelegate : NSObjectProtocol
    +
    protocol ListSingleSectionControllerDelegate : NSObjectProtocol
    @@ -705,12 +795,49 @@

    Declaration

    Declaration

    Objective-C

    -
    @protocol IGListSupplementaryViewSource <NSObject>
    +
    @protocol IGListSupplementaryViewSource <NSObject>
    + +
    +
    +

    Swift

    +
    protocol ListSupplementaryViewSource : NSObjectProtocol
    + +
    + + + + + + +
    +
      +
    • + +
      +
      +
      +
      +
      +

      Conform to IGListTransitionDelegate to provide customized layout information for a collection view.

      + + See more +
      +
      +

      Declaration

      +
      +

      Objective-C

      +
      @protocol IGListTransitionDelegate <NSObject>

      Swift

      -
      protocol ListSupplementaryViewSource : NSObjectProtocol
      +
      protocol IGListTransitionDelegate
      @@ -743,12 +870,12 @@

      Declaration

      Declaration

      Objective-C

      -
      @protocol IGListUpdatingDelegate <NSObject>
      +
      @protocol IGListUpdatingDelegate <NSObject>

      Swift

      -
      protocol ListUpdatingDelegate : NSObjectProtocol
      +
      protocol ListUpdatingDelegate : NSObjectProtocol
      @@ -783,12 +910,12 @@

      Declaration

      Declaration

      Objective-C

      -
      @protocol IGListWorkingRangeDelegate <NSObject>
      +
      @protocol IGListWorkingRangeDelegate <NSObject>

      Swift

      -
      protocol ListWorkingRangeDelegate : NSObjectProtocol
      +
      protocol ListWorkingRangeDelegate : NSObjectProtocol
    @@ -800,8 +927,8 @@

    Declaration

    diff --git a/docs/Protocols/IGListAdapterDataSource.html b/docs/Protocols/IGListAdapterDataSource.html index 6fd87ccfa..1c5ab2cad 100644 --- a/docs/Protocols/IGListAdapterDataSource.html +++ b/docs/Protocols/IGListAdapterDataSource.html @@ -75,6 +75,9 @@ + @@ -119,8 +122,11 @@ + @@ -119,8 +122,11 @@