Skip to content

Commit 828ceea

Browse files
igorbernstein2igorbernstein2
authored
Bigtable: filter out all @InternalApi classed from the javadocs (#5035)
Ideally this should be done via a custom doclet that would filter out any classes annotated with `@InternalOnly`, but this doesn't currently exist. Please note that the exclusion are duplicated across google-cloud-clients/pom.xml and google-cloud-bigtable/pom.xml to support the Jeff's work on splitting javadocs into multiple sites (#5019)
1 parent 71733ab commit 828ceea

2 files changed

Lines changed: 71 additions & 0 deletions

File tree

‎google-cloud-clients/google-cloud-bigtable/pom.xml‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -150,6 +150,41 @@
150150
<nohelp>true</nohelp>
151151
<doclint>none</doclint>
152152
<splitindex>true</splitindex>
153+
154+
<sourceFileExcludes>
155+
<!-- TODO(igorbernstein): use a custom doclet to exclude @InternalApi classes from javadoc -->
156+
<!-- Hide @InternalApi classes -->
157+
<exclude>com/google/cloud/bigtable/gaxx/**</exclude>
158+
159+
<!-- Hide @InternalApi classes for InstanceAdmin -->
160+
<exclude>com/google/cloud/bigtable/admin/v2/internal/**</exclude>
161+
<exclude>com/google/cloud/bigtable/admin/v2/BaseBigtableInstanceAdminClient.java</exclude>
162+
<exclude>com/google/cloud/bigtable/admin/v2/BaseBigtableInstanceAdminSettings.java</exclude>
163+
<exclude>com/google/cloud/bigtable/admin/v2/stub/GrpcBigtableInstanceAdminCallableFactory.java</exclude>
164+
<exclude>com/google/cloud/bigtable/admin/v2/stub/GrpcBigtableInstanceAdminStub.java</exclude>
165+
<exclude>com/google/cloud/bigtable/admin/v2/stub/BigtableInstanceAdminStub.java</exclude>
166+
167+
<!-- Hide @InternalApi classes for TableAdmin -->
168+
<exclude>com/google/cloud/bigtable/admin/v2/BaseBigtableTableAdminClient.java</exclude>
169+
<exclude>com/google/cloud/bigtable/admin/v2/BaseBigtableTableAdminSettings.java</exclude>
170+
<exclude>com/google/cloud/bigtable/admin/v2/stub/GrpcBigtableTableAdminCallableFactory.java</exclude>
171+
<exclude>com/google/cloud/bigtable/admin/v2/stub/GrpcBigtableTableAdminStub.java</exclude>
172+
<exclude>com/google/cloud/bigtable/admin/v2/stub/BigtableTableAdminStub.java</exclude>
173+
<exclude>com/google/cloud/bigtable/admin/v2/stub/EnhancedBigtableTableAdminStub.java</exclude>
174+
175+
<!-- Hide @InternalApi classes for Data -->
176+
<exclude>com/google/cloud/bigtable/data/v2/internal/**</exclude>
177+
<exclude>com/google/cloud/bigtable/data/v2/BaseBigtableDataClient.java</exclude>
178+
<exclude>com/google/cloud/bigtable/data/v2/BaseBigtableDataSettings.java</exclude>
179+
<exclude>com/google/cloud/bigtable/data/v2/stub/BigtableStub.java</exclude>
180+
<exclude>com/google/cloud/bigtable/data/v2/stub/BigtableStubSettings.java</exclude>
181+
<exclude>com/google/cloud/bigtable/data/v2/stub/GrpcBigtableStub.java</exclude>
182+
<exclude>com/google/cloud/bigtable/data/v2/stub/GrpcBigtableCallableFactory.java</exclude>
183+
<exclude>com/google/cloud/bigtable/data/v2/stub/EnhancedBigtableStub.java</exclude>
184+
<exclude>com/google/cloud/bigtable/data/v2/stub/mutaterows/**</exclude>
185+
<exclude>com/google/cloud/bigtable/data/v2/stub/readrows/**</exclude>
186+
</sourceFileExcludes>
187+
153188
<offlineLinks>
154189
<offlineLink>
155190
<url>${project.javadoc.protobufBaseURL}</url>

‎google-cloud-clients/pom.xml‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -797,6 +797,42 @@
797797
<packages>com.google.cloud.compute.deprecated*</packages>
798798
</group>
799799
</groups>
800+
801+
<!-- TODO(chingor13): Remove this once we switch to per client javadoc sites -->
802+
<sourceFileExcludes>
803+
<!-- TODO(igorbernstein): use a custom doclet to exclude @InternalApi classes from javadoc -->
804+
<!-- Bigtable: Hide @InternalApi classes -->
805+
<exclude>com/google/cloud/bigtable/gaxx/**</exclude>
806+
807+
<!-- Bigtable: Hide @InternalApi classes for InstanceAdmin -->
808+
<exclude>com/google/cloud/bigtable/admin/v2/internal/**</exclude>
809+
<exclude>com/google/cloud/bigtable/admin/v2/BaseBigtableInstanceAdminClient.java</exclude>
810+
<exclude>com/google/cloud/bigtable/admin/v2/BaseBigtableInstanceAdminSettings.java</exclude>
811+
<exclude>com/google/cloud/bigtable/admin/v2/stub/GrpcBigtableInstanceAdminCallableFactory.java</exclude>
812+
<exclude>com/google/cloud/bigtable/admin/v2/stub/GrpcBigtableInstanceAdminStub.java</exclude>
813+
<exclude>com/google/cloud/bigtable/admin/v2/stub/BigtableInstanceAdminStub.java</exclude>
814+
815+
<!-- Bigtable: Hide @InternalApi classes for TableAdmin -->
816+
<exclude>com/google/cloud/bigtable/admin/v2/BaseBigtableTableAdminClient.java</exclude>
817+
<exclude>com/google/cloud/bigtable/admin/v2/BaseBigtableTableAdminSettings.java</exclude>
818+
<exclude>com/google/cloud/bigtable/admin/v2/stub/GrpcBigtableTableAdminCallableFactory.java</exclude>
819+
<exclude>com/google/cloud/bigtable/admin/v2/stub/GrpcBigtableTableAdminStub.java</exclude>
820+
<exclude>com/google/cloud/bigtable/admin/v2/stub/BigtableTableAdminStub.java</exclude>
821+
<exclude>com/google/cloud/bigtable/admin/v2/stub/EnhancedBigtableTableAdminStub.java</exclude>
822+
823+
<!-- Bigtable: Hide @InternalApi classes for Data -->
824+
<exclude>com/google/cloud/bigtable/data/v2/internal/**</exclude>
825+
<exclude>com/google/cloud/bigtable/data/v2/BaseBigtableDataClient.java</exclude>
826+
<exclude>com/google/cloud/bigtable/data/v2/BaseBigtableDataSettings.java</exclude>
827+
<exclude>com/google/cloud/bigtable/data/v2/stub/BigtableStub.java</exclude>
828+
<exclude>com/google/cloud/bigtable/data/v2/stub/BigtableStubSettings.java</exclude>
829+
<exclude>com/google/cloud/bigtable/data/v2/stub/GrpcBigtableStub.java</exclude>
830+
<exclude>com/google/cloud/bigtable/data/v2/stub/GrpcBigtableCallableFactory.java</exclude>
831+
<exclude>com/google/cloud/bigtable/data/v2/stub/EnhancedBigtableStub.java</exclude>
832+
<exclude>com/google/cloud/bigtable/data/v2/stub/mutaterows/**</exclude>
833+
<exclude>com/google/cloud/bigtable/data/v2/stub/readrows/**</exclude>
834+
</sourceFileExcludes>
835+
800836
<links>
801837
<link>https://grpc.io/grpc-java/javadoc/</link>
802838
<link>https://developers.google.com/protocol-buffers/docs/reference/java/</link>

0 commit comments

Comments
 (0)