Skip to content

Clean up comments, add suppressWarning annotation#606

Merged
stleary merged 2 commits intostleary:masterfrom
artem-smotrakov:fix-javadoc
Aug 18, 2021
Merged

Clean up comments, add suppressWarning annotation#606
stleary merged 2 commits intostleary:masterfrom
artem-smotrakov:fix-javadoc

Conversation

@artem-smotrakov
Copy link
Copy Markdown
Contributor

This pull request addresses several issues in Javadoc formatting that were reported on LGTM

https://lgtm.com/projects/g/stleary/JSON-java/alerts?mode=tree

This also suppresses the "Equals method does not inspect argument type" alert by adding a SuppressWarning annotation. This alert looks like a false positive. In fact, object == this implicitly check argument type -- if object's and this's types are different, the condition would be false.

@stleary
Copy link
Copy Markdown
Owner

stleary commented Aug 14, 2021

What problem does this code solve?
Fixes some warnings in case we decide to use LGTM

Risks
Minimal

Changes to the API?
No

Will this require a new release?
No

Should the documentation be updated?
No

Does it break the unit tests?
No

Was any code refactored in this commit?
No

Review status
APPROVED

@stleary
Copy link
Copy Markdown
Owner

stleary commented Aug 14, 2021

Starting 3 day comment window

@stleary stleary merged commit fb71d9d into stleary:master Aug 18, 2021
@artem-smotrakov artem-smotrakov deleted the fix-javadoc branch August 18, 2021 07:57
@stleary stleary changed the title Fix javadoc Clean up comments, add suppressWarning annotation Dec 5, 2021
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.

2 participants