docs(pubsub): add doxygen comment to deprecate handwritten apis #13585
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
coryan
approved these changes
Feb 12, 2024
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #13585 +/- ##
=======================================
Coverage 93.27% 93.27%
=======================================
Files 2197 2197
Lines 191984 191984
=======================================
+ Hits 179076 179082 +6
+ Misses 12908 12902 -6 ☔ View full report in Codecov by Sentry. |
dbolduc
reviewed
Feb 13, 2024
| @@ -31,6 +31,10 @@ GOOGLE_CLOUD_CPP_INLINE_NAMESPACE_BEGIN | |||
| /** | |||
| * Performs subscription administrative operations in Cloud Pub/Sub. | |||
| * | |||
| * @deprecated Please use \ref | |||
| * google::cloud::pubsub_admin::SubscriptionAdminClient and \ref | |||
| * google::cloud::pubsub_admin::SubscriptionAdminClient instead. | |||
| @@ -63,6 +63,10 @@ using ListSnapshotsRange = | |||
| * A connection to Cloud Pub/Sub for subscription-related administrative | |||
| * operations. | |||
| * | |||
| * @deprecated Please use \ref | |||
| * google::cloud::pubsub_admin::SubscriptionAdminClient and \ref | |||
| * google::cloud::pubsub_admin::SubscriptionAdminClient instead. | |||
| @@ -30,6 +30,9 @@ GOOGLE_CLOUD_CPP_INLINE_NAMESPACE_BEGIN | |||
| /** | |||
| * Performs topic admin operations in Cloud Pub/Sub. | |||
| * | |||
| * @deprecated Please use \ref google::cloud::pubsub_admin::TopicAdminClient | |||
| * and \ref google::cloud::pubsub_admin::TopicAdminClient instead. | |||
| @@ -73,6 +73,9 @@ using ListTopicSnapshotsRange = | |||
| /** | |||
| * A connection to Cloud Pub/Sub for topic-related administrative operations. | |||
| * | |||
| * @deprecated Please use #google::cloud::pubsub_admin::SubscriptionAdminClient | |||
There was a problem hiding this comment.
s/Subscription/Topic/
and switch # to \ref just to be consistent?
| @@ -73,6 +73,9 @@ using ListTopicSnapshotsRange = | |||
| /** | |||
| * A connection to Cloud Pub/Sub for topic-related administrative operations. | |||
| * | |||
| * @deprecated Please use #google::cloud::pubsub_admin::SubscriptionAdminClient | |||
| * and #google::cloud::pubsub_admin::SubscriptionAdminClient instead. | |||
There was a problem hiding this comment.
s/Subscription/Topic/
s/Client/Connection/
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Part of #12987
This change is