fix: Use service name in ServiceClient codegen comments (#417)

Author: miraleung

src/main/java/com/google/api/generator/gapic/composer/ServiceClientClassComposer.java

@@ -223,7 +223,8 @@ private static List<MethodDefinition> createStaticCreatorMethods(
 
     MethodDefinition createMethodOne =
         MethodDefinition.builder()
-            .setHeaderCommentStatements(ServiceClientCommentComposer.CREATE_METHOD_NO_ARG_COMMENT)
+            .setHeaderCommentStatements(
+                ServiceClientCommentComposer.createMethodNoArgComment(service.name()))
             .setScope(ScopeNode.PUBLIC)
             .setIsStatic(true)
             .setIsFinal(true)
@@ -242,7 +243,7 @@ private static List<MethodDefinition> createStaticCreatorMethods(
     methods.add(
         MethodDefinition.builder()
             .setHeaderCommentStatements(
-                ServiceClientCommentComposer.CREATE_METHOD_SETTINGS_ARG_COMMENT)
+                ServiceClientCommentComposer.createMethodSettingsArgComment(service.name()))
             .setScope(ScopeNode.PUBLIC)
             .setIsStatic(true)
             .setIsFinal(true)
@@ -274,7 +275,7 @@ private static List<MethodDefinition> createStaticCreatorMethods(
         MethodDefinition.builder()
             .setHeaderCommentStatements(
                 ServiceClientCommentComposer.createCreateMethodStubArgComment(
-                    settingsVarExpr.type()))
+                    service.name(), settingsVarExpr.type()))
             .setAnnotations(Arrays.asList(betaAnnotation))
             .setScope(ScopeNode.PUBLIC)
             .setIsStatic(true)
@@ -365,7 +366,7 @@ private static List<MethodDefinition> createConstructorMethods(
     methods.add(
         MethodDefinition.constructorBuilder()
             .setHeaderCommentStatements(
-                ServiceClientCommentComposer.PROTECTED_CONSTRUCTOR_SETTINGS_ARG_COMMENT)
+                ServiceClientCommentComposer.createProtectedCtorSettingsArgComment(service.name()))
             .setScope(ScopeNode.PROTECTED)
             .setReturnType(thisClassType)
             .setArguments(settingsVarExpr.toBuilder().setIsDecl(true).build())

src/main/java/com/google/api/generator/gapic/composer/ServiceClientCommentComposer.java

@@ -71,7 +71,7 @@ class ServiceClientCommentComposer {
 
   // Patterns.
   private static final String CREATE_METHOD_STUB_ARG_PATTERN =
-      "Constructs an instance of EchoClient, using the given stub for making calls. This is for"
+      "Constructs an instance of %sClient, using the given stub for making calls. This is for"
           + " advanced usage - prefer using create(%s).";
 
   private static final String SERVICE_DESCRIPTION_CUSTOMIZE_SUMMARY_PATTERN =
@@ -80,22 +80,20 @@ class ServiceClientCommentComposer {
 
   private static final String SERVICE_DESCRIPTION_SUMMARY_PATTERN = "Service Description: %s";
 
-  // Comments.
-  static final CommentStatement CREATE_METHOD_NO_ARG_COMMENT =
-      toSimpleComment("Constructs an instance of EchoClient with default settings.");
+  private static final String CREATE_METHOD_NO_ARG_PATTERN =
+      "Constructs an instance of %sClient with default settings.";
 
-  static final CommentStatement CREATE_METHOD_SETTINGS_ARG_COMMENT =
-      toSimpleComment(
-          "Constructs an instance of EchoClient, using the given settings. The channels are"
-              + " created based  on the settings passed in, or defaults for any settings that are"
-              + " not set.");
+  private static final String CREATE_METHOD_SETTINGS_ARG_PATTERN =
+      "Constructs an instance of %sClient, using the given settings. The channels are"
+          + " created based  on the settings passed in, or defaults for any settings that are"
+          + " not set.";
 
-  static final CommentStatement PROTECTED_CONSTRUCTOR_SETTINGS_ARG_COMMENT =
-      toSimpleComment(
-          "Constructs an instance of EchoClient, using the given settings. This is protected so"
-              + " that it is easy to make a subclass, but otherwise, the static factory methods"
-              + " should be preferred.");
+  private static final String PROTECTED_CONSTRUCTOR_SETTINGS_ARG_PATTERN =
+      "Constructs an instance of %sClient, using the given settings. This is protected so"
+          + " that it is easy to make a subclass, but otherwise, the static factory methods"
+          + " should be preferred.";
 
+  // Comments.
   static final CommentStatement GET_OPERATIONS_CLIENT_METHOD_COMMENT =
       toSimpleComment(
           "Returns the OperationsClient that can be used to query the status of a long-running"
@@ -136,9 +134,11 @@ static List<CommentStatement> createClassHeaderComments(Service service) {
         CommentStatement.withComment(classHeaderJavadocBuilder.build()));
   }
 
-  static CommentStatement createCreateMethodStubArgComment(TypeNode settingsType) {
+  static CommentStatement createCreateMethodStubArgComment(
+      String serviceName, TypeNode settingsType) {
     return toSimpleComment(
-        String.format(CREATE_METHOD_STUB_ARG_PATTERN, settingsType.reference().name()));
+        String.format(
+            CREATE_METHOD_STUB_ARG_PATTERN, serviceName, settingsType.reference().name()));
   }
 
   static List<CommentStatement> createRpcMethodHeaderComment(
@@ -174,6 +174,18 @@ static List<CommentStatement> createRpcMethodHeaderComment(Method method) {
     return createRpcMethodHeaderComment(method, Collections.emptyList());
   }
 
+  static CommentStatement createMethodNoArgComment(String serviceName) {
+    return toSimpleComment(String.format(CREATE_METHOD_NO_ARG_PATTERN, serviceName));
+  }
+
+  static CommentStatement createProtectedCtorSettingsArgComment(String serviceName) {
+    return toSimpleComment(String.format(PROTECTED_CONSTRUCTOR_SETTINGS_ARG_PATTERN, serviceName));
+  }
+
+  static CommentStatement createMethodSettingsArgComment(String serviceName) {
+    return toSimpleComment(String.format(CREATE_METHOD_SETTINGS_ARG_PATTERN, serviceName));
+  }
+
   static List<CommentStatement> createRpcCallableMethodHeaderComment(Method method) {
     JavaDocComment.Builder methodJavadocBuilder = JavaDocComment.builder();
 

src/test/java/com/google/api/generator/gapic/composer/goldens/IdentityClient.golden

@@ -61,21 +61,21 @@ public class IdentityClient implements BackgroundResource {
   private final IdentitySettings settings;
   private final IdentityStub stub;
 
-  /** Constructs an instance of EchoClient with default settings. */
+  /** Constructs an instance of IdentityClient with default settings. */
   public static final IdentityClient create() throws IOException {
     return create(IdentitySettings.newBuilder().build());
   }
 
   /**
-   * Constructs an instance of EchoClient, using the given settings. The channels are created based
-   * on the settings passed in, or defaults for any settings that are not set.
+   * Constructs an instance of IdentityClient, using the given settings. The channels are created
+   * based on the settings passed in, or defaults for any settings that are not set.
    */
   public static final IdentityClient create(IdentitySettings settings) throws IOException {
     return new IdentityClient(settings);
   }
 
   /**
-   * Constructs an instance of EchoClient, using the given stub for making calls. This is for
+   * Constructs an instance of IdentityClient, using the given stub for making calls. This is for
    * advanced usage - prefer using create(IdentitySettings).
    */
   @BetaApi("A restructuring of stub classes is planned, so this may break in the future")
@@ -84,8 +84,8 @@ public class IdentityClient implements BackgroundResource {
   }
 
   /**
-   * Constructs an instance of EchoClient, using the given settings. This is protected so that it is
-   * easy to make a subclass, but otherwise, the static factory methods should be preferred.
+   * Constructs an instance of IdentityClient, using the given settings. This is protected so that
+   * it is easy to make a subclass, but otherwise, the static factory methods should be preferred.
    */
   protected IdentityClient(IdentitySettings settings) throws IOException {
     this.settings = settings;