palantir / palantir/palantir-java-format
Please expose option to format JavaDoc
Open
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 907
- Forks
- 101
- Avg merge
- 1d 3h
- Merged PRs (30d)
- 19
Description
In https://github.com/palantir/palantir-java-format/pull/152 you've disabled the formatting of JavaDoc by hardcoding a "false" value.
Google-Java-Format provides a command-line switch (and API) to enable/disable the formatting of JavaDoc. I would like you to do the same :)
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 reviewing pull request #152 and the code path where JavaDoc formatting is hardcoded to false. Compare Google-Java-Format's command-line switch and API to determine the corresponding option here. Done means callers can enable or disable JavaDoc formatting through both interfaces, with behavior matching the selected option.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- api, cli, tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100