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

2022-10-19 Thread Nir Lisker
On Wed, 19 Oct 2022 12:51:21 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

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

2022-10-19 Thread Kevin Rushforth
On Wed, 19 Oct 2022 12:52:33 GMT, Nir Lisker wrote: > It's not. I have mentioned this exact case in > https://bugs.openjdk.org/browse/JDK-8226930. I can assign it to you (or > self-assign it yourself) if you want to work on it. If not, I will get to it > at some point (no pun intended). This

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

2022-10-19 Thread Douglas Held
On Wed, 19 Oct 2022 12:51:21 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

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

2022-10-19 Thread Nir Lisker
On Wed, 19 Oct 2022 12:46:03 GMT, Douglas Held wrote: > I think there's something else of quality worth discussing here. Is `==` > appropriate given the values under comparison are `double`? It's not. I have mentioned this exact case in https://bugs.openjdk.org/browse/JDK-8226930. I can

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

2022-10-19 Thread Nir Lisker
On Wed, 19 Oct 2022 12:38:54 GMT, Douglas Held wrote: >> modules/javafx.graphics/src/main/java/javafx/geometry/Point3D.java line 417: >> >>> 415: * {@code getX}, {@code getY}, and {@code getZ} methods are equal. >>> 416: * >>> 417: * @param {@code obj} the reference object with

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

2022-10-19 Thread Nir Lisker
On Wed, 19 Oct 2022 12:33:37 GMT, Douglas Held wrote: > I thought the code tags produced hyperlinks. Those would be the `@link` tags, or `@linkplain`. - PR: https://git.openjdk.org/jfx/pull/913

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

2022-10-19 Thread Douglas Held
On Wed, 19 Oct 2022 12:36:30 GMT, Nir Lisker wrote: >> Douglas Held has updated the pull request incrementally with one additional >> commit since the last revision: >> >> Update Point3D.java >> >> Per review > > modules/javafx.graphics/src/main/java/javafx/geometry/Point3D.java line

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

2022-10-19 Thread Douglas Held
On Wed, 19 Oct 2022 12:41:20 GMT, Nir Lisker wrote: >> Don't use it for `obj` you mean? > > Here, yes. The parameter name following `@param` is taken care of > automatically (a hyphen is also added after it). and we don't need period `.` at the end of each `param` or `returns` line?

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

2022-10-19 Thread Douglas Held
On Wed, 19 Oct 2022 12:34:15 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

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

2022-10-19 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

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

2022-10-19 Thread Nir Lisker
On Wed, 19 Oct 2022 12:34:15 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

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

2022-10-19 Thread Douglas Held
On Tue, 18 Oct 2022 22:15:35 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

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

2022-10-19 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

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

2022-10-18 Thread Nir Lisker
On Tue, 18 Oct 2022 22:15:35 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

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

2022-10-18 Thread Douglas Held
On Tue, 18 Oct 2022 11:32:04 GMT, Nir Lisker wrote: >> Agreed, mentioning equality criteria sounds good to me too. How does this >> look ? >> >> >> /** >> * Indicates whether some other object is "equal to" this one. >> * Two instances of Point3D are equal if the return values

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

2022-10-18 Thread Douglas Held
On Thu, 13 Oct 2022 14:16:23 GMT, Nir Lisker wrote: >> Douglas Held has updated the pull request incrementally with one additional >> commit since the last revision: >> >> Update Point3D.java >> >> Per review > > Changes requested by nlisker (Reviewer). Tagged @nlisker to validate the

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

2022-10-18 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

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

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. >>

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. >

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

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

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

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

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

2022-10-14 Thread Douglas Held
On Thu, 13 Oct 2022 14:15:58 GMT, Nir Lisker 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

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

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

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

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

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

2022-10-14 Thread Douglas Held
On Thu, 13 Oct 2022 15:50:38 GMT, Kevin Rushforth wrote: >> 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,

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

2022-10-14 Thread Douglas Held
On Thu, 13 Oct 2022 15:49:58 GMT, Kevin Rushforth wrote: >> 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

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

2022-10-14 Thread Douglas Held
On Thu, 13 Oct 2022 14:13:27 GMT, Nir Lisker 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

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

2022-10-13 Thread Kevin Rushforth
On Thu, 13 Oct 2022 14:14:44 GMT, Nir Lisker 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

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

2022-10-13 Thread Kevin Rushforth
On Wed, 12 Oct 2022 17:28:42 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

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

2022-10-13 Thread Nir Lisker
On Wed, 12 Oct 2022 17:28:42 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

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

2022-10-13 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 added to

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

2022-10-13 Thread Kevin Rushforth
On Wed, 12 Oct 2022 17:28:42 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