Add Javadoc @since tags for previously added elements
#2211
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
force-pushed
the
marcono1234/javadoc-since-tags
branch
from
55914c1
to
7079be9
Compare
Marcono1234
changed the title
@since tags for previously added elements; improve release actions@since tags for previously added elements
Marcono1234
commented
Oct 1, 2022
| @@ -86,6 +86,8 @@ public enum FieldNamingPolicy implements FieldNamingStrategy { | |||
| * <li>aStringField ---> A_STRING_FIELD</li> | |||
| * <li>aURL ---> A_U_R_L</li> | |||
| * </ul> | |||
| * | |||
| * @since 2.9.0 | |||
| * @since 2.8 | ||
| * {@code myobject.my.field} will result in an unintended JavaScript expression. | ||
| * | ||
| * @since 2.8.4 |
There was a problem hiding this comment.
(previous @since value was apparently incorrect)
| @@ -343,6 +343,7 @@ public Gson() { | |||
| * instance. | |||
| * | |||
| * @return a GsonBuilder instance. | |||
| * @since 2.8.3 | |||
| @@ -364,6 +364,7 @@ public GsonBuilder setFieldNamingStrategy(FieldNamingStrategy fieldNamingStrateg | |||
| * @param objectToNumberStrategy the actual object-to-number strategy | |||
| * @return a reference to this {@code GsonBuilder} object to fulfill the "Builder" pattern | |||
| * @see ToNumberPolicy#DOUBLE The default object-to-number strategy | |||
| * @since 2.8.9 | |||
| @@ -376,6 +377,7 @@ public GsonBuilder setObjectToNumberStrategy(ToNumberStrategy objectToNumberStra | |||
| * @param numberToNumberStrategy the actual number-to-number strategy | |||
| * @return a reference to this {@code GsonBuilder} object to fulfill the "Builder" pattern | |||
| * @see ToNumberPolicy#LAZILY_PARSED_NUMBER The default number-to-number strategy | |||
| * @since 2.8.9 | |||
|
|
||
| /** | ||
| * An enumeration that defines two standard number reading strategies and a couple of | ||
| * strategies to overcome some historical Gson limitations while deserializing numbers as | ||
| * {@link Object} and {@link Number}. | ||
| * | ||
| * @see ToNumberStrategy | ||
| * @since 2.8.9 |
| @@ -56,6 +55,7 @@ | |||
| * @see ToNumberPolicy | |||
| * @see GsonBuilder#setObjectToNumberStrategy(ToNumberStrategy) | |||
| * @see GsonBuilder#setNumberToNumberStrategy(ToNumberStrategy) | |||
| * @since 2.8.9 | |||
| @@ -429,6 +429,7 @@ public JsonWriter value(String value) throws IOException { | |||
| * @return this writer. | |||
| * @throws UnsupportedOperationException if this writer does not support | |||
| * writing raw JSON values. | |||
| * @since 2.4 | |||
| @@ -475,6 +476,7 @@ public JsonWriter value(boolean value) throws IOException { | |||
| * Encodes {@code value}. | |||
| * | |||
| * @return this writer. | |||
| * @since 2.7 | |||
| @@ -495,6 +497,7 @@ public JsonWriter value(Boolean value) throws IOException { | |||
| * @return this writer. | |||
| * @throws IllegalArgumentException if the value is NaN or Infinity and this writer is not {@link | |||
| * #setLenient(boolean) lenient}. | |||
| * @since 2.9.1 | |||
|
Thanks, that's very useful! |
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.
Adds Javadoc
@sincetags for elements which were added in previous releases and do not have this tag yet. I have also added review comments below referring to the relevant commits where these elements were added.