Skip to content

Commit aa3a395

Browse files
committed
update doc comments
1 parent 4213c5f commit aa3a395

File tree

3 files changed

+17
-2
lines changed

3 files changed

+17
-2
lines changed

FirebaseDatabaseUI/FirebaseIndexArray.h

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,13 +98,19 @@ didFailLoadWithError:(NSError *)error;
9898

9999
/**
100100
* Delegate method which is called whenever the backing query is canceled. This error is fatal
101-
* and the index array will become unusable afterward, so please handle it appropriately.
101+
* and the index array will become unusable afterward, so please handle it appropriately
102+
* (i.e. by displaying a modal error explaining why there's no content).
102103
* @param error the error that was raised
103104
*/
104105
- (void)array:(FirebaseIndexArray *)array queryCancelledWithError:(NSError *)error;
105106

106107
@end
107108

109+
/**
110+
* A FirebaseIndexArray instance uses a query's contents to query children of
111+
* a separate database reference, which is useful for displaying an indexed list
112+
* of data as described in https://firebase.google.com/docs/database/ios/structure-data
113+
*/
108114
@interface FirebaseIndexArray : NSObject
109115

110116
/**

FirebaseDatabaseUI/FirebaseIndexCollectionViewDataSource.h

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,11 @@ didFailLoadAtIndex:(NSUInteger)index
5050

5151
@end
5252

53-
53+
/**
54+
* An object that manages a @c FirebaseIndexArray and uses it to populate and update
55+
* a collection view with a single section. The data source maintains a reference to but
56+
* does not claim ownership of the collection view that it updates.
57+
*/
5458
@interface FirebaseIndexCollectionViewDataSource : NSObject <UICollectionViewDataSource>
5559

5660
@property (nonatomic, readwrite, weak, nullable) id<FirebaseIndexCollectionViewDataSourceDelegate> delegate;

FirebaseDatabaseUI/FirebaseIndexTableViewDataSource.h

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,11 @@ didFailLoadAtIndex:(NSUInteger)index
5050

5151
@end
5252

53+
/**
54+
* An object that manages a @c FirebaseIndexArray and uses it to populate and update
55+
* a table view with a single section. The data source maintains a reference to but
56+
* does not claim ownership of the table view that it updates.
57+
*/
5358
@interface FirebaseIndexTableViewDataSource : NSObject <UITableViewDataSource>
5459

5560
/**

0 commit comments

Comments
 (0)