Generated docs HTML now goes to the FirebaseUI website. Fixed issue with __kindof (now returns id), clang-format changes to ignore certain pieces.

Author: asciimike

FirebaseUI/API/FirebaseArray.h

@@ -1,3 +1,5 @@
+// clang-format off
+
 /*
  * Firebase UI Bindings iOS Library
  *
@@ -26,6 +28,8 @@
  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
+// clang-format on
+
 #import <Foundation/Foundation.h>
 #import <FirebaseUI/XCodeMacros.h>
 

FirebaseUI/API/FirebaseArrayDelegate.h

@@ -1,3 +1,5 @@
+// clang-format off
+
 /*
  * Firebase UI Bindings iOS Library
  *
@@ -26,11 +28,12 @@
  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
+// clang-format on
+
 /**
  * A protocol to allow instances of FirebaseArray to raise events through a delegate. Raises all
  * Firebase events except FEventTypeValue.
  */
-
 @protocol FirebaseArrayDelegate<NSObject>
 
 @optional

FirebaseUI/API/FirebaseCollectionViewDataSource.h

@@ -1,3 +1,5 @@
+// clang-format off
+
 /*
  * Firebase UI Bindings iOS Library
  *
@@ -26,16 +28,21 @@
  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
+// clang-format on
+
 #import <Foundation/Foundation.h>
 
 #import "FirebaseArray.h"
 
 @class Firebase;
 
 /**
- * A FirebaseDataSource is a generic superclass for all Firebase datasources, like
- * FirebaseTableViewDataSource and FirebaseCollectionViewDataSource. It provides properties that all
- * subclasses need as well as several methods that pass through to the instance of FirebaseArray.
+ * A FirebaseDataSource is a generic superclass for all Firebase datasources,
+ * like
+ * FirebaseTableViewDataSource and FirebaseCollectionViewDataSource. It provides
+ * properties that all
+ * subclasses need as well as several methods that pass through to the instance
+ * of FirebaseArray.
  */
 @interface FirebaseDataSource : NSObject<FirebaseArrayDelegate>
 

FirebaseUI/API/FirebaseDataSource.h

@@ -1,3 +1,5 @@
+// clang-format off
+
 /*
  * Firebase UI Bindings iOS Library
  *
@@ -26,6 +28,8 @@
  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
+// clang-format on
+
 #import <UIKit/UIKit.h>
 #import <FirebaseUI/XCodeMacros.h>
 
@@ -34,20 +38,30 @@
 @class Firebase;
 
 /**
- * FirebaseTableViewDataSource provides an class that conforms to the UITableViewDataSource protocol
- * which allows UITableViews to implement FirebaseTableViewDataSource in order to provide a
- * UITableView synchronized to a Firebase reference or query. In addition to handling all Firebase
- * child events (added, changed, removed, moved), FirebaseTableViewDataSource handles
- * UITableViewCell creation, either with the default UITableViewCell, prototype cells, custom
- * UITableViewCell subclasses, or custom XIBs, and provides a simple [FirebaseTableViewDataSource
- * populateCellWithBlock:] method which allows developers to populate the cells created for them
+ * FirebaseTableViewDataSource provides an class that conforms to the
+ * UITableViewDataSource protocol
+ * which allows UITableViews to implement FirebaseTableViewDataSource in order
+ * to provide a
+ * UITableView synchronized to a Firebase reference or query. In addition to
+ * handling all Firebase
+ * child events (added, changed, removed, moved), FirebaseTableViewDataSource
+ * handles
+ * UITableViewCell creation, either with the default UITableViewCell, prototype
+ * cells, custom
+ * UITableViewCell subclasses, or custom XIBs, and provides a simple
+ * [FirebaseTableViewDataSource
+ * populateCellWithBlock:] method which allows developers to populate the cells
+ * created for them
  * with desired data from Firebase.
  */
-@interface FirebaseTableViewDataSource : FirebaseDataSource<UITableViewDataSource>
+@interface FirebaseTableViewDataSource
+    : FirebaseDataSource<UITableViewDataSource>
 
 /**
- * The model class to coerce FDataSnapshots to (if desired). For instance, if the modelClass is set
- * to [Message class] in Obj-C or Message.self in Swift, then objects of type Message will be
+ * The model class to coerce FDataSnapshots to (if desired). For instance, if
+ * the modelClass is set
+ * to [Message class] in Obj-C or Message.self in Swift, then objects of type
+ * Message will be
  * returned instead of type FDataSnapshot.
  */
 @property(strong, nonatomic, __NON_NULL) Class modelClass;
@@ -58,58 +72,70 @@
 @property(strong, nonatomic, __NON_NULL) NSString *reuseIdentifier;
 
 /**
- * The UITableView instance that operations (inserts, removals, moves, etc.) are performed against.
+ * The UITableView instance that operations (inserts, removals, moves, etc.) are
+ * performed against.
  */
 @property(strong, nonatomic, __NON_NULL) UITableView *tableView;
 
 /**
- * Property to keep track of prototype cell use, to not register a class for the UICollectionView or
+ * Property to keep track of prototype cell use, to not register a class for the
+ * UICollectionView or
  * do similar book keeping.
  */
 @property BOOL hasPrototypeCell;
 
 /**
- * The callback to populate a subclass of UITableViewCell with an object provided by the datasource.
+ * The callback to populate a subclass of UITableViewCell with an object
+ * provided by the datasource.
  */
 @property(strong, nonatomic, __NON_NULL) void (^populateCell)
-    (__KINDOF UITableViewCell *__NON_NULL_PTR cell, __KINDOF NSObject *__NON_NULL_PTR object);
+    (__KINDOF(UITableViewCell *) __NON_NULL_PTR cell,
+     __KINDOF(NSObject *) __NON_NULL_PTR object);
 
 /**
- * Initialize an instance of FirebaseTableViewDataSource that populates UITableViewCells with
+ * Initialize an instance of FirebaseTableViewDataSource that populates
+ * UITableViewCells with
  * FDataSnapshots.
  * @param ref A Firebase reference to bind the datasource to
  * @param identifier A string to use as a CellReuseIdentifier
  * @param tableView An instance of a UITableView to bind to
- * @return An instance of FirebaseTableViewDataSource that populates UITableViewCells with
+ * @return An instance of FirebaseTableViewDataSource that populates
+ * UITableViewCells with
  * FDataSnapshots
  */
 - (__NON_NULL instancetype)initWithRef:(__NON_NULL Firebase *)ref
                    cellReuseIdentifier:(__NON_NULL NSString *)identifier
                                   view:(__NON_NULL UITableView *)tableView;
 
 /**
- * Initialize an instance of FirebaseTableViewDataSource that populates UITableViewCells with
- * FDataSnapshots. Note that this method is used when using prototype cells, where the cells don't
+ * Initialize an instance of FirebaseTableViewDataSource that populates
+ * UITableViewCells with
+ * FDataSnapshots. Note that this method is used when using prototype cells,
+ * where the cells don't
  * need to be registered in the class.
  * @param ref A Firebase reference to bind the datasource to
  * @param identifier A string to use as a CellReuseIdentifier
  * @param tableView An instance of a UITableView to bind to
- * @return An instance of FirebaseTableViewDataSource that populates UITableViewCells with
+ * @return An instance of FirebaseTableViewDataSource that populates
+ * UITableViewCells with
  * FDataSnapshots
  */
 - (__NON_NULL instancetype)initWithRef:(__NON_NULL Firebase *)ref
               prototypeReuseIdentifier:(__NON_NULL NSString *)identifier
                                   view:(__NON_NULL UITableView *)tableView;
 
 /**
- * Initialize an instance of FirebaseTableViewDataSource that populates a custom subclass of
+ * Initialize an instance of FirebaseTableViewDataSource that populates a custom
+ * subclass of
  * UITableViewCell with FDataSnapshots.
  * @param ref A Firebase reference to bind the datasource to
- * @param cell A subclass of UITableViewCell used to populate the UITableView, defaults to
+ * @param cell A subclass of UITableViewCell used to populate the UITableView,
+ * defaults to
  * UITableViewCell if nil
  * @param identifier A string to use as a CellReuseIdentifier
  * @param tableView An instance of a UITableView to bind to
- * @return An instance of FirebaseTableViewDataSource that populates a custom subclass of
+ * @return An instance of FirebaseTableViewDataSource that populates a custom
+ * subclass of
  * UITableViewCell with FDataSnapshots
  */
 - (__NON_NULL instancetype)initWithRef:(__NON_NULL Firebase *)ref
@@ -118,13 +144,16 @@
                                   view:(__NON_NULL UITableView *)tableView;
 
 /**
- * Initialize an instance of FirebaseTableViewDataSource that populates a custom xib with
+ * Initialize an instance of FirebaseTableViewDataSource that populates a custom
+ * xib with
  * FDataSnapshots.
  * @param ref A Firebase reference to bind the datasource to
- * @param nibName The name of a xib file to create the layout for a UITableViewCell
+ * @param nibName The name of a xib file to create the layout for a
+ * UITableViewCell
  * @param identifier A string to use as a CellReuseIdentifier
  * @param tableView An instance of a UITableView to bind to
- * @return An instance of FirebaseTableViewDataSource that populates a custom xib with
+ * @return An instance of FirebaseTableViewDataSource that populates a custom
+ * xib with
  * FDataSnapshots
  */
 - (__NON_NULL instancetype)initWithRef:(__NON_NULL Firebase *)ref
@@ -133,13 +162,16 @@
                                   view:(__NON_NULL UITableView *)tableView;
 
 /**
- * Initialize an instance of FirebaseTableViewDataSource that populates UITableViewCells with a
+ * Initialize an instance of FirebaseTableViewDataSource that populates
+ * UITableViewCells with a
  * custom model class.
  * @param ref A Firebase reference to bind the datasource to
- * @param model A custom class that FDataSnapshots are coerced to, defaults to FDataSnapshot if nil
+ * @param model A custom class that FDataSnapshots are coerced to, defaults to
+ * FDataSnapshot if nil
  * @param identifier A string to use as a CellReuseIdentifier
  * @param tableView An instance of a UITableView to bind to
- * @return An instance of FirebaseTableViewDataSource that populates UITableViewCells with a custom
+ * @return An instance of FirebaseTableViewDataSource that populates
+ * UITableViewCells with a custom
  * model class
  */
 - (__NON_NULL instancetype)initWithRef:(__NON_NULL Firebase *)ref
@@ -148,14 +180,18 @@
                                   view:(__NON_NULL UITableView *)tableView;
 
 /**
- * Initialize an instance of FirebaseTableViewDataSource that populates UITableViewCells with a
- * custom model class. Note that this method is used when using prototype cells, where the cells
+ * Initialize an instance of FirebaseTableViewDataSource that populates
+ * UITableViewCells with a
+ * custom model class. Note that this method is used when using prototype cells,
+ * where the cells
  * don't need to be registered in the class.
  * @param ref A Firebase reference to bind the datasource to
- * @param model A custom class that FDataSnapshots are coerced to, defaults to FDataSnapshot if nil
+ * @param model A custom class that FDataSnapshots are coerced to, defaults to
+ * FDataSnapshot if nil
  * @param identifier A string to use as a CellReuseIdentifier
  * @param tableView An instance of a UITableView to bind to
- * @return An instance of FirebaseTableViewDataSource that populates UITableViewCells with a custom
+ * @return An instance of FirebaseTableViewDataSource that populates
+ * UITableViewCells with a custom
  * model class
  */
 - (__NON_NULL instancetype)initWithRef:(__NON_NULL Firebase *)ref
@@ -164,15 +200,19 @@
                                   view:(__NON_NULL UITableView *)tableView;
 
 /**
- * Initialize an instance of FirebaseTableViewDataSource that populates a custom subclass of
+ * Initialize an instance of FirebaseTableViewDataSource that populates a custom
+ * subclass of
  * UITableViewCell with a custom model class.
  * @param ref A Firebase reference to bind the datasource to
- * @param model A custom class that FDataSnapshots are coerced to, defaults to FDataSnapshot if nil
- * @param cell A subclass of UITableViewCell used to populate the UITableView, defaults to
+ * @param model A custom class that FDataSnapshots are coerced to, defaults to
+ * FDataSnapshot if nil
+ * @param cell A subclass of UITableViewCell used to populate the UITableView,
+ * defaults to
  * UITableViewCell if nil
  * @param identifier A string to use as a CellReuseIdentifier
  * @param tableView An instance of a UITableView to bind to
- * @return An instance of FirebaseTableViewDataSource that populates a custom subclass of
+ * @return An instance of FirebaseTableViewDataSource that populates a custom
+ * subclass of
  * UITableViewCell with a custom model class
  */
 - (__NON_NULL instancetype)initWithRef:(__NON_NULL Firebase *)ref
@@ -182,14 +222,18 @@
                                   view:(__NON_NULL UITableView *)tableView;
 
 /**
- * Initialize an instance of FirebaseTableViewDataSource that populates a custom xib with a custom
+ * Initialize an instance of FirebaseTableViewDataSource that populates a custom
+ * xib with a custom
  * model class.
  * @param ref A Firebase reference to bind the datasource to
- * @param model A custom class that FDataSnapshots are coerced to, defaults to FDataSnapshot if nil
- * @param nibName The name of a xib file to create the layout for a UITableViewCell
+ * @param model A custom class that FDataSnapshots are coerced to, defaults to
+ * FDataSnapshot if nil
+ * @param nibName The name of a xib file to create the layout for a
+ * UITableViewCell
  * @param identifier A string to use as a CellReuseIdentifier
  * @param tableView An instance of a UITableView to bind to
- * @return An instance of FirebaseTableViewDataSource that populates a custom xib with a custom
+ * @return An instance of FirebaseTableViewDataSource that populates a custom
+ * xib with a custom
  * model class
  */
 - (__NON_NULL instancetype)initWithRef:(__NON_NULL Firebase *)ref
@@ -199,12 +243,17 @@
                                   view:(__NON_NULL UITableView *)tableView;
 
 /**
- * This method populates the fields of a UITableViewCell or subclass given a model object (or
+ * This method populates the fields of a UITableViewCell or subclass given a
+ * model object (or
  * FDataSnapshot).
- * @param callback A block which returns an initialized UITableViewCell (or subclass) and the
+ * @param callback A block which returns an initialized UITableViewCell (or
+ * subclass) and the
  * corresponding object to populate the cell with.
  */
-- (void)populateCellWithBlock:(nonnull void (^)(__KINDOF UITableViewCell *__NON_NULL_PTR cell,
-                                                __KINDOF NSObject *__NON_NULL_PTR object))callback;
+// clang-format off
+- (void)populateCellWithBlock:
+    (nonnull void (^)(__KINDOF(UITableViewCell *)__NON_NULL_PTR cell,
+                      __KINDOF(NSObject *)__NON_NULL_PTR object))callback;
+// clang-format on
 
 @end

FirebaseUI/API/FirebaseTableViewDataSource.h

@@ -1,3 +1,5 @@
+// clang-format off
+
 /*
  * Firebase UI Bindings iOS Library
  *
@@ -26,6 +28,8 @@
  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
+// clang-format on
+
 #import <Foundation/Foundation.h>
 
 #import <FirebaseUI/FirebaseArray.h>

FirebaseUI/API/FirebaseUI.h

@@ -1,3 +1,5 @@
+// clang-format off
+
 /*
  * Firebase UI Bindings iOS Library
  *
@@ -7,8 +9,7 @@
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are met:
  *
- * 1. Redistributions of source code must retain the above copyright notice,
- *this
+ * 1. Redistributions of source code must retain the above copyright notice, this
  * list of conditions and the following disclaimer.
  *
  * 2. Redistributions in binaryform must reproduce the above copyright notice,
@@ -19,17 +20,16 @@
  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
  * EVENT SHALL FIREBASE BE LIABLE FOR ANY DIRECT,
- * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
- *(INCLUDING,
+ * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
- * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
- *OF
- * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
- *NEGLIGENCE
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+ * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
  * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
+// clang-format on
+
 #import <Firebase/Firebase.h>
 
 #import "FirebaseArray.h"