Merge branch 'master' of github.com:firebase/firebase-android-sdk into ankita_fis

Author: ankitaj224

firebase-firestore/src/androidTest/java/com/google/firebase/firestore/ValidationTest.java

@@ -277,7 +277,7 @@ public void updatesMustNotContainNestedFieldValueDeletes() {
   @Test
   public void batchWritesRequireCorrectDocumentReferences() {
     DocumentReference badRef = testAlternateFirestore().document("foo/bar");
-    String reason = "Provided document reference is from a different Firestore instance.";
+    String reason = "Provided document reference is from a different Cloud Firestore instance.";
     Map<String, Object> data = map("foo", 1);
     WriteBatch batch = testFirestore().batch();
     expectError(() -> batch.set(badRef, data), reason);
@@ -288,7 +288,7 @@ public void batchWritesRequireCorrectDocumentReferences() {
   @Test
   public void transactionsRequireCorrectDocumentReferences() {
     DocumentReference badRef = testAlternateFirestore().document("foo/bar");
-    String reason = "Provided document reference is from a different Firestore instance.";
+    String reason = "Provided document reference is from a different Cloud Firestore instance.";
     Map<String, Object> data = map("foo", 1);
     waitFor(
         testFirestore()

firebase-firestore/src/main/java/com/google/firebase/firestore/Blob.java

@@ -23,7 +23,7 @@
 import com.google.firebase.firestore.util.Util;
 import com.google.protobuf.ByteString;
 
-/** Immutable class representing an array of bytes in Firestore. */
+/** Immutable class representing an array of bytes in Cloud Firestore. */
 @PublicApi
 public class Blob implements Comparable<Blob> {
   private final ByteString bytes;
@@ -33,10 +33,11 @@ private Blob(ByteString bytes) {
   }
 
   /**
-   * Creates a new Blob instance from the provided bytes. Will make a copy of the bytes passed in.
+   * Creates a new {@code Blob} instance from the provided bytes. Will make a copy of the bytes
+   * passed in.
    *
-   * @param bytes The bytes to use for this Blob instance.
-   * @return The new Blob instance
+   * @param bytes The bytes to use for this {@code Blob} instance.
+   * @return The new {@code Blob} instance
    */
   @NonNull
   @PublicApi

firebase-firestore/src/main/java/com/google/firebase/firestore/CollectionReference.java

@@ -26,12 +26,12 @@
 import javax.annotation.Nullable;
 
 /**
- * A CollectionReference can be used for adding documents, getting document references, and querying
- * for documents (using the methods inherited from Query).
+ * A {@code CollectionReference} can be used for adding documents, getting document references, and
+ * querying for documents (using the methods inherited from {@code Query}).
  *
- * <p><b>Subclassing Note</b>: Firestore classes are not meant to be subclassed except for use in
- * test mocks. Subclassing is not supported in production code and new SDK releases may break code
- * that does so.
+ * <p><b>Subclassing Note</b>: Cloud Firestore classes are not meant to be subclassed except for use
+ * in test mocks. Subclassing is not supported in production code and new SDK releases may break
+ * code that does so.
  */
 @PublicApi
 public class CollectionReference extends Query {
@@ -56,11 +56,11 @@ public String getId() {
   }
 
   /**
-   * Gets a DocumentReference to the document that contains this collection. Only subcollections are
-   * contained in a document. For root collections, returns null.
+   * Gets a {@code DocumentReference} to the document that contains this collection. Only
+   * subcollections are contained in a document. For root collections, returns {@code null}.
    *
-   * @return The DocumentReference that contains this collection or null if this is a root
-   *     collection.
+   * @return The {@code DocumentReference} that contains this collection or {@code null} if this is
+   *     a root collection.
    */
   @Nullable
   @PublicApi
@@ -86,10 +86,10 @@ public String getPath() {
   }
 
   /**
-   * Returns a DocumentReference pointing to a new document with an auto-generated ID within this
-   * collection.
+   * Returns a {@code DocumentReference} pointing to a new document with an auto-generated ID within
+   * this collection.
    *
-   * @return A DocumentReference pointing to a new document with an auto-generated ID.
+   * @return A {@code DocumentReference} pointing to a new document with an auto-generated ID.
    */
   @NonNull
   @PublicApi
@@ -98,11 +98,11 @@ public DocumentReference document() {
   }
 
   /**
-   * Gets a DocumentReference instance that refers to the document at the specified path within this
-   * collection.
+   * Gets a {@code DocumentReference} instance that refers to the document at the specified path
+   * within this collection.
    *
    * @param documentPath A slash-separated relative path to a document.
-   * @return The DocumentReference instance.
+   * @return The {@code DocumentReference} instance.
    */
   @NonNull
   @PublicApi
@@ -118,7 +118,8 @@ public DocumentReference document(@NonNull String documentPath) {
    *
    * @param data The data to write to the document (e.g. a Map or a POJO containing the desired
    *     document contents).
-   * @return A Task that will be resolved with the DocumentReference of the newly created document.
+   * @return A Task that will be resolved with the {@code DocumentReference} of the newly created
+   *     document.
    */
   @NonNull
   @PublicApi

firebase-firestore/src/main/java/com/google/firebase/firestore/DocumentChange.java

@@ -28,12 +28,12 @@
 import javax.annotation.Nullable;
 
 /**
- * A DocumentChange represents a change to the documents matching a query. It contains the document
- * affected and a the type of change that occurred (added, modified, or removed).
+ * A {@code DocumentChange} represents a change to the documents matching a query. It contains the
+ * document affected and a the type of change that occurred (added, modified, or removed).
  *
- * <p><b>Subclassing Note</b>: Firestore classes are not meant to be subclassed except for use in
- * test mocks. Subclassing is not supported in production code and new SDK releases may break code
- * that does so.
+ * <p><b>Subclassing Note</b>: Cloud Firestore classes are not meant to be subclassed except for use
+ * in test mocks. Subclassing is not supported in production code and new SDK releases may break
+ * code that does so.
  */
 @PublicApi
 public class DocumentChange {
@@ -97,11 +97,12 @@ public Type getType() {
   }
 
   /**
-   * Returns the newly added or modified document if this DocumentChange is for an updated document.
-   * Returns the deleted document if this document change represents a removal.
+   * Returns the newly added or modified document if this {@code DocumentChange} is for an updated
+   * document. Returns the deleted document if this document change represents a removal.
    *
-   * @return A snapshot of the new data (for Type.ADDED or Type.MODIFIED) or the removed data (for
-   *     Type.REMOVED).
+   * @return A snapshot of the new data (for {@link DocumentChange.Type#ADDED} or {@link
+   *     DocumentChange.Type#MODIFIED}) or the removed data (for {@link
+   *     DocumentChange.Type.REMOVED}).
    */
   @NonNull
   @PublicApi
@@ -110,26 +111,26 @@ public QueryDocumentSnapshot getDocument() {
   }
 
   /**
-   * 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). Returns -1 for
-   * 'added' events.
+   * The index of the changed document in the result set immediately prior to this {@code
+   * DocumentChange} (assuming that all prior {@code DocumentChange} objects have been applied).
+   * Returns -1 for 'added' events.
    */
   @PublicApi
   public int getOldIndex() {
     return oldIndex;
   }
 
   /**
-   * 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). Returns -1 for 'removed' events.
+   * The index of the changed document in the result set immediately after this {@code
+   * DocumentChange} (assuming that all prior {@code DocumentChange} objects and the current {@code
+   * DocumentChange} object have been applied). Returns -1 for 'removed' events.
    */
   @PublicApi
   public int getNewIndex() {
     return newIndex;
   }
 
-  /** Creates the list of DocumentChanges from a ViewSnapshot. */
+  /** Creates the list of document changes from a {@code ViewSnapshot}. */
   static List<DocumentChange> changesFromSnapshot(
       FirebaseFirestore firestore, MetadataChanges metadataChanges, ViewSnapshot snapshot) {
     List<DocumentChange> documentChanges = new ArrayList<>();

firebase-firestore/src/main/java/com/google/firebase/firestore/DocumentId.java

@@ -32,16 +32,16 @@
  *   <li>This annotation is applied to a property that is not writable (for example, a Java Bean
  *       getter without a backing field).
  *   <li>This annotation is applied to a property with a name that conflicts with a read document
- *       field. For example, if a POJO has a field `firstName` annotated by @DocumentId, and there
- *       is a property from the document named `firstName` as well, an exception is thrown when you
- *       try to read the document into the POJO via {@link DocumentSnapshot#toObject} or {@link
- *       DocumentReference#get}.
+ *       field. For example, if a POJO has a field `firstName` annotated by {@code @DocumentId}, and
+ *       there is a property from the document named `firstName` as well, an exception is thrown
+ *       when you try to read the document into the POJO via {@link DocumentSnapshot#toObject} or
+ *       {@link DocumentReference#get}.
  *   <li>
  * </ul>
  *
  * <p>When using a POJO to write to a document (via {@link DocumentReference#set} or @{@link
- * WriteBatch#set}), the property annotated by @DocumentId is ignored, which allows writing the POJO
- * back to any document, even if it's not the origin of the POJO.
+ * WriteBatch#set}), the property annotated by {@code @DocumentId} is ignored, which allows writing
+ * the POJO back to any document, even if it's not the origin of the POJO.
  */
 @PublicApi
 @Retention(RetentionPolicy.RUNTIME)