[
https://issues.apache.org/jira/browse/HADOOP-18616?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17683631#comment-17683631
]
ASF GitHub Bot commented on HADOOP-18616:
-----------------------------------------
snmvaughan opened a new pull request, #5344:
URL: https://github.com/apache/hadoop/pull/5344
### Description of PR
Add JavaDoc comments to package-info.java to avoid errors resulting from the
use of Hadoop annotations.
### How was this patch tested?
Running JavaDoc using Java 11 in an Hadoop development environment docker
image.
```
mvn -Ptest-patch -Pdocs -DskipTests clean process-sources
javadoc:javadoc-no-fork -DskipTests=true
```
These changes eliminate the JavaDoc errors.
### For code changes:
- [X] Does the title or this PR starts with the corresponding JIRA issue id
(e.g. 'HADOOP-17799. Your PR title ...')?
- [ ] Object storage: have the integration tests been executed and the
endpoint declared according to the connector-specific documentation?
- [ ] If adding new dependencies to the code, are these dependencies
licensed in a way that is compatible for inclusion under [ASF
2.0](http://www.apache.org/legal/resolved.html#category-a)?
- [ ] If applicable, have you updated the `LICENSE`, `LICENSE-binary`,
`NOTICE-binary` files?
> Java 11 JavaDoc fails due to missing package comments
> -----------------------------------------------------
>
> Key: HADOOP-18616
> URL: https://issues.apache.org/jira/browse/HADOOP-18616
> Project: Hadoop Common
> Issue Type: Improvement
> Components: common
> Affects Versions: 3.4.0, 3.3.5, 3.3.9
> Environment: Yetus Java 11 OpenJDK JavaDoc
> Reporter: Steve Vaughan
> Assignee: Steve Vaughan
> Priority: Major
> Fix For: 3.4.0, 3.3.9
>
>
> Submissions to `hadoop-common` fail in Yetus due to Java 11 JavaDoc errors:
> ```
> [ERROR]
> /home/builder/src/hadoop/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/util/concurrent/package-info.java:21:
> error: unknown tag: InterfaceAudience.Private
> [ERROR] @InterfaceAudience.Private
> [ERROR] ^
> [ERROR]
> /home/builder/src/hadoop/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/util/concurrent/package-info.java:22:
> error: unknown tag: InterfaceStability.Unstable
> [ERROR] @InterfaceStability.Unstable
> [ERROR] ^
> ```
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
