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

move deprecation annotations to class level #534

Merged
merged 4 commits into from
Aug 4, 2023

Conversation

wboereboom
Copy link
Contributor

Description
move deprecation annotations to class level so more IDE's will handle and show deprecation correctly.

@wboereboom wboereboom requested a review from a team as a code owner August 2, 2023 14:11
@wboereboom
Copy link
Contributor Author

@peterojo Does this solve your issue?

@jillingk
Copy link
Contributor

jillingk commented Aug 2, 2023

I think it might be nice to use * {@link newMethod()} in the annotation to link to the new methods?

@wboereboom
Copy link
Contributor Author

How about @see?

@jillingk
Copy link
Contributor

jillingk commented Aug 2, 2023

How about @see?

I think link is better as @see shows up as "see also" in my IDEA which I guess is better for related classes/methods. If you use link in the deprecation message they will see deprecated with a link next to it to the class they should use instead

@sonarcloud
Copy link

sonarcloud bot commented Aug 3, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

warning The version of Java (11.0.20) you have used to run this analysis is deprecated and we will stop accepting it soon. Please update to at least Java 17.
Read more here

@jillingk jillingk merged commit fc5ecf3 into develop Aug 4, 2023
5 checks passed
@jillingk jillingk deleted the update_deprecation_annotations branch August 4, 2023 09:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants