-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Split javadocs #5019
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.
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
Split javadocs #5019
Conversation
Codecov Report
@@ Coverage Diff @@
## master #5019 +/- ##
============================================
+ Coverage 50.32% 50.32% +<.01%
+ Complexity 23680 23673 -7
============================================
Files 2238 2238
Lines 226060 226060
Branches 24955 24959 +4
============================================
+ Hits 113766 113768 +2
+ Misses 103689 103688 -1
+ Partials 8605 8604 -1
Continue to review full report at Codecov.
|
Codecov Report
@@ Coverage Diff @@
## master #5019 +/- ##
=========================================
Coverage 50.4% 50.4%
- Complexity 23785 23800 +15
=========================================
Files 2251 2251
Lines 226791 226791
Branches 24966 24961 -5
=========================================
Hits 114320 114320
Misses 103864 103864
Partials 8607 8607Continue to review full report at Codecov.
|
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 (googleapis#5019)
) 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)
|
@chingor13, this PR is a bit stale. |
|
I think reorganizing the clients will supersede this PR. |
…035) 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 (googleapis/google-cloud-java#5019)
This PR splits the javadoc generation into per-artifact minisites. The publish_javadoc kokoro job will now publish each artifact's javadocs separately (and fix linking between all the javadoc sites).
This is not compatible with our current format of aggregating the javadocs into google-api-grpc and google-cloud-clients javadocs. The resulting docs should be better targeted and more usable.