RFR: 8332251: javadoc: incorrect reference in Region.getPrefWidth/Height

[Ambarish Rapte]

On Wed, 15 May 2024 23:01:30 GMT, Andy Goryachev <angorya at openjdk.org> 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:      * <p>
> 1211:      * Defaults to the <code>USE_COMPUTED_SIZE</code> 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 `<code>`
    For similarity I think we should keep `<code>` 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:     * <code>getMaxWidth(forHeight)</code> will return the region's internally
1256:     * <code>getMaxWidth(forHeight)</code> to return the region's preferred width,
1281:     * <code>getMaxHeight(forWidth)</code> will return the region's internally
1285:     * <code>getMaxHeight(forWidth)</code> 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