IGListKit/Source/IGListAdapterDelegate.h
Bas Broek edc38c77fe Remove @param alignment from header docs #trivial
Summary:
Issue fixed: #655

- [x] All tests pass. Demo project builds and runs.
- [ ] I added tests, an experiment, or detailed why my change isn't tested.
- [ ] I added an entry to the `CHANGELOG.md` for any breaking changes, enhancements, or bug fixes.
- [x] I have reviewed the [contributing guide](https://github.com/Instagram/IGListKit/blob/master/.github/CONTRIBUTING.md)

I've also addressed a few cases where there was no empty line between the `param`s and `return`.
Closes https://github.com/Instagram/IGListKit/pull/665

Differential Revision: D4906215

Pulled By: jessesquires

fbshipit-source-id: 5693c85eb548644b0b0e2571eea8ff4d9f706b12
2017-04-18 09:46:18 -07:00

41 lines
1.2 KiB
Objective-C

/**
* Copyright (c) 2016-present, Facebook, Inc.
* All rights reserved.
*
* This source code is licensed under the BSD-style license found in the
* LICENSE file in the root directory of this source tree. An additional grant
* of patent rights can be found in the PATENTS file in the same directory.
*/
#import <Foundation/Foundation.h>
@class IGListAdapter;
NS_ASSUME_NONNULL_BEGIN
/**
Conform to `IGListAdapterDelegate` to receive display events for objects in a list.
*/
@protocol IGListAdapterDelegate <NSObject>
/**
Notifies the delegate that a list object is about to be displayed.
@param listAdapter The list adapter sending this information.
@param object The object that will display.
@param index The index of the object in the list.
*/
- (void)listAdapter:(IGListAdapter *)listAdapter willDisplayObject:(id)object atIndex:(NSInteger)index;
/**
Notifies the delegate that a list object is no longer being displayed.
@param listAdapter The list adapter sending this information.
@param object The object that ended display.
@param index The index of the object in the list.
*/
- (void)listAdapter:(IGListAdapter *)listAdapter didEndDisplayingObject:(id)object atIndex:(NSInteger)index;
@end
NS_ASSUME_NONNULL_END