update docs

Author: DellaBitta

packages/firestore/src/lite-api/bytes.ts

@@ -101,15 +101,25 @@ export class Bytes {
     bytes: property('string')
   };
 
-  /** Returns a JSON-serializable representation of this `Bytes` instance. */
+  /**
+   * Returns a JSON-serializable representation of this `Bytes` instance.
+   *
+   * @returns a JSON representation of this object.
+   */
   toJSON(): object {
     return {
       type: Bytes._jsonSchemaVersion,
       bytes: this.toBase64()
     };
   }
 
-  /** Builds a `Bytes` instance from a JSON serialized version of `Bytes`. */
+  /**
+   * Builds a `Byes` instance from a JSON object created by {@link Bytes.toJSON}.
+   *
+   * @param json a JSON object represention of a `Bytes` instance
+   * @returns an instance of {@link Bytes} if the JSON object could be parsed. Throws a
+   * {@link FirestoreError} if an error occurs.
+   */
   static fromJSON(json: object): Bytes {
     if (validateJSON(json, Bytes._jsonSchema)) {
       return Bytes.fromBase64String(json.bytes);

packages/firestore/src/lite-api/geo_point.ts

@@ -100,7 +100,11 @@ export class GeoPoint {
     longitude: property('number')
   };
 
-  /** Returns a JSON-serializable representation of this GeoPoint. */
+  /**
+   * Returns a JSON-serializable representation of this `GeoPoint` instance.
+   *
+   * @returns a JSON representation of this object.
+   */
   toJSON(): { latitude: number; longitude: number; type: string } {
     return {
       latitude: this._lat,
@@ -109,7 +113,13 @@ export class GeoPoint {
     };
   }
 
-  /** Builds a `Timestamp` instance from a JSON serialized version of `Bytes`. */
+  /**
+   * Builds a `GeoPoint` instance from a JSON object created by {@link GeoPoint.toJSON}.
+   *
+   * @param json a JSON object represention of a `GeoPoint` instance
+   * @returns an instance of {@link GeoPoint} if the JSON object could be parsed. Throws a
+   * {@link FirestoreError} if an error occurs.
+   */
   static fromJSON(json: object): GeoPoint {
     if (validateJSON(json, GeoPoint._jsonSchema)) {
       return new GeoPoint(json.latitude, json.longitude);

packages/firestore/src/lite-api/reference.ts

@@ -288,15 +288,26 @@ export class DocumentReference<
     referencePath: property('string')
   };
 
-  /** Returns a JSON-serializable representation of this DocumentReference. */
+  /**
+   * Returns a JSON-serializable representation of this `DocumentReference` instance.
+   *
+   * @returns a JSON representation of this object.
+   */
   toJSON(): object {
     return {
       type: DocumentReference._jsonSchemaVersion,
       referencePath: this._key.toString()
     };
   }
 
-  /** Builds a `DocumentReference` instance from a JSON serialized version of `DocumentReference`. */
+  /**
+   * Builds a `DocumentReference` instance from a JSON object created by
+   * {@link DocumentReference.toJSON}.
+   *
+   * @param json a JSON object represention of a `DocumentReference` instance
+   * @returns an instance of {@link DocumentReference} if the JSON object could be parsed. Throws a
+   * {@link FirestoreError} if an error occurs.
+   */
   static fromJSON<
     NewAppModelType = DocumentData,
     NewDbModelType extends DocumentData = DocumentData

packages/firestore/src/lite-api/vector_value.ts

@@ -59,14 +59,25 @@ export class VectorValue {
     vectorValues: property('object')
   };
 
-  /** Returns a JSON-serializable representation of this `VectorValue` instance. */
+  /**
+   * Returns a JSON-serializable representation of this `VectorValue` instance.
+   *
+   * @returns a JSON representation of this object.
+   */
   toJSON(): object {
     return {
       type: VectorValue._jsonSchemaVersion,
       vectorValues: this._values
     };
   }
-  /** Builds a `Bytes` instance from a JSON serialized version of `Bytes`. */
+
+  /**
+   * Builds a `VectorValue` instance from a JSON object created by {@link VectorValue.toJSON}.
+   *
+   * @param json a JSON object represention of a `VectorValue` instance
+   * @returns an instance of {@link VectorValue} if the JSON object could be parsed. Throws a
+   * {@link FirestoreError} if an error occurs.
+   */
   static fromJSON(json: object): VectorValue {
     if (validateJSON(json, VectorValue._jsonSchema)) {
       if (