Skip to content

Commit b7a0232

Browse files
authored
docs(bigtable): expose Admin API Stubs in Javadoc (#2835)
In PR #2834, we removed the @internalapi annotations from the Admin API stub classes to align with a vanilla GAPIC surface. Because they are no longer internal, we must expose them in the public Javadoc reference documentation so that power users can use them for advanced configuration and custom transports. This commit updates the `pom.xml` file to: - Remove `sourceFileExclude` entries for Admin API stub classes in the `maven-javadoc-plugin` configuration. - Update the `docFX` regex to stop excluding `stub.*` classes for the `admin.v2` package.
1 parent 2933ef6 commit b7a0232

1 file changed

Lines changed: 1 addition & 7 deletions

File tree

pom.xml

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -263,14 +263,8 @@
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/stub/GrpcBigtableInstanceAdminCallableFactory.java</sourceFileExclude>
267-
<sourceFileExclude>**/com/google/cloud/bigtable/admin/v2/stub/GrpcBigtableInstanceAdminStub.java</sourceFileExclude>
268-
<sourceFileExclude>**/com/google/cloud/bigtable/admin/v2/stub/BigtableInstanceAdminStub.java</sourceFileExclude>
269266

270267
<!-- Hide**/ @InternalApi classes for TableAdmin -->
271-
<sourceFileExclude>**/com/google/cloud/bigtable/admin/v2/stub/GrpcBigtableTableAdminCallableFactory.java</sourceFileExclude>
272-
<sourceFileExclude>**/com/google/cloud/bigtable/admin/v2/stub/GrpcBigtableTableAdminStub.java</sourceFileExclude>
273-
<sourceFileExclude>**/com/google/cloud/bigtable/admin/v2/stub/BigtableTableAdminStub.java</sourceFileExclude>
274268
<sourceFileExclude>**/com/google/cloud/bigtable/admin/v2/stub/EnhancedBigtableTableAdminStub.java</sourceFileExclude>
275269

276270
<!-- Hide**/ @InternalApi classes for Data -->
@@ -327,7 +321,7 @@
327321
<!-- Exclude generating javadocs for internal implementations for admin and data, which
328322
are under internal/ and .v2.stub/, and exclude all BaseClients and BaseSettings.
329323
The only exception is we want to keep the javadoc for StubSettings. -->
330-
-excludeclasses com\.google\.cloud\.bigtable\.admin\.v2\.(internal\.|stub\.(?!Bigtable.*StubSettings).*):com\.google\.cloud\.bigtable\.data\.v2\.(internal\.|(Base.*).*|stub\.(?!Enhanced.*StubSettings).*)
324+
-excludeclasses com\.google\.cloud\.bigtable\.admin\.v2\.internal\..*:com\.google\.cloud\.bigtable\.data\.v2\.(internal\.|(Base.*).*|stub\.(?!Enhanced.*StubSettings).*)
331325
<!-- Exclude the javadocs for the auto-generated raw protos since we don't expose them.
332326
The raw protos generated by gapic are under com.google.bigtable. And the public surface
333327
is under com.google.cloud.bigtable. Also exclude the stats package which is the

0 commit comments

Comments
 (0)