[
https://issues.apache.org/jira/browse/LENS-1485?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16266438#comment-16266438
]
Raju Bairishetti edited comment on LENS-1485 at 11/27/17 6:46 AM:
------------------------------------------------------------------
One workaround is disabling the *doclint* rules checker in the 2.7 release
{noformat}
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>${javadoc.plugin.version}</version>
<configuration>
<additionalparam>-Xdoclint:none</additionalparam>
</configuration>
</plugin>
{noformat}
Proper fix:
Fixing the existing javadoc warnings and errors in all the files.
To avoid new javadoc errors, We should add javadoc plugin to build section so
that build itself validates the javadocs generation. Build shoul be failed in
case of errors in generating javadocs(i.e enabling <failOnError> ).
{noformat} <plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>${javadoc.plugin.version}</version>
<configuration>
<failOnError>true</failOnError>
</configuration>
</plugin>
{noformat}
was (Author: raju.bairishetti):
One workaround is disabling the *doclint* rules checker in the 2.7 release
{noformat}
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>${javadoc.plugin.version}</version>
<configuration>
<additionalparam>-Xdoclint:none</additionalparam>
</configuration>
</plugin>
{noformat}
Proper fix:
We should add javadoc plugin to build section so that build it self validates
the javadocs generation. Build shoul be failed in case of errors in generating
javadocs(i.e enabling <failOnError> ).
{noformat} <plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>${javadoc.plugin.version}</version>
<configuration>
<failOnError>true</failOnError>
</configuration>
</plugin>
{noformat}
> Fix javadocs errors and warnings
> ---------------------------------
>
> Key: LENS-1485
> URL: https://issues.apache.org/jira/browse/LENS-1485
> Project: Apache Lens
> Issue Type: Bug
> Components: build
> Reporter: Raju Bairishetti
>
> Right now, we are building and running Lens on only on java8 and higher
> versions. We are not able to generate javadocs with java8 due to some new
> rules/constraints on javadocs.
> Creating this jira for fixing the javadoc errors and warnings. We should fail
> the build( <failOnError> ) in case of any errors while generating javadocs.
--
This message was sent by Atlassian JIRA
(v6.4.14#64029)
