docs: Add descriptions to many parameters (googleapis#1341)

* 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

* 🦉 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>
Co-authored-by: Kevin Kim <[email protected]>

Author: 3 people

src/aggregate.ts

@@ -33,7 +33,7 @@ class AggregateQuery {
   /**
    * Build an AggregateQuery object.
    *
-   * @param {Query} query
+   * @param {Query} query A Query object
    */
   constructor(query: Query) {
     this.query = query;
@@ -43,7 +43,8 @@ class AggregateQuery {
   /**
    * Add a `count` aggregate query to the list of aggregations.
    *
-   * @param {string} alias
+   * @param {string} alias The label used in the results to describe this
+   * aggregate field when a query is run.
    * @returns {AggregateQuery}
    */
   count(alias?: string): AggregateQuery {
@@ -54,8 +55,9 @@ class AggregateQuery {
   /**
    * Add a `sum` aggregate query to the list of aggregations.
    *
-   * @param {string} property
-   * @param {string} alias
+   * @param {string} property The property to use for the sum calculation.
+   * @param {string} alias The label used in the results to describe this
+   * aggregate field when a query is run.
    * @returns {AggregateQuery}
    */
   sum(property: string, alias?: string): AggregateQuery {
@@ -66,8 +68,9 @@ class AggregateQuery {
   /**
    * Add a `average` aggregate query to the list of aggregations.
    *
-   * @param {string} property
-   * @param {string} alias
+   * @param {string} property The property to use for the average calculation.
+   * @param {string} alias The label used in the results to describe this
+   * aggregate field when a query is run.
    * @returns {AggregateQuery}
    */
   average(property: string, alias?: string): AggregateQuery {
@@ -78,7 +81,8 @@ class AggregateQuery {
   /**
    * Add a custom aggregation to the list of aggregations.
    *
-   * @param {AggregateField} aggregation
+   * @param {AggregateField} aggregation The aggregate field to perform the
+   * aggregation query over.
    * @returns {AggregateQuery}
    */
   addAggregation(aggregation: AggregateField): AggregateQuery {
@@ -89,7 +93,8 @@ class AggregateQuery {
   /**
    * Add a list of custom aggregations to the list of aggregations.
    *
-   * @param {AggregateField[]} aggregation
+   * @param {AggregateField[]} aggregations The aggregate fields to perform the
+   * aggregation query over.
    * @returns {AggregateQuery}
    */
   addAggregations(aggregations: AggregateField[]): AggregateQuery {
@@ -147,6 +152,7 @@ abstract class AggregateField {
   /**
    * Gets a copy of the Sum aggregate field.
    *
+   * @param {string} property The property to use for the average calculation.
    * @returns {Sum}
    */
   static sum(property: string): Sum {
@@ -156,6 +162,7 @@ abstract class AggregateField {
   /**
    * Gets a copy of the Average aggregate field.
    *
+   * @param {string} property The property to use for the average calculation.
    * @returns {Average}
    */
   static average(property: string): Average {
@@ -209,7 +216,7 @@ abstract class PropertyAggregateField extends AggregateField {
   /**
    * Build a PropertyAggregateField object.
    *
-   * @param {string} property
+   * @param {string} property The property to aggregate over.
    */
   constructor(public property_: string) {
     super();

src/entity.ts

@@ -83,7 +83,7 @@ export namespace entity {
    * Check if something is a Datastore Double object.
    *
    * @private
-   * @param {*} value
+   * @param {*} value The value to check if it is a datastore double.
    * @returns {boolean}
    */
   export function isDsDouble(value?: {}): value is entity.Double {
@@ -94,7 +94,7 @@ export namespace entity {
    * Check if a value is a Datastore Double object converted from JSON.
    *
    * @private
-   * @param {*} value
+   * @param {*} value The value to check if it is datastore double like.
    * @returns {boolean}
    */
   export function isDsDoubleLike(value: unknown) {
@@ -204,7 +204,7 @@ export namespace entity {
    * Check if something is a Datastore Int object.
    *
    * @private
-   * @param {*} value
+   * @param {*} value The value to check if it is a Datastore Int
    * @returns {boolean}
    */
   export function isDsInt(value?: {}): value is entity.Int {
@@ -215,7 +215,7 @@ export namespace entity {
    * Check if a value is a Datastore Int object converted from JSON.
    *
    * @private
-   * @param {*} value
+   * @param {*} value The value to check if it is Datastore IntLike
    * @returns {boolean}
    */
   export function isDsIntLike(value: unknown) {
@@ -273,7 +273,7 @@ export namespace entity {
    * Check if something is a Datastore Geo Point object.
    *
    * @private
-   * @param {*} value
+   * @param {*} value The value to check if it is a Geo point.
    * @returns {boolean}
    */
   export function isDsGeoPoint(value?: {}): value is entity.GeoPoint {

src/index.ts

@@ -134,7 +134,7 @@ const urlSafeKey = new entity.URLSafeKey();
  *
  * <h4>The Datastore Emulator</h4>
  *
- * Make sure you have the <a href="https://cloud.google.com/sdk/downloads">
+ * Make sure you have the <a href="https://cloud.google.com/sdk/docs/install">
  * gcloud SDK installed</a>, then run:
  *
  * <pre>
@@ -1509,7 +1509,7 @@ class Datastore extends DatastoreRequest {
    * @see {@link Query}
    *
    * @param {string} [namespace] Namespace.
-   * @param {string} kind  The kind to query.
+   * @param {string} kind The kind to query.
    * @returns {Query}
    *
    * @example

src/query.ts

@@ -334,7 +334,7 @@ class Query {
    *
    * Queries that select a subset of properties are called Projection Queries.
    *
-   * @see {@link https://cloud.google.com/datastore/docs/concepts/projectionqueries| Projection Queries}
+   * @see {@link https://cloud.google.com/datastore/docs/samples/datastore-projection-query| Projection Queries}
    *
    * @param {string|string[]} fieldNames Properties to return from the matched
    *     entities.

src/request.ts

@@ -820,7 +820,7 @@ class DatastoreRequest {
    * that uses the end cursor from the previous query as the starting cursor for
    * the next query. You can pass that object back to this method to see if more
    * results exist.
-   * @param {Query} query Query object.
+   * @param {Query} query A Query object
    * @param {object} [options] Optional configuration.
    * @param {string} [options.consistency] Specify either `strong` or `eventual`.
    *     If not specified, default values are chosen by Datastore for the
@@ -949,7 +949,7 @@ class DatastoreRequest {
    *
    * See {@link Datastore#runQuery} for a list of all available options.
    *
-   * @param {Query} query Query object.
+   * @param {Query} query A Query object
    * @param {object} [options] Optional configuration.
    * @param {object} [options.gaxOptions] Request configuration options, outlined
    *     here: https://googleapis.github.io/gax-nodejs/global.html#CallOptions.

src/transaction.ts

@@ -755,7 +755,7 @@ class Transaction extends DatastoreRequest {
    * has not been started yet then the transaction is started before the
    * runQuery call is made.
    *
-   * @param {Query} query Query object.
+   * @param {Query} query A Query object
    * @param {object} [options] Optional configuration.
    * @param {function} [callback] The callback function. If omitted, a readable
    *     stream instance is returned.