Skip to content

Bigtable: filter out all @InternalApi classed from the javadocs #5035

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

Merged
igorbernstein2 merged 1 commit into from
Apr 29, 2019
Merged

Bigtable: filter out all @InternalApi classed from the javadocs #5035

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
35 changes: 35 additions & 0 deletions google-cloud-clients/google-cloud-bigtable/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,41 @@
<nohelp>true</nohelp>
<doclint>none</doclint>
<splitindex>true</splitindex>

<sourceFileExcludes>
<!-- TODO(igorbernstein): use a custom doclet to exclude @InternalApi classes from javadoc -->
<!-- Hide @InternalApi classes -->
<exclude>com/google/cloud/bigtable/gaxx/**</exclude>

<!-- Hide @InternalApi classes for InstanceAdmin -->
<exclude>com/google/cloud/bigtable/admin/v2/internal/**</exclude>
<exclude>com/google/cloud/bigtable/admin/v2/BaseBigtableInstanceAdminClient.java</exclude>
<exclude>com/google/cloud/bigtable/admin/v2/BaseBigtableInstanceAdminSettings.java</exclude>
<exclude>com/google/cloud/bigtable/admin/v2/stub/GrpcBigtableInstanceAdminCallableFactory.java</exclude>
<exclude>com/google/cloud/bigtable/admin/v2/stub/GrpcBigtableInstanceAdminStub.java</exclude>
<exclude>com/google/cloud/bigtable/admin/v2/stub/BigtableInstanceAdminStub.java</exclude>

<!-- Hide @InternalApi classes for TableAdmin -->
<exclude>com/google/cloud/bigtable/admin/v2/BaseBigtableTableAdminClient.java</exclude>
<exclude>com/google/cloud/bigtable/admin/v2/BaseBigtableTableAdminSettings.java</exclude>
<exclude>com/google/cloud/bigtable/admin/v2/stub/GrpcBigtableTableAdminCallableFactory.java</exclude>
<exclude>com/google/cloud/bigtable/admin/v2/stub/GrpcBigtableTableAdminStub.java</exclude>
<exclude>com/google/cloud/bigtable/admin/v2/stub/BigtableTableAdminStub.java</exclude>
<exclude>com/google/cloud/bigtable/admin/v2/stub/EnhancedBigtableTableAdminStub.java</exclude>

<!-- Hide @InternalApi classes for Data -->
<exclude>com/google/cloud/bigtable/data/v2/internal/**</exclude>
<exclude>com/google/cloud/bigtable/data/v2/BaseBigtableDataClient.java</exclude>
<exclude>com/google/cloud/bigtable/data/v2/BaseBigtableDataSettings.java</exclude>
<exclude>com/google/cloud/bigtable/data/v2/stub/BigtableStub.java</exclude>
<exclude>com/google/cloud/bigtable/data/v2/stub/BigtableStubSettings.java</exclude>
<exclude>com/google/cloud/bigtable/data/v2/stub/GrpcBigtableStub.java</exclude>
<exclude>com/google/cloud/bigtable/data/v2/stub/GrpcBigtableCallableFactory.java</exclude>
<exclude>com/google/cloud/bigtable/data/v2/stub/EnhancedBigtableStub.java</exclude>
<exclude>com/google/cloud/bigtable/data/v2/stub/mutaterows/**</exclude>
<exclude>com/google/cloud/bigtable/data/v2/stub/readrows/**</exclude>
</sourceFileExcludes>

<offlineLinks>
<offlineLink>
<url>${project.javadoc.protobufBaseURL}</url>
Expand Down
36 changes: 36 additions & 0 deletions google-cloud-clients/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -796,6 +796,42 @@
<packages>com.google.cloud.compute.deprecated*</packages>
</group>
</groups>

<!-- TODO(chingor13): Remove this once we switch to per client javadoc sites -->
<sourceFileExcludes>
<!-- TODO(igorbernstein): use a custom doclet to exclude @InternalApi classes from javadoc -->
<!-- Bigtable: Hide @InternalApi classes -->
<exclude>com/google/cloud/bigtable/gaxx/**</exclude>

<!-- Bigtable: Hide @InternalApi classes for InstanceAdmin -->
<exclude>com/google/cloud/bigtable/admin/v2/internal/**</exclude>
<exclude>com/google/cloud/bigtable/admin/v2/BaseBigtableInstanceAdminClient.java</exclude>
<exclude>com/google/cloud/bigtable/admin/v2/BaseBigtableInstanceAdminSettings.java</exclude>
<exclude>com/google/cloud/bigtable/admin/v2/stub/GrpcBigtableInstanceAdminCallableFactory.java</exclude>
<exclude>com/google/cloud/bigtable/admin/v2/stub/GrpcBigtableInstanceAdminStub.java</exclude>
<exclude>com/google/cloud/bigtable/admin/v2/stub/BigtableInstanceAdminStub.java</exclude>

<!-- Bigtable: Hide @InternalApi classes for TableAdmin -->
<exclude>com/google/cloud/bigtable/admin/v2/BaseBigtableTableAdminClient.java</exclude>
<exclude>com/google/cloud/bigtable/admin/v2/BaseBigtableTableAdminSettings.java</exclude>
<exclude>com/google/cloud/bigtable/admin/v2/stub/GrpcBigtableTableAdminCallableFactory.java</exclude>
<exclude>com/google/cloud/bigtable/admin/v2/stub/GrpcBigtableTableAdminStub.java</exclude>
<exclude>com/google/cloud/bigtable/admin/v2/stub/BigtableTableAdminStub.java</exclude>
<exclude>com/google/cloud/bigtable/admin/v2/stub/EnhancedBigtableTableAdminStub.java</exclude>

<!-- Bigtable: Hide @InternalApi classes for Data -->
<exclude>com/google/cloud/bigtable/data/v2/internal/**</exclude>
<exclude>com/google/cloud/bigtable/data/v2/BaseBigtableDataClient.java</exclude>
<exclude>com/google/cloud/bigtable/data/v2/BaseBigtableDataSettings.java</exclude>
<exclude>com/google/cloud/bigtable/data/v2/stub/BigtableStub.java</exclude>
<exclude>com/google/cloud/bigtable/data/v2/stub/BigtableStubSettings.java</exclude>
<exclude>com/google/cloud/bigtable/data/v2/stub/GrpcBigtableStub.java</exclude>
<exclude>com/google/cloud/bigtable/data/v2/stub/GrpcBigtableCallableFactory.java</exclude>
<exclude>com/google/cloud/bigtable/data/v2/stub/EnhancedBigtableStub.java</exclude>
<exclude>com/google/cloud/bigtable/data/v2/stub/mutaterows/**</exclude>
<exclude>com/google/cloud/bigtable/data/v2/stub/readrows/**</exclude>
</sourceFileExcludes>

<links>
<link>https://grpc.io/grpc-java/javadoc/</link>
<link>https://developers.google.com/protocol-buffers/docs/reference/java/</link>
Expand Down