[YARN-11380] Fix hadoop-yarn-api module Java Doc Errors

• Type: Improvement
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 3.4.0
• Fix Version/s: 3.4.0
• Component/s: yarn
• Labels: pull-request-available
• Target Version/s: 3.4.0
• Hadoop Flags: Reviewed
• Assignee: Shilun Fan
• Reporter: Shilun Fan
• Created: 20/Nov/22 14:20
• Updated: 28/Nov/22 13:28
• Resolved: 28/Nov/22 13:25

Description

When finishing YARN-11373, ps has java-doc compilation errors, I will fix all java-doc compilation errors of hadoop-yarn-api module. I will pay attention to the java doc compilation of jdk8 & jdk11 at the same time.

[ERROR] Failed to execute goal org.apache.maven.plugins:maven-javadoc-plugin:3.0.1:javadoc-no-fork (default-cli) on project hadoop-yarn-api: An error has occurred in Javadoc report generation: 
[ERROR] Exit code: 1 - javadoc: warning - You have specified the HTML version as HTML 4.01 by using the -html4 option.
[ERROR] The default is currently HTML5 and the support for HTML 4.01 will be removed
[ERROR] in a future release. To suppress this warning, please ensure that any HTML constructs
[ERROR] in your comments are valid in HTML5, and remove the -html4 option.
[ERROR] /home/jenkins/jenkins-home/workspace/hadoop-multibranch_PR-5146/ubuntu-focal/src/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/ApplicationBaseProtocol.java:97: warning: no description for @throws
[ERROR]    * @throws YarnException
[ERROR]      ^
[ERROR] /home/jenkins/jenkins-home/workspace/hadoop-multibranch_PR-5146/ubuntu-focal/src/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/ApplicationBaseProtocol.java:98: warning: no description for @throws
[ERROR]    * @throws IOException
[ERROR]      ^
[ERROR] /home/jenkins/jenkins-home/workspace/hadoop-multibranch_PR-5146/ubuntu-focal/src/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/ApplicationBaseProtocol.java:129: warning: no description for @throws
[ERROR]    * @throws YarnException
[ERROR]      ^
[ERROR] /home/jenkins/jenkins-home/workspace/hadoop-multibranch_PR-5146/ubuntu-focal/src/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/ApplicationBaseProtocol.java:130: warning: no description for @throws
[ERROR]    * @throws IOException 

Issue Links

• links to: GitHub Pull Request #5152