On Fri, 14 Oct 2022 15:15:27 GMT, Douglas Held <[email protected]> wrote:
>> Looking at the JavaDoc in the rest of the class, the {@code Point3D} tags
>> are not used outside of these two methods hashCode() and equals(). I'd
>> propose actually that we remove them, for consistency with the rest of the
>> JavaDoc in this class.
>
> ...correction, found in toString() as well.
It would be suitable to align with our existing doc comment in other classes,
for example as here,
1.
https://github.com/openjdk/jfx/blob/9768b5e42391e2d48aefffa3a3f6b1de6c30ef9d/modules/javafx.graphics/src/main/java/javafx/geometry/Point2D.java#L374
2.
https://github.com/openjdk/jfx/blob/9768b5e42391e2d48aefffa3a3f6b1de6c30ef9d/modules/javafx.graphics/src/main/java/javafx/geometry/Insets.java#L103
3.
https://github.com/openjdk/jfx/blob/9768b5e42391e2d48aefffa3a3f6b1de6c30ef9d/modules/javafx.graphics/src/main/java/javafx/geometry/BoundingBox.java#L169
I would recommend to use as in Point2D,
/**
* Indicates whether some other object is "equal to" this one.
*
* @param obj the reference object with which to compare
* @return true if this Point3D is the same as the obj argument; false
otherwise
*/
-------------
PR: https://git.openjdk.org/jfx/pull/913
