Javadoc generation issues

Open
#201 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
25/100
Issue type
Bug
Clarity
Needs clarification
Activity status
Stale
Tech stack
java
Domain
documentation

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.

Description

question

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.

Dominant language
Java
Stars
30
Forks
48
PR merge metrics
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from aws-cloudformation/cloudformation-cli-java-plugin

All issues in aws-cloudformation/cloudformation-cli-java-plugin

Similar issues

More Java issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.