Comments in generated java objects may not be javadoc compliant
Open
Nobody has claimed this yet.
- Dominant language
- Kotlin
- Stars
- 217
- Forks
- 116
- PR merge metrics
- No merged PRs in 30d
Description
Here is an example of a comment in a generated java file:
created_at:<now
- created_at:<=2024 |
when javadoc:jar is executed it will result in:
error: malformed HTML
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 reproducing the malformed HTML with the generated Java example and the javadoc:jar command. Trace where the generator emits comments containing <now and <=2024, then verify that generated comments are valid Javadoc and javadoc:jar completes without the malformed HTML error.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, kotlin
- Domain
- tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100