RFR: 8340466: Add description for PassFailJFrame constructors [v2]

[Phil Race]

On Tue, 24 Sep 2024 16:12:29 GMT, Alexey Ivanov <aivanov at openjdk.org> wrote:

>> I added description to all the constructors available in `PassFailJFrame`.
>> 
>> I generated the javadoc for it: [`PassFailJFrame` constructor details](https://cr.openjdk.org/~aivanov/PassFailJFrame/api/PassFailJFrame.html#constructor-detail) which is easier to read. This hosted javadoc could be used as a reference to its API.
>> 
>> The constructor with the largest number of parameters contains a short description of how to use the `PassFailJFrame` object.
>> 
>> Shall we deprecate the constructors in favour of `Builder`?
>> 
>> The builder provides a more streamlined experience, therefore new tests should use it instead of constructors. We may update the tests which use the constructors, after which the constructors can be removed.
>
> Alexey Ivanov has updated the pull request incrementally with one additional commit since the last revision:
> 
>   Use EDT abbreviation in constructor description
>   
>   The term EDT (Event Dispatch Thread) is introduced in
>   the top-level doc comment.

Marked as reviewed by prr (Reviewer).

test/jdk/java/awt/regtesthelpers/PassFailJFrame.java line 328:

> 326:      * <p>
> 327:      * After you create a test UI window, register the window using
> 328:      * {@link #addTestWindow(Window) addTestWindow} for disposing of, and

disposing of -> disposal

test/jdk/java/awt/regtesthelpers/PassFailJFrame.java line 351:

> 349:      * If you enable screenshots by setting the {@code screenCapture}
> 350:      * parameter to {@code true}, a <i>Screenshot</i> button is added.
> 351:      * Clicking the <i>Screenshot</i> button, takes screenshot of

"screenshots"

-------------

PR Review: https://git.openjdk.org/jdk/pull/21145#pullrequestreview-2325912386
PR Review Comment: https://git.openjdk.org/jdk/pull/21145#discussion_r1773746225
PR Review Comment: https://git.openjdk.org/jdk/pull/21145#discussion_r1773748489