From b5e050b0347e7eb27063c0910a5eb95f53780daf Mon Sep 17 00:00:00 2001 From: Noah Dietz Date: Thu, 18 Dec 2025 23:37:50 +0000 Subject: [PATCH 1/4] fix(generator): include API version in client docs --- .../golden/v1/golden_kitchen_sink_client.h | 2 ++ generator/internal/format_class_comments.cc | 7 +++++++ 2 files changed, 9 insertions(+) diff --git a/generator/integration_tests/golden/v1/golden_kitchen_sink_client.h b/generator/integration_tests/golden/v1/golden_kitchen_sink_client.h index a62131b8c8d5f..8976243806b6d 100644 --- a/generator/integration_tests/golden/v1/golden_kitchen_sink_client.h +++ b/generator/integration_tests/golden/v1/golden_kitchen_sink_client.h @@ -38,6 +38,8 @@ GOOGLE_CLOUD_CPP_INLINE_NAMESPACE_BEGIN /// /// GoldenKitchenSinkClient /// +/// This client uses GoldenKitchenSink version test-api-version. +/// /// @par Equality /// /// Instances of this class created via copy-construction or copy-assignment diff --git a/generator/internal/format_class_comments.cc b/generator/internal/format_class_comments.cc index c2908d388cee1..c40a39eae1d3d 100644 --- a/generator/internal/format_class_comments.cc +++ b/generator/internal/format_class_comments.cc @@ -18,6 +18,7 @@ #include "google/cloud/internal/absl_str_replace_quiet.h" #include "google/cloud/log.h" #include "absl/strings/strip.h" +#include namespace google { namespace cloud { @@ -78,6 +79,12 @@ std::string FormatClassCommentsFromServiceComments( {service.name(), service_name}}); } + auto api_version = service.options().GetExtension(google::api::api_version); + if (!api_version.empty()) { + absl::StrAppend(&formatted_comments, + "\n/// This client uses ", service_name, " version ", api_version, ".\n"); + } + auto const references = ResolveCommentReferences(formatted_comments, *service.file()->pool()); auto trailer = std::string{}; From 7a6119159c9acad13c8d1d7d2a720f64185370b2 Mon Sep 17 00:00:00 2001 From: Noah Dietz Date: Thu, 18 Dec 2025 23:46:57 +0000 Subject: [PATCH 2/4] fix formatting --- generator/internal/format_class_comments.cc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/generator/internal/format_class_comments.cc b/generator/internal/format_class_comments.cc index c40a39eae1d3d..44e9e288a6cae 100644 --- a/generator/internal/format_class_comments.cc +++ b/generator/internal/format_class_comments.cc @@ -81,8 +81,8 @@ std::string FormatClassCommentsFromServiceComments( auto api_version = service.options().GetExtension(google::api::api_version); if (!api_version.empty()) { - absl::StrAppend(&formatted_comments, - "\n/// This client uses ", service_name, " version ", api_version, ".\n"); + absl::StrAppend(&formatted_comments, "\n/// This client uses ", + service_name, " version ", api_version, ".\n"); } auto const references = From 922cc3ecf677640b6c106aa1726d8bcf83341994 Mon Sep 17 00:00:00 2001 From: Noah Dietz Date: Thu, 18 Dec 2025 15:51:16 -0800 Subject: [PATCH 3/4] lead with empty comment Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> --- generator/internal/format_class_comments.cc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/generator/internal/format_class_comments.cc b/generator/internal/format_class_comments.cc index 44e9e288a6cae..005527f3343b7 100644 --- a/generator/internal/format_class_comments.cc +++ b/generator/internal/format_class_comments.cc @@ -81,8 +81,8 @@ std::string FormatClassCommentsFromServiceComments( auto api_version = service.options().GetExtension(google::api::api_version); if (!api_version.empty()) { - absl::StrAppend(&formatted_comments, "\n/// This client uses ", - service_name, " version ", api_version, ".\n"); + absl::StrAppend(&formatted_comments, "\n///\n/// This client uses ", + service_name, " version ", api_version, ".\n///"); } auto const references = From b0f01535d581d8c517ea69d541cd65c9cb50f990 Mon Sep 17 00:00:00 2001 From: Noah Dietz Date: Thu, 18 Dec 2025 16:09:42 -0800 Subject: [PATCH 4/4] remove trailing blank line Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> --- generator/internal/format_class_comments.cc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/generator/internal/format_class_comments.cc b/generator/internal/format_class_comments.cc index 005527f3343b7..5ad6e1659e535 100644 --- a/generator/internal/format_class_comments.cc +++ b/generator/internal/format_class_comments.cc @@ -82,7 +82,7 @@ std::string FormatClassCommentsFromServiceComments( auto api_version = service.options().GetExtension(google::api::api_version); if (!api_version.empty()) { absl::StrAppend(&formatted_comments, "\n///\n/// This client uses ", - service_name, " version ", api_version, ".\n///"); + service_name, " version ", api_version, "."); } auto const references =