Update Firestore's public headers to use Swift class names. (#9544)

* Update Firestore's public headers to use Swift class names.

* Address comments.

Author: ehsannas

Firestore/Source/Public/FirebaseFirestore/FIRCollectionReference.h

@@ -23,8 +23,8 @@ NS_ASSUME_NONNULL_BEGIN
 @class FIRDocumentReference;
 
 /**
- * A `FIRCollectionReference` object can be used for adding documents, getting document references,
- * and querying for documents (using the methods inherited from `FIRQuery`).
+ * A `CollectionReference` object can be used for adding documents, getting document references,
+ * and querying for documents (using the methods inherited from `Query`).
  */
 NS_SWIFT_NAME(CollectionReference)
 @interface FIRCollectionReference : FIRQuery
@@ -36,42 +36,42 @@ NS_SWIFT_NAME(CollectionReference)
 @property(nonatomic, strong, readonly) NSString *collectionID;
 
 /**
- * For subcollections, `parent` returns the containing `FIRDocumentReference`.  For root
- * collections, nil is returned.
+ * For subcollections, `parent` returns the containing `DocumentReference`.  For root collections,
+ * `nil` is returned.
  */
 @property(nonatomic, strong, nullable, readonly) FIRDocumentReference *parent;
 
 /**
- * A string containing the slash-separated path to this this `FIRCollectionReference` (relative to
- * the root of the database).
+ * A string containing the slash-separated path to this this `CollectionReference` (relative to the
+ * root of the database).
  */
 @property(nonatomic, strong, readonly) NSString *path;
 
 /**
- * Returns a FIRDocumentReference pointing to a new document with an auto-generated ID.
+ * Returns a `DocumentReference` pointing to a new document with an auto-generated ID.
  *
- * @return A FIRDocumentReference pointing to a new document with an auto-generated ID.
+ * @return A `DocumentReference` pointing to a new document with an auto-generated ID.
  */
 - (FIRDocumentReference *)documentWithAutoID NS_SWIFT_NAME(document());
 
 /**
- * Gets a `FIRDocumentReference` referring to the document at the specified path, relative to this
+ * Gets a `DocumentReference` referring to the document at the specified path, relative to this
  * collection's own path.
  *
  * @param documentPath The slash-separated relative path of the document for which to get a
- * `FIRDocumentReference`.
+ * `DocumentReference`.
  *
- * @return The `FIRDocumentReference` for the specified document path.
+ * @return The `DocumentReference` for the specified document path.
  */
 - (FIRDocumentReference *)documentWithPath:(NSString *)documentPath NS_SWIFT_NAME(document(_:));
 
 /**
  * Adds a new document to this collection with the specified data, assigning it a document ID
  * automatically.
  *
- * @param data An `NSDictionary` containing the data for the new document.
+ * @param data A `Dictionary` containing the data for the new document.
  *
- * @return A `FIRDocumentReference` pointing to the newly created document.
+ * @return A `DocumentReference` pointing to the newly created document.
  */
 - (FIRDocumentReference *)addDocumentWithData:(NSDictionary<NSString *, id> *)data
     NS_SWIFT_NAME(addDocument(data:));
@@ -80,12 +80,12 @@ NS_SWIFT_NAME(CollectionReference)
  * Adds a new document to this collection with the specified data, assigning it a document ID
  * automatically.
  *
- * @param data An `NSDictionary` containing the data for the new document.
+ * @param data A `Dictionary` containing the data for the new document.
  * @param completion A block to execute once the document has been successfully written to
  *     the server. This block will not be called while the client is offline, though local
  *     changes will be visible immediately.
  *
- * @return A `FIRDocumentReference` pointing to the newly created document.
+ * @return A `DocumentReference` pointing to the newly created document.
  */
 // clang-format off
 // clang-format breaks the NS_SWIFT_NAME attribute

Firestore/Source/Public/FirebaseFirestore/FIRDocumentChange.h

@@ -40,7 +40,7 @@ typedef NS_ENUM(NSInteger, FIRDocumentChangeType)
 } NS_SWIFT_NAME(DocumentChangeType);
 
 /**
- * A `FIRDocumentChange` represents a change to the documents matching a query. It contains the
+ * A `DocumentChange` represents a change to the documents matching a query. It contains the
  * document affected and the type of change that occurred (added, modified, or removed).
  */
 NS_SWIFT_NAME(DocumentChange)
@@ -56,16 +56,16 @@ NS_SWIFT_NAME(DocumentChange)
 @property(nonatomic, strong, readonly) FIRQueryDocumentSnapshot *document;
 
 /**
- * The index of the changed document in the result set immediately prior to this FIRDocumentChange
- * (i.e. supposing that all prior FIRDocumentChange objects have been applied). NSNotFound for
- * FIRDocumentChangeTypeAdded events.
+ * The index of the changed document in the result set immediately prior to this `DocumentChange`
+ * (i.e. supposing that all prior `DocumentChange` objects have been applied). `NSNotFound` for
+ * `DocumentChangeTypeAdded` events.
  */
 @property(nonatomic, readonly) NSUInteger oldIndex;
 
 /**
- * The index of the changed document in the result set immediately after this FIRDocumentChange
- * (i.e. supposing that all prior FIRDocumentChange objects and the current FIRDocumentChange object
- * have been applied). NSNotFound for FIRDocumentChangeTypeRemoved events.
+ * The index of the changed document in the result set immediately after this `DocumentChange`
+ * (i.e. supposing that all prior `DocumentChange` objects and the current `DocumentChange` object
+ * have been applied). `NSNotFound` for `DocumentChangeTypeRemoved` events.
  */
 @property(nonatomic, readonly) NSUInteger newIndex;
 

Firestore/Source/Public/FirebaseFirestore/FIRDocumentReference.h

@@ -32,10 +32,10 @@ typedef void (^FIRDocumentSnapshotBlock)(FIRDocumentSnapshot *_Nullable snapshot
                                          NSError *_Nullable error);
 
 /**
- * A `FIRDocumentReference` refers to a document location in a Firestore database and can be
+ * A `DocumentReference` refers to a document location in a Firestore database and can be
  * used to write, read, or listen to the location. The document at the referenced location
- * may or may not exist. A `FIRDocumentReference` can also be used to create a
- * `FIRCollectionReference` to a subcollection.
+ * may or may not exist. A `DocumentReference` can also be used to create a `CollectionReference` to
+ * a subcollection.
  */
 NS_SWIFT_NAME(DocumentReference)
 @interface FIRDocumentReference : NSObject
@@ -50,7 +50,7 @@ NS_SWIFT_NAME(DocumentReference)
 /** A reference to the collection to which this `DocumentReference` belongs. */
 @property(nonatomic, strong, readonly) FIRCollectionReference *parent;
 
-/** The `FIRFirestore` for the Firestore database (useful for performing transactions, etc.). */
+/** The `Firestore` for the Firestore database (useful for performing transactions, etc.). */
 @property(nonatomic, strong, readonly) FIRFirestore *firestore;
 
 /**
@@ -60,35 +60,35 @@ NS_SWIFT_NAME(DocumentReference)
 @property(nonatomic, strong, readonly) NSString *path;
 
 /**
- * Gets a `FIRCollectionReference` referring to the collection at the specified
- * path, relative to this document.
+ * Gets a `CollectionReference` referring to the collection at the specified path, relative to this
+ * document.
  *
  * @param collectionPath The slash-separated relative path of the collection for which to get a
- * `FIRCollectionReference`.
+ * `CollectionReference`.
  *
- * @return The `FIRCollectionReference` at the specified _collectionPath_.
+ * @return The `CollectionReference` at the specified _collectionPath_.
  */
 - (FIRCollectionReference *)collectionWithPath:(NSString *)collectionPath
     NS_SWIFT_NAME(collection(_:));
 
 #pragma mark - Writing Data
 
 /**
- * Writes to the document referred to by `FIRDocumentReference`. If the document doesn't yet exist,
+ * Writes to the document referred to by `DocumentReference`. If the document doesn't yet exist,
  * this method creates it and then sets the data. If the document exists, this method overwrites
  * the document data with the new values.
  *
- * @param documentData An `NSDictionary` that contains the fields and data to write to the
+ * @param documentData A `Dictionary` that contains the fields and data to write to the
  * document.
  */
 - (void)setData:(NSDictionary<NSString *, id> *)documentData;
 
 /**
- * Writes to the document referred to by this DocumentReference. If the document does not yet
- * exist, it will be created. If you pass `merge:YES`, the provided data will be merged into
+ * Writes to the document referred to by this `DocumentReference`. If the document does not yet
+ * exist, it will be created. If you pass `merge:true`, the provided data will be merged into
  * any existing document.
  *
- * @param documentData An `NSDictionary` that contains the fields and data to write to the
+ * @param documentData A `Dictionary` that contains the fields and data to write to the
  * document.
  * @param merge Whether to merge the provided data into any existing document. If enabled,
  * all omitted fields remain untouched. If your input sets any field to an empty dictionary, any
@@ -105,20 +105,20 @@ NS_SWIFT_NAME(DocumentReference)
  * It is an error to include a field in `mergeFields` that does not have a corresponding
  * value in the `data` dictionary.
  *
- * @param documentData An `NSDictionary` containing the fields that make up the document
+ * @param documentData A `Dictionary` containing the fields that make up the document
  * to be written.
- * @param mergeFields An `NSArray` that contains a list of `NSString` or `FIRFieldPath` elements
+ * @param mergeFields An `Array` that contains a list of `String` or `FieldPath` elements
  * specifying which fields to merge. Fields can contain dots to reference nested fields within
  * the document. If your input sets any field to an empty dictionary, any nested field is
  * overwritten.
  */
 - (void)setData:(NSDictionary<NSString *, id> *)documentData mergeFields:(NSArray<id> *)mergeFields;
 
 /**
- * Overwrites the document referred to by this `FIRDocumentReference`. If no document exists, it
+ * Overwrites the document referred to by this `DocumentReference`. If no document exists, it
  * is created. If a document already exists, it is overwritten.
  *
- * @param documentData An `NSDictionary` containing the fields that make up the document
+ * @param documentData A `Dictionary` containing the fields that make up the document
  *     to be written.
  * @param completion A block to execute once the document has been successfully written to the
  *     server. This block will not be called while the client is offline, though local
@@ -128,11 +128,11 @@ NS_SWIFT_NAME(DocumentReference)
      completion:(nullable void (^)(NSError *_Nullable error))completion;
 
 /**
- * Writes to the document referred to by this DocumentReference. If the document does not yet
- * exist, it will be created. If you pass `merge:YES`, the provided data will be merged into
+ * Writes to the document referred to by this `DocumentReference`. If the document does not yet
+ * exist, it will be created. If you pass `merge:true`, the provided data will be merged into
  * any existing document.
  *
- * @param documentData An `NSDictionary` containing the fields that make up the document
+ * @param documentData A `Dictionary` containing the fields that make up the document
  * to be written.
  * @param merge Whether to merge the provided data into any existing document. If your input sets
  *     any field to an empty dictionary, any nested field is overwritten.
@@ -153,9 +153,9 @@ NS_SWIFT_NAME(DocumentReference)
  * It is an error to include a field in `mergeFields` that does not have a corresponding
  * value in the `data` dictionary.
  *
- * @param documentData An `NSDictionary` containing the fields that make up the document
+ * @param documentData A `Dictionary` containing the fields that make up the document
  * to be written.
- * @param mergeFields An `NSArray` that contains a list of `NSString` or `FIRFieldPath` elements
+ * @param mergeFields An `Array` that contains a list of `String` or `FieldPath` elements
  *     specifying which fields to merge. Fields can contain dots to reference nested fields within
  *     the document. If your input sets any field to an empty dictionary, any nested field is
  *     overwritten.
@@ -168,20 +168,20 @@ NS_SWIFT_NAME(DocumentReference)
      completion:(nullable void (^)(NSError *_Nullable error))completion;
 
 /**
- * Updates fields in the document referred to by this `FIRDocumentReference`.
+ * Updates fields in the document referred to by this `DocumentReference`.
  * If the document does not exist, the update fails (specify a completion block to be notified).
  *
- * @param fields An `NSDictionary` containing the fields (expressed as an `NSString` or
- *     `FIRFieldPath`) and values with which to update the document.
+ * @param fields A `Dictionary` containing the fields (expressed as an `String` or
+ *     `FieldPath`) and values with which to update the document.
  */
 - (void)updateData:(NSDictionary<id, id> *)fields;
 
 /**
- * Updates fields in the document referred to by this `FIRDocumentReference`. If the document
+ * Updates fields in the document referred to by this `DocumentReference`. If the document
  * does not exist, the update fails and the specified completion block receives an error.
  *
- * @param fields An `NSDictionary` containing the fields (expressed as an `NSString` or
- *     `FIRFieldPath`) and values with which to update the document.
+ * @param fields A `Dictionary` containing the fields (expressed as a `String` or
+ *     `FieldPath`) and values with which to update the document.
  * @param completion A block to execute when the update is complete. If the update is successful the
  *     error parameter will be nil, otherwise it will give an indication of how the update failed.
  *     This block will only execute when the client is online and the commit has completed against
@@ -191,14 +191,15 @@ NS_SWIFT_NAME(DocumentReference)
 - (void)updateData:(NSDictionary<id, id> *)fields
         completion:(nullable void (^)(NSError *_Nullable error))completion;
 
-// NOTE: this is named 'deleteDocument' because 'delete' is a keyword in Objective-C++.
-/** Deletes the document referred to by this `FIRDocumentReference`. */
+// NOTE: this method is named 'deleteDocument' in Objective-C because 'delete' is a keyword in
+// Objective-C++.
+/** Deletes the document referred to by this `DocumentReference`. */
 // clang-format off
 - (void)deleteDocument NS_SWIFT_NAME(delete());
 // clang-format on
 
 /**
- * Deletes the document referred to by this `FIRDocumentReference`.
+ * Deletes the document referred to by this `DocumentReference`.
  *
  * @param completion A block to execute once the document has been successfully written to the
  *     server. This block will not be called while the client is offline, though local
@@ -212,7 +213,7 @@ NS_SWIFT_NAME(DocumentReference)
 #pragma mark - Retrieving Data
 
 /**
- * Reads the document referenced by this `FIRDocumentReference`.
+ * Reads the document referenced by this `DocumentReference`.
  *
  * This method attempts to provide up-to-date data when possible by waiting for
  * data from the server, but it may return cached data or fail if you are
@@ -225,7 +226,7 @@ NS_SWIFT_NAME(DocumentReference)
     NS_SWIFT_NAME(getDocument(completion:));
 
 /**
- * Reads the document referenced by this `FIRDocumentReference`.
+ * Reads the document referenced by this `DocumentReference`.
  *
  * @param source indicates whether the results should be fetched from the cache
  *     only (`Source.cache`), the server only (`Source.server`), or to attempt
@@ -239,23 +240,23 @@ NS_SWIFT_NAME(DocumentReference)
 // clang-format on
 
 /**
- * Attaches a listener for DocumentSnapshot events.
+ * Attaches a listener for `DocumentSnapshot` events.
  *
  * @param listener The listener to attach.
  *
- * @return A FIRListenerRegistration that can be used to remove this listener.
+ * @return A `ListenerRegistration` that can be used to remove this listener.
  */
 - (id<FIRListenerRegistration>)addSnapshotListener:(FIRDocumentSnapshotBlock)listener
     NS_SWIFT_NAME(addSnapshotListener(_:));
 
 /**
- * Attaches a listener for DocumentSnapshot events.
+ * Attaches a listener for `DocumentSnapshot` events.
  *
  * @param includeMetadataChanges Whether metadata-only changes (i.e. only
- *     `FIRDocumentSnapshot.metadata` changed) should trigger snapshot events.
+ *     `DocumentSnapshot.metadata` changed) should trigger snapshot events.
  * @param listener The listener to attach.
  *
- * @return A FIRListenerRegistration that can be used to remove this listener.
+ * @return A `ListenerRegistration` that can be used to remove this listener.
  */
 // clang-format off
 - (id<FIRListenerRegistration>)