RFR: 8294156: Allow PassFailJFrame.Builder to create test UI [v3]
Alexey Ivanov
aivanov at openjdk.org
Mon Oct 23 21:02:40 UTC 2023
On Wed, 20 Sep 2023 18:12:25 GMT, Phil Race <prr at openjdk.org> wrote:
>>> Shouldn't we mention here a window added by `testUI` via builder?
>>
>> I don't think it's necessary: the builder uses `addTestWindow` under the hood. It's the builder that requires documentation.
>>
>> In fact, the entire class requires a bit of TLC for documentation. I even wrote some after Lawrence @lawrence-andrew created the first version of `PassFailJFrame` but I never finished it. Even this part was implemented nearly a year ago.
>>
>> I plan to create a wiki page on the [client-libs wiki](https://wiki.openjdk.org/display/ClientLibs) to describe creating manual tests with `PassFailJFrame`.
>
>> > Shouldn't we mention here a window added by `testUI` via builder?
>>
>> I don't think it's necessary: the builder uses `addTestWindow` under the hood. It's the builder that requires documentation.
>>
>> In fact, the entire class requires a bit of TLC for documentation. I even wrote some after Lawrence @lawrence-andrew created the first version of `PassFailJFrame` but I never finished it. Even this part was implemented nearly a year ago.
>>
>> I plan to create a wiki page on the [client-libs wiki](https://wiki.openjdk.org/display/ClientLibs) to describe creating manual tests with `PassFailJFrame`.
>
> Just saw this, and it mirrors what I wrote in another PR that we need docs, but I believe they are best placed inside the source itself. Not everyone who can update this source can update the wiki.
> That doesn't preclude you from putting more examples on the wiki and a reference to it from the source but I still think there should be docs in the source.
>
> Include how to use this feature and something like to the builder example you have here might be good too.
@prrace I've just pushed documentation on how to use `PassFailJFrame`. It provided two samples: the new one with the builder pattern and the classic one. The samples can be copied and pasted into a file, they're ready to run, except for imports and jtreg tags.
-------------
PR Review Comment: https://git.openjdk.org/jdk/pull/15665#discussion_r1369259910
More information about the client-libs-dev
mailing list