Skip to content

Added missing @deprecated into existing javadocs #5405

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.

Sign up for GitHub

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

Jump to bottom
Closed
tbw777 wants to merge 1 commit into from
Closed

Added missing @deprecated into existing javadocs #5405

tbw777 wants to merge 1 commit into from

Conversation

@tbw777
Copy link
Contributor

@tbw777 tbw777 commented Feb 1, 2023

Syncing javadoc required

@mbien
Copy link
Member

mbien commented Feb 7, 2023

  • @deprecated javadoc tag is there to provide migration guidance for the API user - if the message is empty it serves no purpose.
  • @Deprecated annotation is sufficient to make it show up as deprecated in the javadoc and produce a compiler warning

This means having an empty javadoc tag serves no purpose, it should be only added to provide a meaningful message.

@mbien mbien closed this Feb 7, 2023
@mbien mbien added the Code cleanup Label for cleanup done on the Netbeans IDE label Feb 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

Code cleanup Label for cleanup done on the Netbeans IDE

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@tbw777 @mbien