On Thu, 13 Oct 2022 15:50:38 GMT, Kevin Rushforth <[email protected]> wrote:
>> modules/javafx.graphics/src/main/java/javafx/geometry/Point3D.java line 415:
>>
>>> 413: * Determines whether or not two objects are equal. Two instances
>>> of {@code Point3D}
>>> 414: * are equal if the values of their x, y, and z properties are
>>> equal.
>>> 415: * @param obj an object to be compared with this {@code Point3D}.
>>
>> We tend to put a new line before the tags to separate them from the
>> description, not sure if it's enforced.
>
> 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.
-------------
PR: https://git.openjdk.org/jfx/pull/913
