Improve documentation #2193
Merged
Improve documentation #2193
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Marcono1234
commented
Sep 9, 2022
| @@ -17,11 +17,8 @@ | |||
| package com.google.gson; | |||
|
|
|||
| /** | |||
| * A strategy (or policy) definition that is used to decide whether or not a field or top-level | |||
| * class should be serialized or deserialized as part of the JSON output/input. For serialization, | |||
There was a problem hiding this comment.
Have moved some of this documentation to GsonBuilder because there (or rather in the internal Excluder) class this logic is implemented.
| /** | ||
| * Returns whether the other object is equal to this. This method only considers | ||
| * the other object to be equal if it is an instance of {@code JsonPrimitive} and | ||
| * has an equal value. |
There was a problem hiding this comment.
I did not want to describe in detail how number comparison is performed because there are multiple open issues which show that there are potential flaws with the current logic.
|
This all looks great. Thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Improves Javadoc of multiple classes and adjusts the User Guide; some changes are based on the documentation changes in #2189.