[AMBARI-24835] Fix javadoc errors in ambari-utility

• Type: Bug
• Status: Resolved
• Priority: Minor
• Resolution: Fixed
• Fix Version/s: trunk
• Labels: pull-request-available
• Epic Link: Code cleanup
• Assignee: Attila Doroszlai
• Reporter: Attila Doroszlai
• Created: 26/Oct/18 17:47
• Updated: 26/Oct/18 20:06
• Resolved: 26/Oct/18 20:04

Description

Fix the following javadoc errors in ambari-utility:

[ERROR] Failed to execute goal org.apache.maven.plugins:maven-javadoc-plugin:3.0.1:jar (attach-javadocs) on project ambari-utility: MavenReportException: Error while generating Javadoc:
[ERROR] Exit code: 1 - ambari-utility/src/main/java/org/apache/ambari/annotations/SwaggerOverwriteNestedAPI.java:28: error: reference not found
[ERROR]  * {@link org.apache.ambari.swagger.NestedApiRecord} when {@link org.apache.ambari.swagger.AmbariSwaggerReader}
[ERROR]           ^
[ERROR] ambari-utility/src/main/java/org/apache/ambari/annotations/SwaggerOverwriteNestedAPI.java:42: warning: no description for @return
[ERROR]      * @return
[ERROR]        ^
[ERROR] ambari-utility/src/main/java/org/apache/ambari/annotations/SwaggerOverwriteNestedAPI.java:48: warning: no description for @return
[ERROR]      * @return
[ERROR]        ^
[ERROR] ambari-utility/src/main/java/org/apache/ambari/annotations/SwaggerOverwriteNestedAPI.java:54: warning: no description for @return
[ERROR]      * @return
[ERROR]        ^
[ERROR] ambari-utility/src/main/java/org/apache/ambari/annotations/SwaggerOverwriteNestedAPI.java:60: warning: no description for @return
[ERROR]      * @return
[ERROR]        ^
[ERROR] ambari-utility/src/main/java/org/apache/ambari/annotations/SwaggerPreferredParent.java:37: warning: no description for @return
[ERROR]      * @return
[ERROR]        ^

Issue Links

• links to: GitHub Pull Request #2523