docs: updated jsdoc comments for generated methods

googleapis · Dec 13, 2019 · ae8f701 · ae8f701
1 parent b74914e
commit ae8f701
Show file tree

Hide file tree

Showing 3 changed files with 2,710 additions and 13 deletions.
diff --git a/packages/google-cloud-translate/src/v3/translation_service_client.ts b/packages/google-cloud-translate/src/v3/translation_service_client.ts
@@ -1131,13 +1131,18 @@ export class TranslationServiceClient {
    * @param {object} [options]
    *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
    * @returns {Promise} - The promise which resolves to an array.
-   *   The first element of the array is an object representing [ListGlossariesResponse]{@link google.cloud.translation.v3.ListGlossariesResponse}.
+   *   The first element of the array is Array of [Glossary]{@link google.cloud.translation.v3.Glossary}.
+   *   The client library support auto-pagination by default: it will call the API as many
+   *   times as needed and will merge results from all the pages into this array.
    *
    *   When autoPaginate: false is specified through options, the array has three elements.
-   *   The first element is Array of [ListGlossariesResponse]{@link google.cloud.translation.v3.ListGlossariesResponse} in a single response.
-   *   The second element is the next request object if the response
-   *   indicates the next page exists, or null. The third element is
-   *   an object representing [ListGlossariesResponse]{@link google.cloud.translation.v3.ListGlossariesResponse}.
+   *   The first element is Array of [Glossary]{@link google.cloud.translation.v3.Glossary} that corresponds to
+   *   the one page received from the API server.
+   *   If the second element is not null it contains the request object of type [ListGlossariesRequest]{@link google.cloud.translation.v3.ListGlossariesRequest}
+   *   that can be used to obtain the next page of the results.
+   *   If it is null, the next page does not exist.
+   *   The third element contains the raw response received from the API server. Its type is
+   *   [ListGlossariesResponse]{@link google.cloud.translation.v3.ListGlossariesResponse}.
    *
    *   The promise has a method named "cancel" which cancels the ongoing API call.
    */

diff --git a/packages/google-cloud-translate/src/v3beta1/translation_service_client.ts b/packages/google-cloud-translate/src/v3beta1/translation_service_client.ts
@@ -1147,13 +1147,18 @@ export class TranslationServiceClient {
    * @param {object} [options]
    *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
    * @returns {Promise} - The promise which resolves to an array.
-   *   The first element of the array is an object representing [ListGlossariesResponse]{@link google.cloud.translation.v3beta1.ListGlossariesResponse}.
+   *   The first element of the array is Array of [Glossary]{@link google.cloud.translation.v3beta1.Glossary}.
+   *   The client library support auto-pagination by default: it will call the API as many
+   *   times as needed and will merge results from all the pages into this array.
    *
    *   When autoPaginate: false is specified through options, the array has three elements.
-   *   The first element is Array of [ListGlossariesResponse]{@link google.cloud.translation.v3beta1.ListGlossariesResponse} in a single response.
-   *   The second element is the next request object if the response
-   *   indicates the next page exists, or null. The third element is
-   *   an object representing [ListGlossariesResponse]{@link google.cloud.translation.v3beta1.ListGlossariesResponse}.
+   *   The first element is Array of [Glossary]{@link google.cloud.translation.v3beta1.Glossary} that corresponds to
+   *   the one page received from the API server.
+   *   If the second element is not null it contains the request object of type [ListGlossariesRequest]{@link google.cloud.translation.v3beta1.ListGlossariesRequest}
+   *   that can be used to obtain the next page of the results.
+   *   If it is null, the next page does not exist.
+   *   The third element contains the raw response received from the API server. Its type is
+   *   [ListGlossariesResponse]{@link google.cloud.translation.v3beta1.ListGlossariesResponse}.
    *
    *   The promise has a method named "cancel" which cancels the ongoing API call.
    */