Skip to content
This repository was archived by the owner on May 8, 2026. It is now read-only.

chore(doc): fix documentation on cloud.google.com to not show internal classes #1554

Merged
gcf-merge-on-green merged 8 commits into from
Dec 15, 2022
Merged

chore(doc): fix documentation on cloud.google.com to not show internal classes #1554

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
c8607b9
chore(doc): fix documentation on cloud.google.com to not show interna…
mutianf Dec 14, 2022
15b5403
update
mutianf Dec 14, 2022
aa7e090
clean up
mutianf Dec 14, 2022
616c93d
fix path
mutianf Dec 14, 2022
5d8d810
add some comments
mutianf Dec 14, 2022
efa0bb7
clean up more
mutianf Dec 14, 2022
b236c01
update comment
mutianf Dec 14, 2022
db824c9
🦉 Updates from OwlBot post-processor
gcf-owl-bot[bot] Dec 14, 2022
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
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,13 +56,13 @@ implementation 'com.google.cloud:google-cloud-bigtable'
If you are using Gradle without BOM, add this to your dependencies:

```Groovy
implementation 'com.google.cloud:google-cloud-bigtable:2.17.0'
implementation 'com.google.cloud:google-cloud-bigtable:2.17.1'
```

If you are using SBT, add this to your dependencies:

```Scala
libraryDependencies += "com.google.cloud" % "google-cloud-bigtable" % "2.17.0"
libraryDependencies += "com.google.cloud" % "google-cloud-bigtable" % "2.17.1"
```

## Authentication
Expand Down
13 changes: 12 additions & 1 deletion pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -245,6 +245,7 @@
</executions>

<configuration>
<!-- This is the old way of publishing the doc to googleapis.dev -->
<doclint>none</doclint>
<show>protected</show>
<nohelp>true</nohelp>
Expand Down Expand Up @@ -318,16 +319,26 @@
<artifactId>maven-javadoc-plugin</artifactId>
<version>3.4.1</version>
<configuration>
<!-- This is the new way of publishing the doc to cloud.google.com -->
<doclet>com.microsoft.doclet.DocFxDoclet</doclet>
<useStandardDocletOptions>false</useStandardDocletOptions>
<docletPath>${env.KOKORO_GFILE_DIR}/java-docfx-doclet-1.5.0.jar</docletPath>
<additionalOptions>
-outputpath ${project.build.directory}/docfx-yml
-projectname ${artifactId}
<!-- List of excluded packages as regex, separated by a colon-->
-excludeclasses com\.google\.cloud\.bigtable\.admin\.v2\.internal\.:com\.google\.cloud\.bigtable\.admin\.v2\.BaseBigtableInstanceAdminClient:com\.google\.cloud\.bigtable\.admin\.v2\.BaseBigtableInstanceAdminSettings:com\.google\.cloud\.bigtable\.admin\.v2\.stub\.GrpcBigtableInstanceAdminCallableFactory:com\.google\.cloud\.bigtable\.admin\.v2\.stub\.GrpcBigtableInstanceAdminStub:com\.google\.cloud\.bigtable\.admin\.v2\.stub\.BigtableInstanceAdminStub:com\.google\.cloud\.bigtable\.admin\.v2\.BaseBigtableTableAdminClient:com\.google\.cloud\.bigtable\.admin\.v2\.BaseBigtableTableAdminSettings:com\.google\.cloud\.bigtable\.admin\.v2\.stub\.GrpcBigtableTableAdminCallableFactory:com\.google\.cloud\.bigtable\.admin\.v2\.stub\.GrpcBigtableTableAdminStub:com\.google\.cloud\.bigtable\.admin\.v2\.stub\.BigtableTableAdminStub:com\.google\.cloud\.bigtable\.admin\.v2\.stub\.EnhancedBigtableTableAdminStub:com\.google\.cloud\.bigtable\.data\.v2\.internal\.:com\.google\.cloud\.bigtable\.data\.v2\.BaseBigtableDataClient:com\.google\.cloud\.bigtable\.data\.v2\.BaseBigtableDataSettings:com\.google\.cloud\.bigtable\.data\.v2\.stub\.BigtableStub:com\.google\.cloud\.bigtable\.data\.v2\.stub\.BigtableStubSettings:com\.google\.cloud\.bigtable\.data\.v2\.stub\.GrpcBigtableStub:com\.google\.cloud\.bigtable\.data\.v2\.stub\.GrpcBigtableCallableFactory:com\.google\.cloud\.bigtable\.data\.v2\.stub\.EnhancedBigtableStub:com\.google\.cloud\.bigtable\.data\.v2\.stub\.mutaterows\.:com\.google\.cloud\.bigtable\.data\.v2\.stub\.readrows\.:com\.google\.cloud\.bigtable\.data\.v2\.stub\.metrics\.
<!-- Exclude generating javadocs for internal implementations for admin and data, which
are under internal/ and .v2.stub/, and exclude all BaseClients and BaseSettings.
The only exception is we want to keep the javadoc for StubSettings. -->
-excludeclasses com\.google\.cloud\.bigtable\.admin\.v2\.(internal\.|(Base.*).*|stub\.(?!Bigtable.*StubSettings).*):com\.google\.cloud\.bigtable\.data\.v2\.(internal\.|(Base.*).*|stub\.(?!Enhanced.*StubSettings).*)
<!-- Exclude the javadocs for the auto-generated raw protos since we don't expose them.
The raw protos generated by gapic are under com.google.bigtable. And the public surface
is under com.google.cloud.bigtable. Also exclude the stats package which is the
internal implementation for metrics. -->
-excludepackages com\.google\.(bigtable\.v2|bigtable\.admin\.v2|cloud\.bigtable\.stats)
</additionalOptions>
</configuration>

<executions>
<execution>
<id>aggregate</id>
Expand Down