Skip to content
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

doc: remove inline namespace from doxygen #7461

Merged
merged 2 commits into from
Oct 14, 2021
Merged

doc: remove inline namespace from doxygen #7461

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
64751ac
doc: remove inline namespace from doxygen
devjgm Oct 14, 2021
12d90fe
updated changelog advice
devjgm Oct 14, 2021
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
16 changes: 16 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,22 @@

## v1.33.0 - TBD

**ATTENTION**: Users should generally **NOT** spell the name of our versioned
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This paragraph assumes that one knows what "our versioned inline namespace" is. And it is a bit informal.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

inline namespace in their code, as doing so will tightly couple your code to a
specific version of our library and will make upgrades more difficult for you.
Previously, this version was `v1` (but it will change in the future), and so
you may have some code that references, say, ~`google::cloud::v1::Status`~
(WRONG) and you should instead prefer `google::cloud::Status` (omit the
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't yell at the customers. Specially if it was our fault. Maybe just say:

For example, prefer using `google::cloud::Status` in your code, over `google::cloud::v1::Status`, as the latter makes it harder to update your code when upgrading the libraries.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

versioned inline namespace name).

Our Doxygen documentation (e.g. [Storage docs][storage-dox-link]) was
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would lead with this paragraph.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

incorrectly showing the versioned inline namespace name for our symbols,
implicitly suggesting that users should spell this inline namespace in their
own code. This mistake was fixed and our Doxygen documentation no longer shows
the versioned inline namespace name.

[storage-dox-link]: https://googleapis.dev/cpp/google-cloud-storage/latest/

## v1.32.1 - 2021-10

### [Pub/Sub](https://github.com/googleapis/google-cloud-cpp/blob/main/google/cloud/pubsub/README.md)
Expand Down
5 changes: 2 additions & 3 deletions cmake/GoogleCloudCppCommon.cmake
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,9 +80,8 @@ elseif (GOOGLE_CLOUD_CPP_GENERATE_DOXYGEN)
"GOOGLE_CLOUD_CPP_IAM_DEPRECATED(x)="
"GOOGLE_CLOUD_CPP_BIGTABLE_IAM_DEPRECATED(x)="
"GOOGLE_CLOUD_CPP_SPANNER_ADMIN_API_DEPRECATED(x)="
"GOOGLE_CLOUD_CPP_INLINE_NAMESPACE_BEGIN=inline namespace omit_this_inline_ns {"
"GOOGLE_CLOUD_CPP_INLINE_NAMESPACE_END=}"
"GOOGLE_CLOUD_CPP_NS=omit_this_inline_ns")
"GOOGLE_CLOUD_CPP_INLINE_NAMESPACE_BEGIN="
"GOOGLE_CLOUD_CPP_INLINE_NAMESPACE_END=")
set(DOXYGEN_HTML_TIMESTAMP YES)
set(DOXYGEN_STRIP_FROM_INC_PATH "${PROJECT_SOURCE_DIR}")
set(DOXYGEN_SHOW_USED_FILES NO)
Expand Down
22 changes: 11 additions & 11 deletions google/cloud/bigtable/doc/bigtable-hello-instance-admin.dox
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,17 +114,17 @@ Here is the full example

@snippet bigtable_hello_instance_admin.cc all code

[InstanceAdmin]: @ref google::cloud::bigtable::omit_this_inline_ns::InstanceAdmin
[InstanceAdmin-CreateInstance]: @ref google::cloud::bigtable::omit_this_inline_ns::InstanceAdmin::CreateInstance()
[InstanceAdmin-ListInstances]: @ref google::cloud::bigtable::omit_this_inline_ns::InstanceAdmin::ListInstances()
[InstanceAdmin-GetInstance]: @ref google::cloud::bigtable::omit_this_inline_ns::InstanceAdmin::GetInstance()
[InstanceAdmin-DeleteInstance]: @ref google::cloud::bigtable::omit_this_inline_ns::InstanceAdmin::DeleteInstance()
[InstanceAdmin-CreateCluster]: @ref google::cloud::bigtable::omit_this_inline_ns::InstanceAdmin::CreateCluster()
[InstanceAdmin-GetCluster]: @ref google::cloud::bigtable::omit_this_inline_ns::InstanceAdmin::GetCluster()
[InstanceAdmin-UpdateCluster]: @ref google::cloud::bigtable::omit_this_inline_ns::InstanceAdmin::UpdateCluster()
[InstanceAdmin-DeleteCluster]: @ref google::cloud::bigtable::omit_this_inline_ns::InstanceAdmin::DeleteCluster()
[InstanceAdmin-ListClusters]: @ref google::cloud::bigtable::omit_this_inline_ns::InstanceAdmin::ListClusters()
[InstanceConfig]: @ref google::cloud::bigtable::omit_this_inline_ns::InstanceConfig
[InstanceAdmin]: @ref google::cloud::bigtable::InstanceAdmin
[InstanceAdmin-CreateInstance]: @ref google::cloud::bigtable::InstanceAdmin::CreateInstance()
[InstanceAdmin-ListInstances]: @ref google::cloud::bigtable::InstanceAdmin::ListInstances()
[InstanceAdmin-GetInstance]: @ref google::cloud::bigtable::InstanceAdmin::GetInstance()
[InstanceAdmin-DeleteInstance]: @ref google::cloud::bigtable::InstanceAdmin::DeleteInstance()
[InstanceAdmin-CreateCluster]: @ref google::cloud::bigtable::InstanceAdmin::CreateCluster()
[InstanceAdmin-GetCluster]: @ref google::cloud::bigtable::InstanceAdmin::GetCluster()
[InstanceAdmin-UpdateCluster]: @ref google::cloud::bigtable::InstanceAdmin::UpdateCluster()
[InstanceAdmin-DeleteCluster]: @ref google::cloud::bigtable::InstanceAdmin::DeleteCluster()
[InstanceAdmin-ListClusters]: @ref google::cloud::bigtable::InstanceAdmin::ListClusters()
[InstanceConfig]: @ref google::cloud::bigtable::InstanceConfig

[ListInstancesResponse-proto]: https://cloud.google.com/bigtable/docs/reference/admin/rpc/google.bigtable.admin.v2#google.bigtable.admin.v2.ListInstancesResponse
[ListClustersResponse-proto]: https://cloud.google.com/bigtable/docs/reference/admin/rpc/google.bigtable.admin.v2#google.bigtable.admin.v2.ListClustersResponse
Expand Down
32 changes: 16 additions & 16 deletions google/cloud/bigtable/doc/bigtable-hello-table-admin.dox
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,22 +122,22 @@ Here is the full example

@snippet bigtable_hello_table_admin.cc all code

[GcRule]: @ref google::cloud::bigtable::omit_this_inline_ns::GcRule
[GcRule-MaxAge]: @ref google::cloud::bigtable::omit_this_inline_ns::GcRule::MaxAge()
[GcRule-MaxNumVersions]: @ref google::cloud::bigtable::omit_this_inline_ns::GcRule::MaxNumVersions()
[GcRule-Union]: @ref google::cloud::bigtable::omit_this_inline_ns::GcRule::Union()
[GcRule-Intersection]: @ref google::cloud::bigtable::omit_this_inline_ns::GcRule::Intersection()
[ColumnFamilyModification-Create]: @ref google::cloud::bigtable::omit_this_inline_ns::ColumnFamilyModification::Create()
[ColumnFamilyModification-Update]: @ref google::cloud::bigtable::omit_this_inline_ns::ColumnFamilyModification::Update()
[ColumnFamilyModification-Drop]: @ref google::cloud::bigtable::omit_this_inline_ns::ColumnFamilyModification::Drop()
[TableAdmin]: @ref google::cloud::bigtable::omit_this_inline_ns::TableAdmin
[TableAdmin-CreateTable]: @ref google::cloud::bigtable::omit_this_inline_ns::TableAdmin::CreateTable()
[TableAdmin-DeleteTable]: @ref google::cloud::bigtable::omit_this_inline_ns::TableAdmin::DeleteTable()
[TableAdmin-GetTable]: @ref google::cloud::bigtable::omit_this_inline_ns::TableAdmin::GetTable()
[TableAdmin-ListTables]: @ref google::cloud::bigtable::omit_this_inline_ns::TableAdmin::ListTables()
[TableAdmin-ModifyColumnFamilies]: @ref google::cloud::bigtable::omit_this_inline_ns::TableAdmin::ModifyColumnFamilies()
[TableAdmin-DropAllRows]: @ref google::cloud::bigtable::omit_this_inline_ns::TableAdmin::DropAllRows()
[TableAdmin-DropRowsByPrefix]: @ref google::cloud::bigtable::omit_this_inline_ns::TableAdmin::DropRowsByPrefix()
[GcRule]: @ref google::cloud::bigtable::GcRule
[GcRule-MaxAge]: @ref google::cloud::bigtable::GcRule::MaxAge()
[GcRule-MaxNumVersions]: @ref google::cloud::bigtable::GcRule::MaxNumVersions()
[GcRule-Union]: @ref google::cloud::bigtable::GcRule::Union()
[GcRule-Intersection]: @ref google::cloud::bigtable::GcRule::Intersection()
[ColumnFamilyModification-Create]: @ref google::cloud::bigtable::ColumnFamilyModification::Create()
[ColumnFamilyModification-Update]: @ref google::cloud::bigtable::ColumnFamilyModification::Update()
[ColumnFamilyModification-Drop]: @ref google::cloud::bigtable::ColumnFamilyModification::Drop()
[TableAdmin]: @ref google::cloud::bigtable::TableAdmin
[TableAdmin-CreateTable]: @ref google::cloud::bigtable::TableAdmin::CreateTable()
[TableAdmin-DeleteTable]: @ref google::cloud::bigtable::TableAdmin::DeleteTable()
[TableAdmin-GetTable]: @ref google::cloud::bigtable::TableAdmin::GetTable()
[TableAdmin-ListTables]: @ref google::cloud::bigtable::TableAdmin::ListTables()
[TableAdmin-ModifyColumnFamilies]: @ref google::cloud::bigtable::TableAdmin::ModifyColumnFamilies()
[TableAdmin-DropAllRows]: @ref google::cloud::bigtable::TableAdmin::DropAllRows()
[TableAdmin-DropRowsByPrefix]: @ref google::cloud::bigtable::TableAdmin::DropRowsByPrefix()

[TableView-proto]: https://cloud.google.com/bigtable/docs/reference/admin/rpc/google.bigtable.admin.v2#google.bigtable.admin.v2.Table.View
*/
28 changes: 14 additions & 14 deletions google/cloud/bigtable/doc/bigtable-hello-world.dox
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,19 +124,19 @@ Here is the full example

@snippet bigtable_hello_world.cc all code

[Filter]: @ref google::cloud::bigtable::omit_this_inline_ns::Filter
[InstanceAdmin]: @ref google::cloud::bigtable::omit_this_inline_ns::InstanceAdmin
[Mutation]: @ref google::cloud::bigtable::omit_this_inline_ns::Mutation
[Row]: @ref google::cloud::bigtable::omit_this_inline_ns::Row
[RowRange]: @ref google::cloud::bigtable::omit_this_inline_ns::RowRange
[RowSet]: @ref google::cloud::bigtable::omit_this_inline_ns::RowSet
[Table]: @ref google::cloud::bigtable::omit_this_inline_ns::Table
[Table-Apply]: @ref google::cloud::bigtable::omit_this_inline_ns::Table::Apply
[Table-BulkApply]: @ref google::cloud::bigtable::omit_this_inline_ns::Table::BulkApply
[Table-ReadRow]: @ref google::cloud::bigtable::omit_this_inline_ns::Table::ReadRow
[Table-ReadRows]: @ref google::cloud::bigtable::omit_this_inline_ns::Table::ReadRows
[TableAdmin]: @ref google::cloud::bigtable::omit_this_inline_ns::TableAdmin
[TableAdmin-CreateTable]: @ref google::cloud::bigtable::omit_this_inline_ns::TableAdmin::CreateTable
[TableAdmin-DeleteTable]: @ref google::cloud::bigtable::omit_this_inline_ns::TableAdmin::DeleteTable
[Filter]: @ref google::cloud::bigtable::Filter
[InstanceAdmin]: @ref google::cloud::bigtable::InstanceAdmin
[Mutation]: @ref google::cloud::bigtable::Mutation
[Row]: @ref google::cloud::bigtable::Row
[RowRange]: @ref google::cloud::bigtable::RowRange
[RowSet]: @ref google::cloud::bigtable::RowSet
[Table]: @ref google::cloud::bigtable::Table
[Table-Apply]: @ref google::cloud::bigtable::Table::Apply
[Table-BulkApply]: @ref google::cloud::bigtable::Table::BulkApply
[Table-ReadRow]: @ref google::cloud::bigtable::Table::ReadRow
[Table-ReadRows]: @ref google::cloud::bigtable::Table::ReadRows
[TableAdmin]: @ref google::cloud::bigtable::TableAdmin
[TableAdmin-CreateTable]: @ref google::cloud::bigtable::TableAdmin::CreateTable
[TableAdmin-DeleteTable]: @ref google::cloud::bigtable::TableAdmin::DeleteTable

*/
10 changes: 4 additions & 6 deletions google/cloud/bigtable/instance_admin.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,10 +60,8 @@ GOOGLE_CLOUD_CPP_INLINE_NAMESPACE_BEGIN
* the `ok()` member function in the `StatusOr<T>` returns `true` then it
* contains the expected result. Operations that do not return a value simply
* return a `google::cloud::Status` indicating success or the details of the
* error Please consult the
* [`StatusOr<T>`
* documentation](#google::cloud::omit_this_inline_ns::StatusOr) for more
* details.
* error Please consult the [`StatusOr<T>`
* documentation](#google::cloud::StatusOr) for more details.
*
* @code
* namespace cbt = google::cloud::bigtable;
Expand Down Expand Up @@ -111,8 +109,8 @@ GOOGLE_CLOUD_CPP_INLINE_NAMESPACE_BEGIN
* @see https://cloud.google.com/bigtable/docs/reference/service-apis-overview
* for an overview of the underlying Cloud Bigtable API.
*
* @see #google::cloud::omit_this_inline_ns::StatusOr for a description of the
* error reporting class used by this library.
* @see #google::cloud::StatusOr for a description of the error reporting class
* used by this library.
*
* @see `LimitedTimeRetryPolicy` and `LimitedErrorCountRetryPolicy` for
* alternative retry policies.
Expand Down
10 changes: 4 additions & 6 deletions google/cloud/bigtable/table.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,10 +100,8 @@ inline std::string TableName(std::shared_ptr<DataClient> const& client,
* the `ok()` member function in the `StatusOr<T>` returns `true` then it
* contains the expected result. Operations that do not return a value simply
* return a `google::cloud::Status` indicating success or the details of the
* error Please consult the
* [`StatusOr<T>`
* documentation](#google::cloud::omit_this_inline_ns::StatusOr) for more
* details.
* error Please consult the [`StatusOr<T>`
* documentation](#google::cloud::StatusOr) for more details.
*
* @code
* namespace cbt = google::cloud::bigtable;
Expand Down Expand Up @@ -154,8 +152,8 @@ inline std::string TableName(std::shared_ptr<DataClient> const& client,
* @see https://cloud.google.com/bigtable/docs/reference/service-apis-overview
* for an overview of the underlying Cloud Bigtable API.
*
* @see #google::cloud::omit_this_inline_ns::StatusOr for a description of the
* error reporting class used by this library.
* @see #google::cloud::StatusOr for a description of the error reporting class
* used by this library.
*
* @see `LimitedTimeRetryPolicy` and `LimitedErrorCountRetryPolicy` for
* alternative retry policies.
Expand Down
10 changes: 4 additions & 6 deletions google/cloud/bigtable/table_admin.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,10 +71,8 @@ enum class Consistency {
* the `ok()` member function in the `StatusOr<T>` returns `true` then it
* contains the expected result. Operations that do not return a value simply
* return a `google::cloud::Status` indicating success or the details of the
* error Please consult the
* [`StatusOr<T>`
* documentation](#google::cloud::omit_this_inline_ns::StatusOr) for more
* details.
* error Please consult the [`StatusOr<T>`
* documentation](#google::cloud::StatusOr) for more details.
*
* @code
* namespace cbt = google::cloud::bigtable;
Expand Down Expand Up @@ -122,8 +120,8 @@ enum class Consistency {
* @see https://cloud.google.com/bigtable/docs/reference/service-apis-overview
* for an overview of the underlying Cloud Bigtable API.
*
* @see #google::cloud::omit_this_inline_ns::StatusOr for a description of the
* error reporting class used by this library.
* @see #google::cloud::StatusOr for a description of the error reporting class
* used by this library.
*
* @see `LimitedTimeRetryPolicy` and `LimitedErrorCountRetryPolicy` for
* alternative retry policies.
Expand Down
15 changes: 7 additions & 8 deletions google/cloud/doc/common-main.dox
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,15 @@
This library contains common components shared by all the Google Cloud C++
Client Libraries. Including:

- [Status](@ref google::cloud::omit_this_inline_ns::Status) error codes and details from an
- [Status](@ref google::cloud::Status) error codes and details from an
operation.
- [StatusOr<T>](@ref google::cloud::omit_this_inline_ns::StatusOr) returns a value on success
- [StatusOr<T>](@ref google::cloud::StatusOr) returns a value on success
and a `Status` on error.
- [future<T>](@ref google::cloud::omit_this_inline_ns::future) and
[promise<T>](@ref google::cloud::omit_this_inline_ns::promise) futures (a holder that will
receive a value asynchronously) and promises (the counterpart of a future,
where values are stored asynchronously). They satisfy the API for
`std::future` and `std::promise`, and add support for callbacks and
cancellation.
- [future<T>](@ref google::cloud::future) and
[promise<T>](@ref google::cloud::promise) futures (a holder that will receive
a value asynchronously) and promises (the counterpart of a future, where
values are stored asynchronously). They satisfy the API for `std::future` and
`std::promise`, and add support for callbacks and cancellation.

@warning The symbols in the `google::cloud::internal` namespace are
implementation details and subject to change and/or removal without notice.
Expand Down
3 changes: 1 addition & 2 deletions google/cloud/pubsub/mocks/mock_ack_handler.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,7 @@ GOOGLE_CLOUD_CPP_INLINE_NAMESPACE_BEGIN
/**
* A googlemock-based mock for [pubsub::AckHandler::Impl][mocked-link]
*
* [mocked-link]: @ref
* google::cloud::pubsub::omit_this_inline_ns::AckHandler::Impl
* [mocked-link]: @ref google::cloud::pubsub::AckHandler::Impl
*
* @see @ref subscriber-mock for an example using this class.
*/
Expand Down
3 changes: 1 addition & 2 deletions google/cloud/pubsub/mocks/mock_publisher_connection.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,7 @@ GOOGLE_CLOUD_CPP_INLINE_NAMESPACE_BEGIN
/**
* A googlemock-based mock for [pubsub::PublisherConnection][mocked-link]
*
* [mocked-link]: @ref
* google::cloud::pubsub::omit_this_inline_ns::PublisherConnection
* [mocked-link]: @ref google::cloud::pubsub::PublisherConnection
*
* @see @ref publisher-mock for an example using this class.
*/
Expand Down
3 changes: 1 addition & 2 deletions google/cloud/pubsub/mocks/mock_schema_admin_connection.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,7 @@ GOOGLE_CLOUD_CPP_INLINE_NAMESPACE_BEGIN
* A googlemock-based mock for
* [pubsub::SchemaAdminConnection][mocked-link]
*
* [mocked-link]: @ref
* google::cloud::pubsub::omit_this_inline_ns::SchemaAdminConnection
* [mocked-link]: @ref google::cloud::pubsub::SchemaAdminConnection
*/
class MockSchemaAdminConnection : public pubsub::SchemaAdminConnection {
public:
Expand Down
3 changes: 1 addition & 2 deletions google/cloud/pubsub/mocks/mock_subscriber_connection.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,7 @@ GOOGLE_CLOUD_CPP_INLINE_NAMESPACE_BEGIN
/**
* A googlemock-based mock for [pubsub::SubscriberConnection][mocked-link]
*
* [mocked-link]: @ref
* google::cloud::pubsub::omit_this_inline_ns::SubscriberConnection
* [mocked-link]: @ref google::cloud::pubsub::SubscriberConnection
*
* @see @ref subscriber-mock for an example using this class.
*/
Expand Down
3 changes: 1 addition & 2 deletions google/cloud/pubsub/mocks/mock_subscription_admin_connection.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,7 @@ GOOGLE_CLOUD_CPP_INLINE_NAMESPACE_BEGIN
* A googlemock-based mock for
* [pubsub::SubscriptionAdminConnection][mocked-link]
*
* [mocked-link]: @ref
* google::cloud::pubsub::omit_this_inline_ns::SubscriptionAdminConnection
* [mocked-link]: @ref google::cloud::pubsub::SubscriptionAdminConnection
*/
class MockSubscriptionAdminConnection
: public pubsub::SubscriptionAdminConnection {
Expand Down
3 changes: 1 addition & 2 deletions google/cloud/pubsub/mocks/mock_topic_admin_connection.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,7 @@ GOOGLE_CLOUD_CPP_INLINE_NAMESPACE_BEGIN
/**
* A googlemock-based mock for [pubsub::TopicAdminConnection][mocked-link]
*
* [mocked-link]: @ref
* google::cloud::pubsub::omit_this_inline_ns::TopicAdminConnection
* [mocked-link]: @ref google::cloud::pubsub::TopicAdminConnection
*/
class MockTopicAdminConnection : public pubsub::TopicAdminConnection {
public:
Expand Down
16 changes: 7 additions & 9 deletions google/cloud/pubsub/publisher.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,10 +67,9 @@ GOOGLE_CLOUD_CPP_INLINE_NAMESPACE_BEGIN
* @par Background Threads
* This class uses the background threads configured via the `Options` from
* `GrpcOptionList`. Applications can create their own pool of background
* threads by (a) creating their own
* #google::cloud::omit_this_inline_ns::CompletionQueue, (b) passing this
* completion queue as a `GrpcCompletionQueueOption`, and (c) attaching any
* number of threads to the completion queue.
* threads by (a) creating their own #google::cloud::CompletionQueue, (b)
* passing this completion queue as a `GrpcCompletionQueueOption`, and (c)
* attaching any number of threads to the completion queue.
*
* @par Example: using a custom thread pool
* @snippet samples.cc custom-thread-pool-publisher
Expand All @@ -81,16 +80,15 @@ GOOGLE_CLOUD_CPP_INLINE_NAMESPACE_BEGIN
* [`std::future<T>`][std-future-link]. Our version adds a `.then()` function to
* attach a callback to the future, which is invoked when the future is
* satisfied. This function returns a `future<U>` where `U` is the return value
* of the attached function. More details in the
* #google::cloud::omit_this_inline_ns::future documentation.
* of the attached function. More details in the #google::cloud::future
* documentation.
*
* @par Error Handling
* This class uses `StatusOr<T>` to report errors. When an operation fails to
* perform its work the returned `StatusOr<T>` contains the error details. If
* the `ok()` member function in the `StatusOr<T>` returns `true` then it
* contains the expected result. Please consult the
* #google::cloud::omit_this_inline_ns::StatusOr documentation for more
* details.
* contains the expected result. Please consult the #google::cloud::StatusOr
* documentation for more details.
*
* @par Batching Configuration Example
* @snippet samples.cc publisher-options
Expand Down
6 changes: 2 additions & 4 deletions google/cloud/pubsub/schema_admin_client.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,10 +54,8 @@ GOOGLE_CLOUD_CPP_INLINE_NAMESPACE_BEGIN
* This class uses `StatusOr<T>` to report errors. When an operation fails to
* perform its work the returned `StatusOr<T>` contains the error details. If
* the `ok()` member function in the `StatusOr<T>` returns `true` then it
* contains the expected result. Please consult the
* [`StatusOr<T>`
* documentation](#google::cloud::omit_this_inline_ns::StatusOr) for more
* details.
* contains the expected result. Please consult the [`StatusOr<T>`
* documentation](#google::cloud::StatusOr) for more details.
*
* [pubsub-doc-link]: https://cloud.google.com/pubsub/docs
*/
Expand Down
Loading