RFR: 8332103: since-checker - Add missing @ since tags to java.desktop [v2]
Jonathan Gibbons
jjg at openjdk.org
Tue Jun 11 19:20:15 UTC 2024
On Tue, 4 Jun 2024 16:24:23 GMT, Alexey Ivanov <aivanov at openjdk.org> wrote:
>> Nizar Benalla has updated the pull request incrementally with one additional commit since the last revision:
>>
>> Swing was added in JDK 1.2
>
> src/java.desktop/share/classes/java/awt/geom/Path2D.java line 297:
>
>> 295: /**
>> 296: * @since 10
>> 297: */
>
> Not sure it's required…
>
> If it is, you should also add explicit `{@inheritDoc}`:
>
> Suggestion:
>
> /**
> * {@inheritDoc}
> *
> * @since 10
> */
1. You don't _need_ an explicit `{@inheritDoc}` although you may choose to do so for explicit clarity.
2. `@since` can be omitted for a member if the value would be the same as on the enclosing class
3. When present, `@since` on a method should indicate the first release in which the method is available for use on that class, with that VM signature (includes args and return type)
-------------
PR Review Comment: https://git.openjdk.org/jdk/pull/19192#discussion_r1635368076
More information about the client-libs-dev
mailing list