RFR: 8332103: since-checker - Add missing @ since tags to java.desktop [v2]
Alexey Ivanov
aivanov at openjdk.org
Wed Jun 12 11:35:18 UTC 2024
On Tue, 11 Jun 2024 19:17:43 GMT, Jonathan Gibbons <jjg at openjdk.org> wrote:
>> 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)
Thank you for clarification, @jonathan-gibbons. So, `@since` is required here.
I prefer an explicit `{@inheritDoc}`, this way the javadoc comment doesn't look empty. I'm fine without adding `{@inheritDoc}` though.
-------------
PR Review Comment: https://git.openjdk.org/jdk/pull/19192#discussion_r1636305506
More information about the client-libs-dev
mailing list