Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Missing consistent order of Javadoc tags #3469

Open
scordio opened this issue May 10, 2024 · 0 comments
Open

Missing consistent order of Javadoc tags #3469

scordio opened this issue May 10, 2024 · 0 comments
Labels
status: ideal for contribution An issue that a contributor can help us with theme: documentation An issue related to documentation

Comments

@scordio
Copy link
Member

scordio commented May 10, 2024

According to Oracle, the Javadoc order of tags should be the following:

  • @author
  • @version
  • @param
  • @return
  • @exception / @throws
  • @see
  • @since
  • @serial
  • @deprecated

Other than fixing the existing order, we should have an automated way to enforce it, maybe via Spotless or the maven-javadoc-plugin.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status: ideal for contribution An issue that a contributor can help us with theme: documentation An issue related to documentation
Projects
None yet
Development

No branches or pull requests

2 participants