chore: doc tag cleanup

Author: MarkDuckworth

api-report/firestore.api.md

@@ -101,7 +101,7 @@ export class AggregateField<T> implements firestore.AggregateField<T> {
    * `other` performs the same kind of aggregation on the same field (if any).
    *
    * @param other The object to compare to this object for equality.
-   * @return `true` if this object is "equal" to the given object, as
+   * @returns `true` if this object is "equal" to the given object, as
    * defined above, or `false` otherwise.
    */
   isEqual(other: AggregateField<T>): boolean {

dev/src/aggregate.ts

@@ -248,7 +248,7 @@ export class ExponentialBackoff {
    * Returns a promise that resolves after currentDelayMs, and increases the
    * delay for any subsequent attempts.
    *
-   * @return A Promise that resolves when the current delay elapsed.
+   * @returns A Promise that resolves when the current delay elapsed.
    * @private
    * @internal
    */

dev/src/backoff.ts

@@ -865,7 +865,7 @@ export class BulkWriter {
    * for writes that were added after the method is called. If you want to wait
    * for additional writes, call `flush()` again.
    *
-   * @return {Promise<void>} A promise that resolves when all enqueued writes
+   * @returns {Promise<void>} A promise that resolves when all enqueued writes
    * up to this point have been committed.
    *
    * @example
@@ -906,7 +906,7 @@ export class BulkWriter {
    * Promise will never be rejected. Calling this method will send all requests.
    * The promise resolves immediately if there are no pending writes.
    *
-   * @return {Promise<void>} A promise that resolves when all enqueued writes
+   * @returns {Promise<void>} A promise that resolves when all enqueued writes
    * up to this point have been committed.
    *
    * @example

dev/src/bulk-writer.ts

@@ -76,7 +76,7 @@ export class CollectionGroup<
    * @param {number} desiredPartitionCount The desired maximum number of
    * partition points. The number must be strictly positive. The actual number
    * of partitions returned may be fewer.
-   * @return {AsyncIterable<QueryPartition>} An AsyncIterable of
+   * @returns {AsyncIterable<QueryPartition>} An AsyncIterable of
    * `QueryPartition`s.
    */
   async *getPartitions(
@@ -198,7 +198,7 @@ export class CollectionGroup<
    * ```
    * @param {FirestoreDataConverter | null} converter Converts objects to and
    * from Firestore. Passing in `null` removes the current converter.
-   * @return {CollectionGroup} A `CollectionGroup` that uses the provided
+   * @returns {CollectionGroup} A `CollectionGroup` that uses the provided
    * converter.
    */
   withConverter<

dev/src/collection-group.ts

@@ -43,7 +43,7 @@ import {RESERVED_MAP_KEY, RESERVED_MAP_KEY_VECTOR_VALUE} from './map-type';
  * @param timestampValue The value to convert.
  * @param argumentName The argument name to use in the error message if the
  * conversion fails. If omitted, 'timestampValue' is used.
- * @return The value as expected by Protobuf JS or undefined if no input was
+ * @returns The value as expected by Protobuf JS or undefined if no input was
  * provided.
  */
 export function timestampFromJson(
@@ -94,7 +94,7 @@ export function timestampFromJson(
  * @private
  * @internal
  * @param bytesValue The value to convert.
- * @return The value as expected by Protobuf JS.
+ * @returns The value as expected by Protobuf JS.
  */
 function bytesFromJson(bytesValue: string | Uint8Array): Uint8Array {
   if (typeof bytesValue === 'string') {
@@ -110,7 +110,7 @@ function bytesFromJson(bytesValue: string | Uint8Array): Uint8Array {
  * @private
  * @internal
  * @param proto The `firestore.v1.Value` proto.
- * @return The string value for 'valueType'.
+ * @returns The string value for 'valueType'.
  */
 export function detectValueType(proto: ProtobufJsValue): string {
   let valueType: string | undefined;
@@ -187,7 +187,7 @@ export function detectValueType(proto: ProtobufJsValue): string {
  * @private
  * @internal
  * @param proto The `firestore.v1.Value` proto.
- * @return The string value for 'valueType'.
+ * @returns The string value for 'valueType'.
  */
 export function detectGoogleProtobufValueType(
   proto: google.protobuf.IValue,
@@ -229,7 +229,7 @@ export function detectGoogleProtobufValueType(
  * @private
  * @internal
  * @param fieldValue The `firestore.v1.Value` in Proto3 JSON format.
- * @return The `firestore.v1.Value` in Protobuf JS format.
+ * @returns The `firestore.v1.Value` in Protobuf JS format.
  */
 export function valueFromJson(fieldValue: api.IValue): api.IValue {
   const valueType = detectValueType(fieldValue);
@@ -288,7 +288,7 @@ export function valueFromJson(fieldValue: api.IValue): api.IValue {
  * @private
  * @internal
  * @param document An object with IValues in Proto3 JSON format.
- * @return The object in Protobuf JS format.
+ * @returns The object in Protobuf JS format.
  */
 export function fieldsFromJson(document: ApiMapValue): ApiMapValue {
   const result: ApiMapValue = {};

dev/src/convert.ts

@@ -181,7 +181,7 @@ export class DocumentChange<
    * value.
    *
    * @param {*} other The value to compare against.
-   * @return true if this `DocumentChange` is equal to the provided value.
+   * @returns true if this `DocumentChange` is equal to the provided value.
    */
   isEqual(other: firestore.DocumentChange<AppModelType, DbModelType>): boolean {
     if (this === other) {

dev/src/document-change.ts

@@ -158,7 +158,7 @@ export class DocumentSnapshot<
    * @internal
    * @param ref The reference to the document.
    * @param obj The object to store in the DocumentSnapshot.
-   * @return The created DocumentSnapshot.
+   * @returns The created DocumentSnapshot.
    */
   static fromObject<AppModelType, DbModelType extends firestore.DocumentData>(
     ref: DocumentReference<AppModelType, DbModelType>,
@@ -177,7 +177,7 @@ export class DocumentSnapshot<
    * @internal
    * @param ref The reference to the document.
    * @param data The field/value map to expand.
-   * @return The created DocumentSnapshot.
+   * @returns The created DocumentSnapshot.
    */
   static fromUpdateMap<
     AppModelType,
@@ -552,7 +552,7 @@ export class DocumentSnapshot<
    * equal to the provided value.
    *
    * @param {*} other The value to compare against.
-   * @return {boolean} true if this `DocumentSnapshot` is equal to the provided
+   * @returns {boolean} true if this `DocumentSnapshot` is equal to the provided
    * value.
    */
   isEqual(
@@ -783,7 +783,7 @@ export class DocumentMask {
    *
    * @private
    * @internal
-   * @return {boolean} Whether this document mask is empty.
+   * @returns {boolean} Whether this document mask is empty.
    */
   get isEmpty(): boolean {
     return this._sortedPaths.length === 0;
@@ -835,7 +835,7 @@ export class DocumentMask {
    * @private
    * @internal
    * @param fieldPath The field path to test.
-   * @return Whether this document mask contains 'fieldPath'.
+   * @returns Whether this document mask contains 'fieldPath'.
    */
   contains(fieldPath: FieldPath): boolean {
     for (const sortedPath of this._sortedPaths) {
@@ -858,7 +858,7 @@ export class DocumentMask {
    * @private
    * @internal
    * @param data An object to filter.
-   * @return A shallow copy of the object filtered by this document mask.
+   * @returns A shallow copy of the object filtered by this document mask.
    */
   applyTo(data: firestore.DocumentData): firestore.DocumentData {
     /*!

dev/src/document.ts

@@ -130,7 +130,7 @@ export class FieldValue implements firestore.FieldValue {
    * Returns a sentinel used with set(), create() or update() to include a
    * server-generated timestamp in the written data.
    *
-   * @return {FieldValue} The FieldValue sentinel for use in a call to set(),
+   * @returns {FieldValue} The FieldValue sentinel for use in a call to set(),
    * create() or update().
    *
    * @example
@@ -164,7 +164,7 @@ export class FieldValue implements firestore.FieldValue {
    * not yet exist, the transformation will set the field to the given value.
    *
    * @param {number} n The value to increment by.
-   * @return {FieldValue} The FieldValue sentinel for use in a call to set(),
+   * @returns {FieldValue} The FieldValue sentinel for use in a call to set(),
    * create() or update().
    *
    * @example
@@ -195,7 +195,7 @@ export class FieldValue implements firestore.FieldValue {
    * exactly the specified elements.
    *
    * @param {...*} elements The elements to union into the array.
-   * @return {FieldValue} The FieldValue sentinel for use in a call to set(),
+   * @returns {FieldValue} The FieldValue sentinel for use in a call to set(),
    * create() or update().
    *
    * @example
@@ -224,7 +224,7 @@ export class FieldValue implements firestore.FieldValue {
    * an array it will be overwritten with an empty array.
    *
    * @param {...*} elements The elements to remove from the array.
-   * @return {FieldValue} The FieldValue sentinel for use in a call to set(),
+   * @returns {FieldValue} The FieldValue sentinel for use in a call to set(),
    * create() or update().
    *
    * @example
@@ -249,7 +249,7 @@ export class FieldValue implements firestore.FieldValue {
    * Returns true if this `FieldValue` is equal to the provided value.
    *
    * @param {*} other The value to compare against.
-   * @return {boolean} true if this `FieldValue` is equal to the provided value.
+   * @returns {boolean} true if this `FieldValue` is equal to the provided value.
    *
    * @example
    * ```
@@ -316,7 +316,7 @@ export abstract class FieldTransform extends FieldValue {
    *
    * @param serializer The Firestore serializer.
    * @param fieldPath The field path to apply this transformation to.
-   * @return The 'FieldTransform' proto message.
+   * @returns The 'FieldTransform' proto message.
    */
   abstract toProto(
     serializer: Serializer,

dev/src/field-value.ts

@@ -84,7 +84,7 @@ export class GeoPoint implements Serializable, firestore.GeoPoint {
    * Returns true if this `GeoPoint` is equal to the provided value.
    *
    * @param {*} other The value to compare against.
-   * @return {boolean} true if this `GeoPoint` is equal to the provided value.
+   * @returns {boolean} true if this `GeoPoint` is equal to the provided value.
    */
   isEqual(other: firestore.GeoPoint): boolean {
     return (