openrewrite / openrewrite/rewrite-static-analysis
Modifier order of javadoc tags
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 62
- Forks
- 112
- Avg merge
- 1d 19h
- Merged PRs (30d)
- 40
Description
What problem are you trying to solve?
Lets imagine you have wrong class javadoc like this:
/**
* @param <T>
* type of product
* @author John
* @since 2020.1.0
*/
Checkstyle tell this violates https://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html#CHDBEFIF
Describe the solution you'd like
I would like to have recipe which corrects the order of the javadoc tags
Have you considered any alternatives or workarounds?
Manual fixing all these files.
Additional context
May org.openrewrite.staticanalysis.ModifierOrder could be used as a base?
Are you interested in [contributing this feature to OpenRewrite]
(https://github.com/openrewrite/.github/blob/main/CONTRIBUTING.md#new-features)?
I would like to try it :)
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
Read org.openrewrite.staticanalysis.ModifierOrder as the proposed base and trace how its recipe and tests are organized. Implement the Javadoc-tag ordering recipe described in the issue, then add coverage showing that the sample tags are reordered according to the linked Javadoc rule.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 62/100