RFR: JDK-8295236: Update JavaDoc in javafx.geometry.Point3D

Douglas Held duke at openjdk.org
Fri Oct 14 15:21:10 UTC 2022


On Fri, 14 Oct 2022 15:03:41 GMT, Douglas Held <duke at openjdk.org> wrote:

>> 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.
>
> I disagree with both suggestions. 
> 
> 1. I think the extra verbosity (while factually correct) adds nothing, for such a straightforward concept as equality of points in 3 space.
> 2. x, y and z are private and are not exposed in the JavaDoc. Further, the exposed methods getX() etc. that I **could** link to, are not actually what are evaluated in the method body.
> 
> I'd propose alternately that we keep "x, y and z" but call them "coordinates" and not "properties". This agrees with other parts of the JavaDoc such as the constructor, and getX() etc. method documentation.

Correction: getX() etc. are used in the method. I will put the methods into code tags.

-------------

PR: https://git.openjdk.org/jfx/pull/913


More information about the openjfx-dev mailing list