Skip to content
This repository has been archived by the owner on Jan 15, 2022. It is now read-only.

Fix javadoc warnings generated by java 8 #162

Open
vrushalivc opened this issue Apr 11, 2017 · 3 comments · Fixed by getodk/javarosa#414
Open

Fix javadoc warnings generated by java 8 #162

vrushalivc opened this issue Apr 11, 2017 · 3 comments · Fixed by getodk/javarosa#414

Comments

@vrushalivc
Copy link
Contributor

Several warnings are generated by java 1.8 when we update to use later version of maven-javadoc-plugin to be 2.10.4 and maven-release-plugin to be 2.5.3

[ERROR] Failed to execute goal org.apache.maven.plugins:maven-javadoc-plugin:2.10.4:javadoc (default-cli) on project hraven-core: An error has occurred in JavaDocs report generation:
[ERROR] hraven/hraven-core/src/main/java/com/twitter/hraven/AppAggregationKey.java:57: error: reference not found
[ERROR] hraven/hraven-core/src/main/java/com/twitter/hraven/AppSummary.java:110: error: unknown tag: returns
[ERROR] hraven/hraven-core/src/main/java/com/twitter/hraven/AppSummary.java:124: error: identifier expected
[ERROR] hraven/hraven-core/src/main/java/com/twitter/hraven/CounterMap.java:68: error: unknown tag: emphasis
[ERROR] hraven/hraven-core/src/main/java/com/twitter/hraven/CounterMap.java:68: error: unknown tag: emphasis
[ERROR] hraven/hraven-core/src/main/java/com/twitter/hraven/HdfsStatsKey.java:86: error: @param name not found
[ERROR] hraven/hraven-core/src/main/java/com/twitter/hraven/JobDetails.java:107: error: @param name not found
[ERROR] hraven/hraven-core/src/main/java/com/twitter/hraven/JobHistoryKeys.java:13: error: reference not found
[ERROR] hraven/hraven-core/src/main/java/com/twitter/hraven/JobHistoryKeys.java:24: error: reference not found
[ERROR] hraven/hraven-core/src/main/java/com/twitter/hraven/JobId.java:102: error: @param name not found
[ERROR] hraven/hraven-core/src/main/java/com/twitter/hraven/TaskDetails.java:122: error: @param name not found
[ERROR] hraven/hraven-core/src/main/java/com/twitter/hraven/datasource/AppSummaryService.java:231: error: identifier expected
[ERROR] hraven/hraven-core/src/main/java/com/twitter/hraven/datasource/AppSummaryService.java:614: error: malformed HTML
[ERROR] hraven/hraven-core/src/main/java/com/twitter/hraven/datasource/AppSummaryService.java:72: error: reference not found
[ERROR] hraven/hraven-core/src/main/java/com/twitter/hraven/datasource/AppVersionService.java:49: error: reference not found
[ERROR] hraven/hraven-core/src/main/java/com/twitter/hraven/datasource/HdfsStatsKeyConverter.java:41: error: @param name not found
[ERROR] hraven/hraven-core/src/main/java/com/twitter/hraven/datasource/HdfsStatsService.java:64: error: reference not found
[ERROR] hraven/hraven-core/src/main/java/com/twitter/hraven/datasource/JobHistoryByIdService.java:90: error: bad use of '>'
[ERROR] hraven/hraven-core/src/main/java/com/twitter/hraven/datasource/JobHistoryByIdService.java:46: error: reference not found
[ERROR] hraven/hraven-core/src/main/java/com/twitter/hraven/datasource/JobHistoryRawService.java:382: error: reference not found
[ERROR] hraven/hraven-core/src/main/java/com/twitter/hraven/datasource/JobHistoryRawService.java:440: error: reference not found
[ERROR] hraven/hraven-core/src/main/java/com/twitter/hraven/datasource/JobHistoryRawService.java:461: error: reference not found
[ERROR] hraven/hraven-core/src/main/java/com/twitter/hraven/datasource/JobHistoryRawService.java:477: error: unknown tag: success
[ERROR] hraven/hraven-core/src/main/java/com/twitter/hraven/datasource/JobHistoryRawService.java:54: error: reference not found
[ERROR] hraven/hraven-core/src/main/java/com/twitter/hraven/datasource/MissingColumnInResultException.java:26: error: reference not found
[ERROR] hraven/hraven-core/src/main/java/com/twitter/hraven/datasource/MissingColumnInResultException.java:28: error: unterminated inline tag
[ERROR] hraven/hraven-core/src/main/java/com/twitter/hraven/rest/SerializationContext.java:159: error: bad HTML entity

@vrushalivc
Copy link
Contributor Author

Workaround is to add -Xdoclint:none as the options to javadoc in pom.

     <plugin>
        <artifactId>maven-javadoc-plugin</artifactId>
        <version>2.10.4</version>
        <configuration>
           <additionalparam>-Xdoclint:none</additionalparam>
       </configuration>
     </plugin>

@darthlynx
Copy link

Hi everyone. Still have the same problem for version 3.0.1. I use the next config:

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-javadoc-plugin</artifactId>
    <version>3.0.1</version>
    <configuration>
        <additionalparam>-Xdoclint:none</additionalparam>
    </configuration>
    <executions>
        <execution>
            <id>attach-javadoc</id>
            <goals>
                <goal>jar</goal>
            </goals>
        </execution>
    </executions>
</plugin>

Any updates about it? Thanks

@darthlynx
Copy link

Found the solution:
<additionalparam>-Xdoclint:none</additionalparam> should be replaced with <doclint>none</doclint> for version 3.0.x
Found in this thread

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants