RFR: JDK-8295236: Update JavaDoc in javafx.geometry.Point3D
Douglas Held
duke at openjdk.org
Fri Oct 14 15:21:11 UTC 2022
On Thu, 13 Oct 2022 14:15:58 GMT, Nir Lisker <nlisker at openjdk.org> 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 417:
>
>> 415: * @param obj an object to be compared with this {@code Point3D}.
>> 416: * @return true if the object to be compared is an instance of Point3D and
>> 417: * has the same values; false otherwise.
>
> `true`, `Point3D` and `false` should be in `{@code}`.
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.
-------------
PR: https://git.openjdk.org/jfx/pull/913
More information about the openjfx-dev
mailing list