Skip to content

Commit ded74d8

Browse files
authored
docs(bigtable): small cleanups (#11610)
Exclude test proxy symbols from the documentation. Formatting as monospace does not work well in titles. I tried backticks, `@c` commands, and `<tt>`. Use the magic `*-endpoint-snippet` name to skip pages from the DoxFX table of contents.
1 parent fdf13e6 commit ded74d8

File tree

3 files changed

+26
-15
lines changed

3 files changed

+26
-15
lines changed

google/cloud/bigtable/CMakeLists.txt

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,15 @@ set(DOXYGEN_EXAMPLE_PATH
2222
"${CMAKE_CURRENT_SOURCE_DIR}/examples"
2323
"${CMAKE_CURRENT_SOURCE_DIR}/admin/samples"
2424
"${CMAKE_CURRENT_SOURCE_DIR}/quickstart")
25-
set(DOXYGEN_EXCLUDE_SYMBOLS "benchmarks" "bigtable_admin_internal"
26-
"bigtable_internal" "internal" "testing" "examples")
25+
set(DOXYGEN_EXCLUDE_SYMBOLS
26+
"benchmarks"
27+
"bigtable_admin_internal"
28+
"bigtable_internal"
29+
"internal"
30+
"testing"
31+
"examples"
32+
"testproxy"
33+
"test_proxy")
2734

2835
include(GoogleCloudCppDoxygen)
2936
google_cloud_cpp_doxygen_targets("bigtable" DEPENDS cloud-docs

google/cloud/bigtable/doc/bigtable-main.dox

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -82,9 +82,11 @@ endpoint for `google::cloud::bigtable::Table`:
8282

8383
@snippet client_samples.cc table-set-endpoint
8484

85-
Follow these links for additional examples
86-
[BigtableTableAdminClient](@ref BigtableTableAdminClient-set-endpoint-snippet)
87-
[InstanceTableAdminClient](@ref BigtableInstanceAdminClient-set-endpoint-snippet)
85+
Changing the default endpoint for other `*Client` classes is very similar, as
86+
shown in these examples:
87+
88+
- [BigtableTableAdminClient](@ref BigtableTableAdminClient-set-endpoint-snippet)
89+
- [InstanceTableAdminClient](@ref BigtableInstanceAdminClient-set-endpoint-snippet)
8890
*/
8991

9092
/**
@@ -101,9 +103,11 @@ Keep in mind that we chose this as an example because it is relatively easy to
101103
understand. Consult the [Best practices for managing service account keys]
102104
guide for more details.
103105

104-
Follow these links for additional examples
105-
[BigtableTableAdminClient](@ref BigtableTableAdminClient-with-service-account-snippet)
106-
[InstanceTableAdminClient](@ref BigtableInstanceAdminClient-with-service-account-snippet)
106+
Changing the default authentication configuration for other `*Client` classes is
107+
very similar, as shown in these examples:
108+
109+
- [BigtableTableAdminClient](@ref BigtableTableAdminClient-with-service-account-snippet)
110+
- [InstanceTableAdminClient](@ref BigtableInstanceAdminClient-with-service-account-snippet)
107111

108112
Keep in mind that we chose this as an example because it is relatively easy to
109113
understand. Consult the [Best practices for managing service account keys]
@@ -117,32 +121,32 @@ guide for more details.
117121

118122
*/
119123

120-
/*! @page Table-set-endpoint Override @c Table Default Endpoint
124+
/*! @page Table-set-endpoint-snippet Override Table Default Endpoint
121125

122126
@snippet google/cloud/bigtable/examples/client_samples.cc table-set-endpoint
123127
*/
124128

125-
/*! @page Table-with-service-account-snippet Override @c Table Default Authentication
129+
/*! @page Table-with-service-account-snippet Override Table Default Authentication
126130

127131
@snippet google/cloud/bigtable/examples/client_samples.cc table-with-service-account
128132
*/
129133

130-
/*! @page BigtableTableAdminClient-set-endpoint-snippet Override @c BigtableTableAdminClient Default Endpoint
134+
/*! @page BigtableTableAdminClient-set-endpoint-snippet Override BigtableTableAdminClient Default Endpoint
131135

132136
@snippet google/cloud/bigtable/admin/samples/bigtable_table_admin_client_samples.cc set-client-endpoint
133137
*/
134138

135-
/*! @page BigtableTableAdminClient-with-service-account-snippet Override @c BigtableTableAdminClient Default Authentication
139+
/*! @page BigtableTableAdminClient-with-service-account-snippet Override BigtableTableAdminClient Default Authentication
136140

137141
@snippet google/cloud/bigtable/admin/samples/bigtable_table_admin_client_samples.cc with-service-account
138142
*/
139143

140-
/*! @page BigtableInstanceAdminClient-set-endpoint-snippet Override @c BigtableInstanceAdminClient Default Endpoint
144+
/*! @page BigtableInstanceAdminClient-set-endpoint-snippet Override BigtableInstanceAdminClient Default Endpoint
141145

142146
@snippet google/cloud/bigtable/admin/samples/bigtable_instance_admin_client_samples.cc set-client-endpoint
143147
*/
144148

145-
/*! @page BigtableInstanceAdminClient-with-service-account-snippet Override @c BigtableInstanceAdminClient Default Authentication
149+
/*! @page BigtableInstanceAdminClient-with-service-account-snippet Override BigtableInstanceAdminClient Default Authentication
146150

147151
@snippet google/cloud/bigtable/admin/samples/bigtable_instance_admin_client_samples.cc with-service-account
148152
*/

google/cloud/bigtable/doc/migrating-from-dataclient.dox

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/*!
22

3-
@page migrating-from-dataclient Migrating from `DataClient` to `DataConnection`
3+
@page migrating-from-dataclient Migrating from DataClient to DataConnection
44

55
In this document we describe how to migrate existing code that uses `DataClient`
66
to use `DataConnection`.

0 commit comments

Comments
 (0)