RFR: JDK-8295236: Update JavaDoc in javafx.geometry.Point3D [v3]
Nir Lisker
nlisker at openjdk.org
Mon Oct 17 17:14:21 UTC 2022
On Fri, 14 Oct 2022 15:08:24 GMT, Douglas Held <duke at openjdk.org> wrote:
>> Not strictly enforced, but adding a blank line does aid readability (of the source code...the generated docs don't care).
>
> If I were to add empty lines before JavaDoc tags such as @param etc, then for consistency I think I should do it for the whole class, where they are not present.
>
> Note, on line 32: **// PENDING_DOC_REVIEW of this whole class**
> Maybe we should first decide whether we are scrubbing all doc for the whole class, or making a minimal change to the obviously incorrect information. My feeling is now tending toward the latter.
>
> It could very well be that I misunderstood the comment by nlisker.
We just tend to separate the words section from the tags section with an empty line in the source code. You don't have to do it for the whole class (unless you want to), I just suggest to do it here since you're making a change anyway.
-------------
PR: https://git.openjdk.org/jfx/pull/913
More information about the openjfx-dev
mailing list