Skip to content

Add JavadocTagOrder recipe for AtclauseOrder - #951

Open
habiibullahm wants to merge 2 commits into
openrewrite:mainfrom
habiibullahm:feature/javadoc-tag-order-283
Open

Add JavadocTagOrder recipe for AtclauseOrder#951
habiibullahm wants to merge 2 commits into
openrewrite:mainfrom
habiibullahm:feature/javadoc-tag-order-283

Conversation

@habiibullahm

@habiibullahm habiibullahm commented Jul 25, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Add JavadocTagOrder recipe that reorders Javadoc block tags to match Checkstyle AtclauseOrder / Oracle recommended order
  • Covers the issue example: @param / @author / @since@author / @param / @since
  • Preserve relative order among tags of the same kind (e.g. multiple @param)

Closes #283

Testing

  • ./gradlew test --tests JavadocTagOrderTest
  • CI build is green

Notes

Ready for review. Happy to iterate on feedback.

Reorder Javadoc block tags into Oracle/Checkstyle default order
(@author, @Version, @param, @return, @throws, ...).

Closes openrewrite#283

Co-authored-by: Cursor <cursoragent@cursor.com>
@habiibullahm

Copy link
Copy Markdown
Contributor Author

Hi @timtebeek — draft PR for #283 with tests + JavadocTagOrder recipe (Checkstyle AtclauseOrder default order).
Happy to iterate on review feedback. Thanks!

@habiibullahm
habiibullahm marked this pull request as ready for review July 25, 2026 08:18
Co-authored-by: Cursor <cursoragent@cursor.com>
@habiibullahm

Copy link
Copy Markdown
Contributor Author

CI failure on 04aa9fd looks unrelated to this recipe: all 9 failures were existing *TypeScript() tests with JSON-RPC peer closed the stream (e.g. RemoveSelfAssignmentTest.removeSelfAssignmentTypeScript). JavadocTagOrderTest did not fail.

Pushed an empty commit to retrigger CI.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: In Progress

Development

Successfully merging this pull request may close these issues.

Modifier order of javadoc tags

1 participant