jakartaee / jakartaee/persistence
javadoc compilation prints out warnings on JDK8
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 268
- Forks
- 78
- Avg merge
- 1d 6h
- Merged PRs (30d)
- 13
Description
Javadoc generation currently reports 441 warnings on JDK 8, it would be nice to get this to 0 warnings
```
[javadoc] /Users/lukas/development/eclipselink/javax.persistence/src/javax/persistence/criteria/Subquery.java:178: warning: no @param for
[javadoc] MapJoin correlate(MapJoin parentMap);
[javadoc]^
[javadoc] 441 warnings
```
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by running the Javadoc generation on JDK 8 and reviewing the warning output, including the example in javax.persistence/criteria/Subquery.java. Identify the documented declarations responsible for the warnings and update the Javadoc until the generation reports zero warnings.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100