Skip to content

Conversation

Marcono1234
Copy link
Contributor

@Marcono1234 Marcono1234 commented Sep 30, 2022

Adds Javadoc @since tags 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.

@Marcono1234 Marcono1234 marked this pull request as draft September 30, 2022 23:39
@Marcono1234 Marcono1234 force-pushed the marcono1234/javadoc-since-tags branch from 55914c1 to 7079be9 Compare October 1, 2022 00:35
@Marcono1234 Marcono1234 changed the title Add Javadoc @since tags for previously added elements; improve release actions Add Javadoc @since tags for previously added elements Oct 1, 2022
* <li>aURL ---&gt; A_U_R_L</li>
* </ul>
*
* @since 2.9.0
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

* @since 2.8
* {@code myobject.my.field} will result in an unintended JavaScript expression.
*
* @since 2.8.4
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ab35f11

(previous @since value was apparently incorrect)

* instance.
*
* @return a GsonBuilder instance.
* @since 2.8.3
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

* @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
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

* @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
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

* {@link Object} and {@link Number}.
*
* @see ToNumberStrategy
* @since 2.8.9
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

* @see ToNumberPolicy
* @see GsonBuilder#setObjectToNumberStrategy(ToNumberStrategy)
* @see GsonBuilder#setNumberToNumberStrategy(ToNumberStrategy)
* @since 2.8.9
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

* @return this writer.
* @throws UnsupportedOperationException if this writer does not support
* writing raw JSON values.
* @since 2.4
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

* Encodes {@code value}.
*
* @return this writer.
* @since 2.7
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

* @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
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Marcono1234 Marcono1234 marked this pull request as ready for review October 1, 2022 00:48
@eamonnmcmanus
Copy link
Member

Thanks, that's very useful!

@eamonnmcmanus eamonnmcmanus merged commit 2860908 into google:master Oct 1, 2022
@Marcono1234 Marcono1234 deleted the marcono1234/javadoc-since-tags branch October 1, 2022 23:02
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