fix: separate jsdoc with api version (#127)

googleapis · Nov 12, 2019 · 263d168 · 263d168
1 parent 2e5004a
commit 263d168
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 0 deletions.
diff --git a/templates/typescript_gapic/src/$version/$service_client.ts.njk b/templates/typescript_gapic/src/$version/$service_client.ts.njk
@@ -51,6 +51,8 @@ export interface PaginationResponse<
 
 /**
 {{- util.printCommentsForService(service) }}
+ * @class
+ * @memberof {{ api.naming.version }}
  */
 export class {{ service.name }}Client {
   private _descriptors: Descriptors = {page: {}, stream: {}, longrunning: {}};

diff --git a/typescript/test/testdata/keymanager/src/v1/key_management_service_client.ts.baseline b/typescript/test/testdata/keymanager/src/v1/key_management_service_client.ts.baseline
@@ -53,6 +53,8 @@ export interface PaginationResponse<
  * 
  *  If you are using manual gRPC libraries, see
  *  [Using gRPC with Cloud KMS](https://cloud.google.com/kms/docs/grpc).
+ * @class
+ * @memberof v1
  */
 export class KeyManagementServiceClient {
   private _descriptors: Descriptors = {page: {}, stream: {}, longrunning: {}};

diff --git a/typescript/test/testdata/showcase/src/v1beta1/echo_client.ts.baseline b/typescript/test/testdata/showcase/src/v1beta1/echo_client.ts.baseline
@@ -46,6 +46,8 @@ export interface PaginationResponse<
  *  side streaming, client side streaming, and bidirectional streaming. This
  *  service also exposes methods that explicitly implement server delay, and
  *  paginated calls.
+ * @class
+ * @memberof v1beta1
  */
 export class EchoClient {
   private _descriptors: Descriptors = {page: {}, stream: {}, longrunning: {}};

diff --git a/typescript/test/testdata/texttospeech/src/v1/text_to_speech_client.ts.baseline b/typescript/test/testdata/texttospeech/src/v1/text_to_speech_client.ts.baseline
@@ -29,6 +29,8 @@ const version = require('../../../package.json').version;
 
 /**
  *  Service that implements Google Cloud Text-to-Speech API.
+ * @class
+ * @memberof v1
  */
 export class TextToSpeechClient {
   private _descriptors: Descriptors = {page: {}, stream: {}, longrunning: {}};

diff --git a/typescript/test/testdata/translate/src/v3beta1/translation_service_client.ts.baseline b/typescript/test/testdata/translate/src/v3beta1/translation_service_client.ts.baseline
@@ -43,6 +43,8 @@ export interface PaginationResponse<
 
 /**
  *  Provides natural language translation operations.
+ * @class
+ * @memberof v3beta1
  */
 export class TranslationServiceClient {
   private _descriptors: Descriptors = {page: {}, stream: {}, longrunning: {}};