On Tue, 23 Aug 2022 14:34:08 GMT, Alexey Ivanov <[email protected]> wrote:
>> Harshitha Onkar has updated the pull request incrementally with one
>> additional commit since the last revision:
>>
>> minor change to positionTestWindow javadoc
>
> test/jdk/java/awt/regtesthelpers/PassFailJFrame.java line 287:
>
>> 285: * such that its top left corner is at the top
>> left corner of
>> 286: * the screen and the test window (if not null) is
>> placed to
>> 287: * the right of the instruction frame.
>
> Such formatting looks good in the source code, yet in Javadoc (which is never
> created, I know) and in a tooltip in an IDE, it becomes unreadable because
> there are no breaks.
>
> I propose to use a list:
>
>
> * @param position position must be one of:
> * <ul>
> * <li>{@code HORIZONTAL} - the test instruction frame
> is positioned
> * such that its right edge aligns with screen's
> horizontal
> * center and the test window (if not {@code null}) is
> placed to
> * the right of the instruction frame.
> *
> * <li>{@code VERTICAL} - the test instruction frame is
> positioned such
> * that its bottom edge aligns with the screen's vertical
> * center and the test window (if not {@code null}) is
> placed below
> * the instruction frame.
> *
> * <li>{@code TOP_LEFT_CORNER} - the test instruction
> frame is positioned
> * such that its top left corner is at the top left
> corner of
> * the screen and the test window (if not {@code null})
> is placed to
> * the right of the instruction frame.
> * </ul>
>
>
> For consistency with the `testWindow` parameter, I put `{@code}` around
> `null`.
Updated the javadoc as per review comments.
-------------
PR: https://git.openjdk.org/jdk/pull/9525
