Re: RFR: 8332251: javadoc: incorrect reference in Region.getPrefWidth/Height [v2]
On Thu, 16 May 2024 14:54:47 GMT, Andy Goryachev wrote:
>> modules/javafx.graphics/src/main/java/javafx/scene/layout/Region.java line
>> 1212:
>>
>>> 1210: *
>>> 1211: * Defaults to the USE_COMPUTED_SIZE flag, which
>>> means that
>>> 1212: * {@link #prefHeight(forWidth)} will return the region's
>>> internally
>>
>> 1. In this file, the documentation for other properties like minWidth,
>> minHeight use ``
>> For similarity I think we should keep `` or change others as well
>> to `link`.
>>
>> 2. There are similar correction needed at four other places in this file. As
>> we are touching this file, I think these can be corrected too. If modified
>> then the issue summary would need a modification too.
>> 1252: * getMaxWidth(forHeight) will return the region's
>> internally
>> 1256: * getMaxWidth(forHeight) to return the region's
>> preferred width,
>> 1281: * getMaxHeight(forWidth) will return the region's
>> internally
>> 1285: * getMaxHeight(forWidth) to return the region's
>> preferred height
>>
>> 3. Similar mistakes are observed in the PopupControl.java file too. I leave
>> it to you to correct those here or handle separately
>
> thank you for pointing this out, I am going to revert back to `` and
> update `PopupControl`.
Looks good,
I recommend to update the summary, current summary is quite specific to Region
/ prefWidth/Height.
A suggestion->
javadoc: incorrect method references in Region and PopupControl
-
PR Review Comment: https://git.openjdk.org/jfx/pull/1456#discussion_r1603683364
Re: RFR: 8332251: javadoc: incorrect reference in Region.getPrefWidth/Height [v2]
On Thu, 16 May 2024 14:58:29 GMT, Andy Goryachev wrote: >> The javadoc for `Region.getPrefHeight() / getPrefWidth()` incorrectly refers >> to `getPrefHeight(forWidth) / getPrefWidth(forHeight)` >> >> should be >> >> `prefHeight(forWidth) / prefWidth(forHeight)` >> >> - same issue is also fixed in `PopupControl`. > > Andy Goryachev has updated the pull request incrementally with one additional > commit since the last revision: > > popup control Marked as reviewed by arapte (Reviewer). - PR Review: https://git.openjdk.org/jfx/pull/1456#pullrequestreview-2061307814
Re: RFR: 8332251: javadoc: incorrect reference in Region.getPrefWidth/Height [v2]
> The javadoc for `Region.getPrefHeight() / getPrefWidth()` incorrectly refers > to `getPrefHeight(forWidth) / getPrefWidth(forHeight)` > > should be > > `prefHeight(forWidth) / prefWidth(forHeight)` > > - same issue is also fixed in `PopupControl`. Andy Goryachev has updated the pull request incrementally with one additional commit since the last revision: popup control - Changes: - all: https://git.openjdk.org/jfx/pull/1456/files - new: https://git.openjdk.org/jfx/pull/1456/files/003e6cff..251fefb6 Webrevs: - full: https://webrevs.openjdk.org/?repo=jfx=1456=01 - incr: https://webrevs.openjdk.org/?repo=jfx=1456=00-01 Stats: 36 lines in 2 files changed: 0 ins; 0 del; 36 mod Patch: https://git.openjdk.org/jfx/pull/1456.diff Fetch: git fetch https://git.openjdk.org/jfx.git pull/1456/head:pull/1456 PR: https://git.openjdk.org/jfx/pull/1456
Re: RFR: 8332251: javadoc: incorrect reference in Region.getPrefWidth/Height [v2]
On Thu, 16 May 2024 10:01:05 GMT, Ambarish Rapte wrote:
>> Andy Goryachev has updated the pull request incrementally with one
>> additional commit since the last revision:
>>
>> popup control
>
> modules/javafx.graphics/src/main/java/javafx/scene/layout/Region.java line
> 1212:
>
>> 1210: *
>> 1211: * Defaults to the USE_COMPUTED_SIZE flag, which
>> means that
>> 1212: * {@link #prefHeight(forWidth)} will return the region's
>> internally
>
> 1. In this file, the documentation for other properties like minWidth,
> minHeight use ``
> For similarity I think we should keep `` or change others as well
> to `link`.
>
> 2. There are similar correction needed at four other places in this file. As
> we are touching this file, I think these can be corrected too. If modified
> then the issue summary would need a modification too.
> 1252: * getMaxWidth(forHeight) will return the region's
> internally
> 1256: * getMaxWidth(forHeight) to return the region's
> preferred width,
> 1281: * getMaxHeight(forWidth) will return the region's
> internally
> 1285: * getMaxHeight(forWidth) to return the region's
> preferred height
>
> 3. Similar mistakes are observed in the PopupControl.java file too. I leave
> it to you to correct those here or handle separately
thank you for pointing this out, I am going to revert back to `` and
update `PopupControl`.
-
PR Review Comment: https://git.openjdk.org/jfx/pull/1456#discussion_r1603530347
Re: RFR: 8332251: javadoc: incorrect reference in Region.getPrefWidth/Height
On Wed, 15 May 2024 23:01:30 GMT, Andy Goryachev wrote:
> The javadoc for `Region.getPrefHeight() / getPrefWidth()` incorrectly refers
> to `getPrefHeight(forWidth) / getPrefWidth(forHeight)`
>
> should be
>
> `prefHeight(forWidth) / prefWidth(forHeight)`
>
> - also converted these references to `{@link}`s.
modules/javafx.graphics/src/main/java/javafx/scene/layout/Region.java line 1212:
> 1210: *
> 1211: * Defaults to the USE_COMPUTED_SIZE flag, which means
> that
> 1212: * {@link #prefHeight(forWidth)} will return the region's internally
1. In this file, the documentation for other properties like minWidth,
minHeight use ``
For similarity I think we should keep `` or change others as well to
`link`.
2. There are similar correction needed at four other places in this file. As we
are touching this file, I think these can be corrected too. If modified then
the issue summary would need a modification too.
1252: * getMaxWidth(forHeight) will return the region's
internally
1256: * getMaxWidth(forHeight) to return the region's
preferred width,
1281: * getMaxHeight(forWidth) will return the region's
internally
1285: * getMaxHeight(forWidth) to return the region's
preferred height
3. Similar mistakes are observed in the PopupControl.java file too. I leave it
to you to correct those here or handle separately
-
PR Review Comment: https://git.openjdk.org/jfx/pull/1456#discussion_r1603035540
RFR: 8332251: javadoc: incorrect reference in Region.getPrefWidth/Height
The javadoc for `Region.getPrefHeight() / getPrefWidth()` incorrectly refers to
`getPrefHeight(forWidth) / getPrefWidth(forHeight)`
should be
`prefHeight(forWidth) / prefWidth(forHeight)`
- also converted these references to `{@link}`s.
-
Commit messages:
- 8332251: javadoc: incorrect reference in Region.getPrefWidth/Height
Changes: https://git.openjdk.org/jfx/pull/1456/files
Webrev: https://webrevs.openjdk.org/?repo=jfx=1456=00
Issue: https://bugs.openjdk.org/browse/JDK-8332251
Stats: 3 lines in 1 file changed: 0 ins; 0 del; 3 mod
Patch: https://git.openjdk.org/jfx/pull/1456.diff
Fetch: git fetch https://git.openjdk.org/jfx.git pull/1456/head:pull/1456
PR: https://git.openjdk.org/jfx/pull/1456
