aws-cloudformation / aws-cloudformation/cloudformation-cli-java-plugin
Javadoc generation issues
Open
question
- Dominant language
- Java
- Stars
- 30
- Forks
- 48
- PR merge metrics
- No merged PRs in 30d
Description
Some problematic errors when generating javadocs around code block tags and referencing a getter generated by lombok. The @apiNote tag also is not working correctly.
Contributor guide
Research direction
Start by reproducing Javadoc generation for the cases named in the issue: code block tags, a reference to a Lombok-generated getter, and the @apiNote tag. Inspect the generated documentation and error output; done means all three cases generate correctly without errors.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100