AggregateQuerySnapshot.java: re-write the javadocs

Author: dconeybe

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

@@ -95,6 +95,10 @@ public boolean equals(Object object) {
     return query.equals(other.query);
   }
 
+  /**
+   * Calculates and returns the hash code for this object.
+   * @return the hash code for this object.
+   */
   @Override
   public int hashCode() {
     return query.hashCode();

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

@@ -20,7 +20,7 @@
 import java.util.Objects;
 
 /**
- * A {@code AggregateQuerySnapshot} contains results of a {@link AggregateQuery}.
+ * The results of executing an {@link AggregateQuery}.
  *
  * <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
@@ -37,25 +37,45 @@ public class AggregateQuerySnapshot {
     this.count = count;
   }
 
-  /** @return The original {@link AggregateQuery} this snapshot is a result of. */
+  /** Returns the query that was executed to produce this result. */
   @NonNull
   public AggregateQuery getQuery() {
     return query;
   }
 
-  /** @return The result of a document count aggregation. */
+  /** Returns the number of documents in the result set of the query. */
   public long getCount() {
     return count;
   }
 
+  /**
+   * Compares this object with the given object for equality.
+   *
+   * <p>This object is considered "equal" to the other object if and only if all of the following
+   * conditions are satisfied:
+   *
+   * <ol>
+   *   <li>{@code object} is a non-null instance of {@link AggregateQuerySnapshot}.</li>
+   *   <li>{@code object} has the same {@link AggregateQuery} as this object.</li>
+   *   <li>{@code object} has the same results as this object.</li>
+   * </ol>
+   *
+   * @param object The object to compare to this object for equality.
+   * @return {@code true} if this object is "equal" to the given object, as defined above, or
+   * {@code false} otherwise.
+   */
   @Override
-  public boolean equals(Object o) {
-    if (this == o) return true;
-    if (!(o instanceof AggregateQuerySnapshot)) return false;
-    AggregateQuerySnapshot snapshot = (AggregateQuerySnapshot) o;
-    return count == snapshot.count && query.equals(snapshot.query);
+  public boolean equals(Object object) {
+    if (this == object) return true;
+    if (!(object instanceof AggregateQuerySnapshot)) return false;
+    AggregateQuerySnapshot other = (AggregateQuerySnapshot) object;
+    return count == other.count && query.equals(other.query);
   }
 
+  /**
+   * Calculates and returns the hash code for this object.
+   * @return the hash code for this object.
+   */
   @Override
   public int hashCode() {
     return Objects.hash(count, query);