Skip to content

Commit 3e5ad15

Browse files
authored
chore(doc): fix documentation on cloud.google.com to not show internal classes (#1554)
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly: - [ ] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/java-bigtable/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea - [ ] Ensure the tests and linter pass - [ ] Code coverage does not decrease (if any source code was changed) - [ ] Appropriate docs were updated (if necessary) Fixes #<issue_number_goes_here> ☕️ If you write sample code, please follow the [samples format]( https://github.com/GoogleCloudPlatform/java-docs-samples/blob/main/SAMPLE_FORMAT.md).
1 parent 1b2ba59 commit 3e5ad15

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

pom.xml

+12-1
Original file line numberDiff line numberDiff line change
@@ -245,6 +245,7 @@
245245
</executions>
246246

247247
<configuration>
248+
<!-- This is the old way of publishing the doc to googleapis.dev -->
248249
<doclint>none</doclint>
249250
<show>protected</show>
250251
<nohelp>true</nohelp>
@@ -318,16 +319,26 @@
318319
<artifactId>maven-javadoc-plugin</artifactId>
319320
<version>3.4.1</version>
320321
<configuration>
322+
<!-- This is the new way of publishing the doc to cloud.google.com -->
321323
<doclet>com.microsoft.doclet.DocFxDoclet</doclet>
322324
<useStandardDocletOptions>false</useStandardDocletOptions>
323325
<docletPath>${env.KOKORO_GFILE_DIR}/java-docfx-doclet-1.5.0.jar</docletPath>
324326
<additionalOptions>
325327
-outputpath ${project.build.directory}/docfx-yml
326328
-projectname ${artifactId}
327329
<!-- List of excluded packages as regex, separated by a colon-->
328-
-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\.
330+
<!-- Exclude generating javadocs for internal implementations for admin and data, which
331+
are under internal/ and .v2.stub/, and exclude all BaseClients and BaseSettings.
332+
The only exception is we want to keep the javadoc for StubSettings. -->
333+
-excludeclasses com\.google\.cloud\.bigtable\.admin\.v2\.(internal\.|(Base.*).*|stub\.(?!Bigtable.*StubSettings).*):com\.google\.cloud\.bigtable\.data\.v2\.(internal\.|(Base.*).*|stub\.(?!Enhanced.*StubSettings).*)
334+
<!-- Exclude the javadocs for the auto-generated raw protos since we don't expose them.
335+
The raw protos generated by gapic are under com.google.bigtable. And the public surface
336+
is under com.google.cloud.bigtable. Also exclude the stats package which is the
337+
internal implementation for metrics. -->
338+
-excludepackages com\.google\.(bigtable\.v2|bigtable\.admin\.v2|cloud\.bigtable\.stats)
329339
</additionalOptions>
330340
</configuration>
341+
331342
<executions>
332343
<execution>
333344
<id>aggregate</id>

0 commit comments

Comments
 (0)