Add Javadoc @since tags for previously added elements - #2211
Merged
eamonnmcmanus merged 1 commit intoOct 1, 2022
Conversation
Marcono1234
marked this pull request as draft
September 30, 2022 23:39
Marcono1234
force-pushed
the
marcono1234/javadoc-since-tags
branch
from
October 1, 2022 00:35
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
| * <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 |
Contributor
Author
There was a problem hiding this comment.
(previous @since value was apparently incorrect)
| * instance. | ||
| * | ||
| * @return a GsonBuilder instance. | ||
| * @since 2.8.3 |
| * @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 |
| * @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 |
| * {@link Object} and {@link Number}. | ||
| * | ||
| * @see ToNumberStrategy | ||
| * @since 2.8.9 |
| * @see ToNumberPolicy | ||
| * @see GsonBuilder#setObjectToNumberStrategy(ToNumberStrategy) | ||
| * @see GsonBuilder#setNumberToNumberStrategy(ToNumberStrategy) | ||
| * @since 2.8.9 |
| * @return this writer. | ||
| * @throws UnsupportedOperationException if this writer does not support | ||
| * writing raw JSON values. | ||
| * @since 2.4 |
| * Encodes {@code value}. | ||
| * | ||
| * @return this writer. | ||
| * @since 2.7 |
| * @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 |
Marcono1234
marked this pull request as ready for review
October 1, 2022 00:48
Member
|
Thanks, that's very useful! |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.