docs: Add descriptions to more of the parameters (#1342)

* Add descriptions for some query parameters

* Eliminate the extra space

* Add a description to all the alias parameters

* Add documentation for property parameters

* Add descriptions for the aggregation argument

* Add property params to these objects

* Add descriptions for data types

* Fix the broken links

* Add documentation for the addExcludeFromIndexes

* Buffer description

* Add a description for entity filters

* Add parameters documentation for the `and` and `or

* Add descriptions for the filter object

* Add some parameter documentation for the client

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

---------

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>

Author: danieljbruce

src/entity.ts

@@ -584,6 +584,7 @@ export namespace entity {
    *
    * @private
    * @param {*} value Native value.
+   * @param {string} property The property to use for the average calculation.
    * @returns {object}
    *
    * @example
@@ -797,6 +798,14 @@ export namespace entity {
     return entityProto;
   }
 
+  /**
+   *
+   * @param {string[] | undefined} [entities.excludeFromIndexes] Exclude properties from
+   *     indexing using a simple JSON path notation. See the examples in
+   *     {@link Datastore#save} to see how to target properties at different
+   *     levels of nesting within your entity.
+   * @param {object} entityProto The protocol entity object to convert.
+   */
   export function addExcludeFromIndexes(
     excludeFromIndexes: string[] | undefined,
     entityProto: EntityProto
@@ -1407,7 +1416,7 @@ export namespace entity {
      * Convert buffer to base64 encoding.
      *
      * @private
-     * @param {Buffer} buffer
+     * @param {Buffer} buffer The buffer to convert
      * @returns {string} Base64 encoded string.
      */
     convertToBase64_(buffer: Buffer): string {

src/filter.ts

@@ -33,10 +33,20 @@ enum CompositeOperator {
   OR = 'OR',
 }
 
+/**
+ * Returns an AND composite filter.
+ *
+ * @param {EntityFilter[]} filters The filters that make up the AND filter.
+ */
 export function and(filters: EntityFilter[]): CompositeFilter {
   return new CompositeFilter(filters, CompositeOperator.AND);
 }
 
+/**
+ * Returns an OR composite filter.
+ *
+ * @param {EntityFilter[]} filters The filters that make up the OR filter.
+ */
 export function or(filters: EntityFilter[]): CompositeFilter {
   return new CompositeFilter(filters, CompositeOperator.OR);
 }
@@ -75,9 +85,9 @@ export class PropertyFilter<T extends string>
   /**
    * Build a Property Filter object.
    *
-   * @param {string} Property
-   * @param {Operator} operator
-   * @param {any} val
+   * @param {string} Property The property name that the filter will be applied to.
+   * @param {Operator} operator The comparison operator that the filter applies.
+   * @param {any} val The value that the filter compares the property to.
    */
   constructor(
     public name: T,
@@ -120,7 +130,7 @@ class CompositeFilter extends EntityFilter {
   /**
    * Build a Composite Filter object.
    *
-   * @param {EntityFilter[]} filters
+   * @param {EntityFilter[]} filters The filters that make up the composite filter.
    */
   constructor(filters: EntityFilter[], op: CompositeOperator) {
     super();

src/index.ts

@@ -1306,14 +1306,20 @@ class Datastore extends DatastoreRequest {
     return new entity.Double(value);
   }
 
+  /**
+   * Helper function to get a Datastore Double object.
+   *
+   * @param {number} value The double value.
+   * @returns {object}
+   */
   double(value: number) {
     return Datastore.double(value);
   }
 
   /**
    * Helper function to check if something is a Datastore Double object.
    *
-   * @param {*} value
+   * @param {*} value The double value.
    * @returns {boolean}
    *
    * @example
@@ -1328,14 +1334,21 @@ class Datastore extends DatastoreRequest {
     return entity.isDsDouble(value);
   }
 
+  /**
+   * Helper function to check if something is a Datastore Double object.
+   *
+   * @param {*} value The double value.
+   * @returns {boolean}
+   *
+   */
   isDouble(value?: {}) {
     return Datastore.isDouble(value);
   }
 
   /**
    * Helper function to get a Datastore Geo Point object.
    *
-   * @param {object} coordinates Coordinate value.
+   * @param {object} coordinates The coordinates value.
    * @param {number} coordinates.latitude Latitudinal value.
    * @param {number} coordinates.longitude Longitudinal value.
    * @returns {object}
@@ -1365,14 +1378,23 @@ class Datastore extends DatastoreRequest {
     return new entity.GeoPoint(coordinates);
   }
 
+  /**
+   * Helper function to get a Datastore Geo Point object.
+   *
+   * @param {object} coordinates The coordinates value.
+   * @param {number} coordinates.latitude Latitudinal value.
+   * @param {number} coordinates.longitude Longitudinal value.
+   * @returns {object}
+   *
+   */
   geoPoint(coordinates: entity.Coordinates) {
     return Datastore.geoPoint(coordinates);
   }
 
   /**
    * Helper function to check if something is a Datastore Geo Point object.
    *
-   * @param {*} value
+   * @param {*} value The coordinates value.
    * @returns {boolean}
    *
    * @example
@@ -1392,6 +1414,13 @@ class Datastore extends DatastoreRequest {
     return entity.isDsGeoPoint(value);
   }
 
+  /**
+   * Helper function to check if something is a Datastore Geo Point object.
+   *
+   * @param {*} value The coordinates value.
+   * @returns {boolean}
+   *
+   */
   isGeoPoint(value?: {}) {
     return Datastore.isGeoPoint(value);
   }
@@ -1424,14 +1453,24 @@ class Datastore extends DatastoreRequest {
     return new entity.Int(value);
   }
 
+  /**
+   * Helper function to get a Datastore Integer object.
+   *
+   * This is also useful when using an ID outside the bounds of a JavaScript
+   * Number object.
+   *
+   * @param {number | int} value The integer value.
+   * @returns {object}
+   *
+   */
   int(value: number | string) {
     return Datastore.int(value);
   }
 
   /**
    * Helper function to check if something is a Datastore Integer object.
    *
-   * @param {*} value
+   * @param {*} value The value to check
    * @returns {boolean}
    *
    * @example
@@ -1446,6 +1485,13 @@ class Datastore extends DatastoreRequest {
     return entity.isDsInt(value);
   }
 
+  /**
+   * Helper function to check if something is a Datastore Integer object.
+   *
+   * @param {*} value The value to check
+   * @returns {boolean}
+   *
+   */
   isInt(value?: {}) {
     return Datastore.isInt(value);
   }
@@ -1631,7 +1677,7 @@ class Datastore extends DatastoreRequest {
   /**
    * Helper function to check if something is a Datastore Key object.
    *
-   * @param {*} value
+   * @param {*} value Value to compare property to.
    * @returns {boolean}
    *
    * @example