docs(pubsub): add doxygen comment to deprecate handwritten apis (#13585)

googleapis · Feb 12, 2024 · 9076ccf · 9076ccf
1 parent d9843c5
commit 9076ccf
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 0 deletions.
diff --git a/google/cloud/pubsub/subscription_admin_client.h b/google/cloud/pubsub/subscription_admin_client.h
@@ -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.
+ *
  * Applications use this class to perform subscription administrative operations
  * on [Cloud Pub/Sub][pubsub-doc-link].
  *

diff --git a/google/cloud/pubsub/subscription_admin_connection.h b/google/cloud/pubsub/subscription_admin_connection.h
@@ -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.
+ *
  * This interface defines pure-virtual functions for each of the user-facing
  * overload sets in `SubscriptionAdminClient`. That is, all of
  * `SubscriptionAdminClient` overloads will forward to the one pure-virtual

diff --git a/google/cloud/pubsub/topic_admin_client.h b/google/cloud/pubsub/topic_admin_client.h
@@ -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.
+ *
  * Applications use this class to perform operations on
  * [Cloud Pub/Sub][pubsub-doc-link].
  *

diff --git a/google/cloud/pubsub/topic_admin_connection.h b/google/cloud/pubsub/topic_admin_connection.h
@@ -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.
+ *
  * This interface defines pure-virtual functions for each of the user-facing
  * overload sets in `TopicAdminClient`. That is, all of `TopicAdminClient`'s
  * overloads will forward to the one pure-virtual function declared in this