docs: Ensure all parameters in the documentation have a type and a description (#1345)

* 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

* Parameter for prepareGaxRequest_

* Add documentation to a few of the helper functions

* Add more documentation for txn and request params

* 🦉 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/request.ts

@@ -692,7 +692,7 @@ class DatastoreRequest {
   /**
    * This function saves results from a successful beginTransaction call.
    *
-   * @param {BeginAsyncResponse} [response] The response from a call to
+   * @param {object} [response] The response from a call to
    * begin a transaction that completed successfully.
    *
    **/
@@ -1078,6 +1078,11 @@ class DatastoreRequest {
     return stream;
   }
 
+  /**
+   * Gets request options from a RunQueryStream options configuration
+   *
+   * @param {RunQueryStreamOptions} [options] The RunQueryStream options configuration
+   */
   private getRequestOptions(
     options: RunQueryStreamOptions
   ): SharedQueryOptions {
@@ -1114,6 +1119,12 @@ class DatastoreRequest {
     return sharedQueryOpts;
   }
 
+  /**
+   * Gets request options from a RunQueryStream options configuration
+   *
+   * @param {Query} [query] A Query object
+   * @param {RunQueryStreamOptions} [options] The RunQueryStream options configuration
+   */
   private getQueryOptions(
     query: Query,
     options: RunQueryStreamOptions = {}
@@ -1200,6 +1211,11 @@ class DatastoreRequest {
   }
 
   /**
+   * Builds a request and sends it to the Gapic Layer.
+   *
+   * @param {object} config Configuration object.
+   * @param {function} callback The callback function.
+   *
    * @private
    */
   prepareGaxRequest_(config: RequestConfig, callback: Function): void {
@@ -1328,10 +1344,23 @@ class DatastoreRequest {
   }
 }
 
+/**
+ * Check to see if a request is a Transaction
+ *
+ * @param {DatastoreRequest} request The Datastore request object
+ *
+ */
 function isTransaction(request: DatastoreRequest): request is Transaction {
   return request instanceof Transaction;
 }
 
+/**
+ * Throw an error if read options are not properly specified.
+ *
+ * @param {DatastoreRequest} request The Datastore request object
+ * @param {SharedQueryOptions} options The Query options
+ *
+ */
 function throwOnTransactionErrors(
   request: DatastoreRequest,
   options: SharedQueryOptions
@@ -1354,8 +1383,8 @@ function throwOnTransactionErrors(
  * This function gets transaction request options used for defining a
  * request to create a new transaction on the server.
  *
- * @param transaction The transaction for which the request will be made.
- * @param options Custom options that will be used to create the request.
+ * @param {Transaction} transaction The transaction for which the request will be made.
+ * @param {RunOptions} options Custom options that will be used to create the request.
  */
 export function getTransactionRequest(
   transaction: Transaction,

src/transaction.ts

@@ -130,8 +130,7 @@ class Transaction extends DatastoreRequest {
    * If the commit request fails, we will automatically rollback the
    * transaction.
    *
-   * @param {object} [gaxOptions] Request configuration options, outlined here:
-   *     https://googleapis.github.io/gax-nodejs/global.html#CallOptions.
+   * @param {CallOptions | https://googleapis.github.io/gax-nodejs/global.html#CallOptions} [gaxOptions] Request configuration options.
    * @param {function} callback The callback function.
    * @param {?error} callback.err An error returned while making this request.
    *   If the commit fails, we automatically try to rollback the transaction
@@ -280,6 +279,7 @@ class Transaction extends DatastoreRequest {
    * Create an aggregation query from the query specified. See {module:datastore/query} for all
    * of the available methods.
    *
+   * @param {Query} query A Query object
    */
   createAggregationQuery(query: Query): AggregateQuery {
     return this.datastore.createAggregationQuery.call(this, query);