Re: RFR: JDK-8295236: Update JavaDoc in javafx.geometry.Point3D [v3]

2022-10-18 Thread Nir Lisker
On Tue, 18 Oct 2022 04:47:38 GMT, Ambarish Rapte wrote: >> I think that we should explain what makes 2 objects equal. Even if we don't >> explicitly name the methods used for comparison, we could say "2 points are >> equals if their coordinates are equal". >> >> By the way, I have https://bugs

Re: RFR: JDK-8295236: Update JavaDoc in javafx.geometry.Point3D [v3]

2022-10-17 Thread Ambarish Rapte
On Mon, 17 Oct 2022 17:07:40 GMT, Nir Lisker wrote: >> 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/geo

Re: RFR: JDK-8295236: Update JavaDoc in javafx.geometry.Point3D [v3]

2022-10-17 Thread Nir Lisker
On Mon, 17 Oct 2022 15:24:48 GMT, Ambarish Rapte wrote: >> ...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/

Re: RFR: JDK-8295236: Update JavaDoc in javafx.geometry.Point3D [v3]

2022-10-17 Thread Nir Lisker
On Fri, 14 Oct 2022 15:08:24 GMT, Douglas Held wrote: >> 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

Re: RFR: JDK-8295236: Update JavaDoc in javafx.geometry.Point3D [v3]

2022-10-17 Thread Ambarish Rapte
On Fri, 14 Oct 2022 15:15:27 GMT, Douglas Held 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

Re: RFR: JDK-8295236: Update JavaDoc in javafx.geometry.Point3D [v3]

2022-10-14 Thread Douglas Held
On Fri, 14 Oct 2022 15:30:10 GMT, Douglas Held 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 m

Re: RFR: JDK-8295236: Update JavaDoc in javafx.geometry.Point3D [v3]

2022-10-14 Thread Douglas Held
> 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