-
Notifications
You must be signed in to change notification settings - Fork 269
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
Update custom Doclet configuration for javadoc #587
Conversation
From version 3.0 and up `javadoc` has updated parameter names used in custom Doclet configurations, which affects our internal devsite scripts. This PR updates the config to use the new parameters names.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for putting this together. Just one suggestion.
Looks like line 87 still uses the current config name. Updated the rest. Thanks! |
Thanks. May be we can remove that profile entirely, and just merge the configuration with the rest? It's reasonable to require jdk 1.8 or higher for all build and release tasks: <profile>
<!-- Disable Doclint on Java 8 and higher -->
<id>disable-java8-doclint</id>
<activation>
<jdk>[1.8,)</jdk>
</activation>
<properties>
<additionalparam>-Xdoclint:none</additionalparam>
</properties>
</profile> |
Updated and dropped this profile. |
-warning 101 | ||
</additionalparam> | ||
<additionalOptions> | ||
<additionalOption>-hdf book.path /docs/reference/_book.yaml</additionalOption> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We need to pass the -Xdoclint:none
option here too. Earlier it was provided by the profile whenever JDK 1.8 was available. Now we have to explicitly set it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks! Added <doclint>none</doclint>
719e17e
to
113f21c
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM with a suggestion.
</additionalparam> | ||
<additionalOptions> | ||
<additionalOption>-warning 101</additionalOption> | ||
</additionalOptions> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Probably need doclint:none here too.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated. Thanks!
javadoc
uses updated parameter names in custom Doclet configurations, which affects our internal devsite scripts.