Skip to content

Commit 2933ef6

Browse files
authored
docs(bigtable): expose Base Admin Clients in Javadoc (#2833)
We recently modernized the Java Bigtable Admin API. The legacy clients now delegate to the autogenerated GAPIC base clients via a new `getBaseClient()` method. Because these Base clients are now the recommended API surface, they should no longer be hidden from the public DevSite documentation. This commit updates the `pom.xml` file to: - Remove `sourceFileExclude` entries for Base Admin Classes in the `maven-javadoc-plugin` configuration. - Update the `docFX` regex to stop excluding Base classes for the `admin.v2` package.
1 parent d25f39c commit 2933ef6

File tree

1 file changed

+1
-5
lines changed

1 file changed

+1
-5
lines changed

pom.xml

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -263,15 +263,11 @@
263263

264264
<!-- Hide @InternalApi classes for InstanceAdmin -->
265265
<sourceFileExclude>**/com/google/cloud/bigtable/admin/v2/internal/**</sourceFileExclude>
266-
<sourceFileExclude>**/com/google/cloud/bigtable/admin/v2/BaseBigtableInstanceAdminClient.java</sourceFileExclude>
267-
<sourceFileExclude>**/com/google/cloud/bigtable/admin/v2/BaseBigtableInstanceAdminSettings.java</sourceFileExclude>
268266
<sourceFileExclude>**/com/google/cloud/bigtable/admin/v2/stub/GrpcBigtableInstanceAdminCallableFactory.java</sourceFileExclude>
269267
<sourceFileExclude>**/com/google/cloud/bigtable/admin/v2/stub/GrpcBigtableInstanceAdminStub.java</sourceFileExclude>
270268
<sourceFileExclude>**/com/google/cloud/bigtable/admin/v2/stub/BigtableInstanceAdminStub.java</sourceFileExclude>
271269

272270
<!-- Hide**/ @InternalApi classes for TableAdmin -->
273-
<sourceFileExclude>**/com/google/cloud/bigtable/admin/v2/BaseBigtableTableAdminClient.java</sourceFileExclude>
274-
<sourceFileExclude>**/com/google/cloud/bigtable/admin/v2/BaseBigtableTableAdminSettings.java</sourceFileExclude>
275271
<sourceFileExclude>**/com/google/cloud/bigtable/admin/v2/stub/GrpcBigtableTableAdminCallableFactory.java</sourceFileExclude>
276272
<sourceFileExclude>**/com/google/cloud/bigtable/admin/v2/stub/GrpcBigtableTableAdminStub.java</sourceFileExclude>
277273
<sourceFileExclude>**/com/google/cloud/bigtable/admin/v2/stub/BigtableTableAdminStub.java</sourceFileExclude>
@@ -331,7 +327,7 @@
331327
<!-- Exclude generating javadocs for internal implementations for admin and data, which
332328
are under internal/ and .v2.stub/, and exclude all BaseClients and BaseSettings.
333329
The only exception is we want to keep the javadoc for StubSettings. -->
334-
-excludeclasses com\.google\.cloud\.bigtable\.admin\.v2\.(internal\.|(Base.*).*|stub\.(?!Bigtable.*StubSettings).*):com\.google\.cloud\.bigtable\.data\.v2\.(internal\.|(Base.*).*|stub\.(?!Enhanced.*StubSettings).*)
330+
-excludeclasses com\.google\.cloud\.bigtable\.admin\.v2\.(internal\.|stub\.(?!Bigtable.*StubSettings).*):com\.google\.cloud\.bigtable\.data\.v2\.(internal\.|(Base.*).*|stub\.(?!Enhanced.*StubSettings).*)
335331
<!-- Exclude the javadocs for the auto-generated raw protos since we don't expose them.
336332
The raw protos generated by gapic are under com.google.bigtable. And the public surface
337333
is under com.google.cloud.bigtable. Also exclude the stats package which is the

0 commit comments

Comments
 (0)