Re: RFR: JDK-8295236: Update JavaDoc in javafx.geometry.Point3D [v4]
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 [v4]
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 good measure, some kind of copy/paste detection should probably be added >> to the many automated checks. For the entire OpenJDK project. > > Douglas Held has updated the pull request incrementally with one additional > commit since the last revision: > > Update Point3D.java > > Per review I think this equals() method JavaDoc should be compliant now. I must apologise. I thought the code tags produced hyperlinks. Now I can see they only apply a fixed width type font. Of course, the formatting tags need to apply in all of the places discussed. - PR: https://git.openjdk.org/jfx/pull/913
Re: RFR: JDK-8295236: Update JavaDoc in javafx.geometry.Point3D [v4]
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 good measure, some kind of copy/paste detection should probably be added >> to the many automated checks. For the entire OpenJDK project. > > 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 414: > 412: /** > 413: * Indicates whether some other object is "equal to" this one. > 414: * Two instances of Point3D are equal if the return values of their `Point3D` also needs `@code`. modules/javafx.graphics/src/main/java/javafx/geometry/Point3D.java line 418: > 416: * > 417: * @param obj the reference object with which to compare > 418: * @return true if this Point3D is the same as the obj argument; > false otherwise `Point3D`, `true`, `false` and `obj` need `@code`. - PR: https://git.openjdk.org/jfx/pull/913
Re: RFR: JDK-8295236: Update JavaDoc in javafx.geometry.Point3D [v4]
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 of their >> * {@code getX}, {@code getY}, and {@code getZ} methods are equal. >> * >> * @param obj the reference object with which to compare >> * @return true if this Point3D is the same as the obj argument; false >> otherwise >> */ > > This is the current proposal by Douglas and align with `Object::equals` which > it is overriding. I'm fine with this wording. Just need to add the `@code` > tags. I have added a commit to match the proposed block by arapte. - PR: https://git.openjdk.org/jfx/pull/913
Re: RFR: JDK-8295236: Update JavaDoc in javafx.geometry.Point3D [v4]
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 code tags are included appropriately. - PR: https://git.openjdk.org/jfx/pull/913
Re: RFR: JDK-8295236: Update JavaDoc in javafx.geometry.Point3D [v4]
> 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. Douglas Held has updated the pull request incrementally with one additional commit since the last revision: Update Point3D.java Per review - Changes: - all: https://git.openjdk.org/jfx/pull/913/files - new: https://git.openjdk.org/jfx/pull/913/files/0c52ce57..eb08b561 Webrevs: - full: https://webrevs.openjdk.org/?repo=jfx&pr=913&range=03 - incr: https://webrevs.openjdk.org/?repo=jfx&pr=913&range=02-03 Stats: 4 lines in 1 file changed: 0 ins; 0 del; 4 mod Patch: https://git.openjdk.org/jfx/pull/913.diff Fetch: git fetch https://git.openjdk.org/jfx pull/913/head:pull/913 PR: https://git.openjdk.org/jfx/pull/913