Skip to content

fix(generator): include API version in client docs #15841

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
noahdietz wants to merge 4 commits into
base: main
Choose a base branch
from
+9 −0
Open

fix(generator): include API version in client docs #15841

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b5e050b
fix(generator): include API version in client docs
noahdietz Dec 18, 2025
7a61191
fix formatting
noahdietz Dec 18, 2025
922cc3e
lead with empty comment
noahdietz Dec 18, 2025
b0f0153
remove trailing blank line
noahdietz Dec 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions generator/integration_tests/golden/v1/golden_kitchen_sink_client.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
7 changes: 7 additions & 0 deletions generator/internal/format_class_comments.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
#include "google/cloud/internal/absl_str_replace_quiet.h"
#include "google/cloud/log.h"
#include "absl/strings/strip.h"
#include <google/api/client.pb.h>

namespace google {
namespace cloud {
Expand Down Expand Up @@ -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///\n/// This client uses ",
service_name, " version ", api_version, ".");
}

auto const references =
ResolveCommentReferences(formatted_comments, *service.file()->pool());
auto trailer = std::string{};
Expand Down
Loading