On Thu, 13 Oct 2022 14:14:44 GMT, Nir Lisker <[email protected]> wrote:
>> The JavaDoc for equals had a copy/paste error. I normalized the text based
>> on the JavaDoc for method java.awt.Point#equals. I also changed formatting
>> in the method signatures of equals(), hashCode() and toString().
>>
>> For good measure, some kind of copy/paste detection should probably be added
>> to the many automated checks. For the entire OpenJDK project.
>
> modules/javafx.graphics/src/main/java/javafx/geometry/Point3D.java line 414:
>
>> 412: /**
>> 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.
>
> I would even write "i.f.f" because it's bidirectional.
>
> Also, `x`, `y`, and `z` should be in `{@code}`.
I think this one is OK either as "if" or "if and only if" (if you do change it,
I recommend spelling it out, although "iff" with no punctuation, would be
acceptable). I agree with the request to use code style.
> 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).
-------------
PR: https://git.openjdk.org/jfx/pull/913
