On Fri, 20 Aug 2021 17:49:03 GMT, Jonathan Gibbons <j...@openjdk.org> wrote:
>> Pavel Rappo has updated the pull request incrementally with one additional
>> commit since the last revision:
>>
>> Pass through FIXMEs and TODOs
>>
>> Downgrades FIXMEs that do not mark *feature issues* to TODOs, or removes
>> those FIXMEs completely. For example, unlike Style hierarchy, Action
>> hierarchy won't benefit from becoming sealed. So the respective FIXME is
>> removed.
>
> src/jdk.compiler/share/classes/com/sun/source/util/DocTreeScanner.java line
> 513:
>
>> 511:
>> 512: /**
>> 513: * {@inheritDoc} This implementation scans the children in left to
>> right order.
>
> (minor)
> I would suggest/recommend a line-break after the `{@inheritDoc}`
> Likewise for similar occurrences elsewhere.
See https://github.com/openjdk/jdk/pull/4795#discussion_r694070081. Let's NOT
do it in this PR.
> src/jdk.compiler/share/classes/com/sun/source/util/DocTreeScanner.java line
> 516:
>
>> 514: *
>> 515: * @param node {@inheritDoc}
>> 516: * @param p {@inheritDoc}
>
> Do you need the `{@inheritDoc}` ... isn't that the default behavior if no tag
> is specified?
>
> Likewise for similar occurrences elsewhere.
I don't think that I need `{@inheritDoc}` to inherit the comments in that and
the similar cases in that file. I used that style because other parts of the
file use it and I didn't want to update the file inconsistently. If we don't
like that style, we are free to change it. That said, let's NOT do it in this
PR.
-------------
PR: https://git.openjdk.java.net/jdk/pull/4795
