palantir / palantir/palantir-java-format
idea plugin won't format javadoc
Open
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 907
- Forks
- 101
- Avg merge
- 1d 3h
- Merged PRs (30d)
- 19
Description
What happened?
idea plugin won't format javadoc. e.g. a single line javadoc for a field description is way more than 120 long. On format, it formats all the java code but won't wrap the long javadoc.
What did you want to happen?
the idea plugin formats javadoc
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
Reproduce the issue in the IDEA plugin with a single-line Javadoc field description longer than 120 characters. Start by tracing the plugin's formatting entry point and compare Javadoc handling with Java-code formatting. Done means formatting wraps the long Javadoc while continuing to format the surrounding Java code.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100