Skip to content

Update custom Doclet configuration for javadoc #587

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
merged 5 commits into from
Sep 22, 2021
Merged

Update custom Doclet configuration for javadoc #587

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
463e685
Update custom Doclet configuration for javadoc
lahirumaramba Aug 13, 2021
a72d867
Update other param instances
lahirumaramba Aug 20, 2021
496beb9
remove java 8 exception
lahirumaramba Sep 22, 2021
113f21c
Add -Xdoclint:none option
lahirumaramba Sep 22, 2021
8452c9d
Added <doclint>none</doclint>
lahirumaramba Sep 22, 2021
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
38 changes: 15 additions & 23 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,16 +77,6 @@
</distributionManagement>

<profiles>
<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>
<profile>
<id>devsite-apidocs</id>
<activation>
Expand Down Expand Up @@ -123,18 +113,19 @@
<version>1.3</version>
</additionalDependency>
</additionalDependencies>
<additionalparam>
-hdf book.path /docs/reference/_book.yaml
-hdf project.path /_project.yaml
-hdf devsite.path /docs/reference/admin/java/reference/
-d ${project.build.directory}/apidocs
-templatedir ${devsite.template}
-toroot /docs/reference/admin/java/reference/
-yaml _toc.yaml
-warning 101
</additionalparam>
<additionalOptions>
<additionalOption>-hdf book.path /docs/reference/_book.yaml</additionalOption>
Copy link
Contributor

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.

Copy link
Member Author

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>

<additionalOption>-hdf project.path /_project.yaml</additionalOption>
<additionalOption>-hdf devsite.path /docs/reference/admin/java/reference/</additionalOption>
<additionalOption>-d ${project.build.directory}/apidocs</additionalOption>
<additionalOption>-templatedir ${devsite.template}</additionalOption>
<additionalOption>-toroot /docs/reference/admin/java/reference/</additionalOption>
<additionalOption>-yaml _toc.yaml</additionalOption>
<additionalOption>-warning 101</additionalOption>
</additionalOptions>
<useStandardDocletOptions>false</useStandardDocletOptions>
<additionalJOption>-J-Xmx1024m</additionalJOption>
<doclint>none</doclint>
</configuration>
</plugin>
<plugin>
Expand Down Expand Up @@ -334,11 +325,12 @@
<version>1.3</version>
</additionalDependency>
</additionalDependencies>
<additionalparam>
-warning 101
</additionalparam>
<additionalOptions>
<additionalOption>-warning 101</additionalOption>
</additionalOptions>
Copy link
Contributor

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.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated. Thanks!

<useStandardDocletOptions>false</useStandardDocletOptions>
<additionalJOption>-J-Xmx1024m</additionalJOption>
<doclint>none</doclint>
</configuration>
</plugin>

Expand Down