RFR: 8340466: Add descriptions for PassFailJFrame constructors
Alexey Ivanov
aivanov at openjdk.org
Mon Sep 23 20:45:44 UTC 2024
I added description to all the constructors available in `PassFailJFrame`.
I generated the javadoc for it: [`PassFailJFrame/api`](https://cr.openjdk.org/~aivanov/PassFailJFrame/api/PassFailJFrame.html) 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.
-------------
Commit messages:
- Describe the remaining PassFailJFrame constructors
- Describe PassFailJFrame(title, instructions, timeOut)
- Put EDT into <dfn> tags where it's introduced
- Re-flow constructor parameters at timeout, wrap entire throws clause
- Re-write description of PassFailJFrame constructor without screenshots
- Re-write description of PassFailJFrame constructor with screenshots
- Replace plain `&` in javadocs with `&`
Changes: https://git.openjdk.org/jdk/pull/21145/files
Webrev: https://webrevs.openjdk.org/?repo=jdk&pr=21145&range=00
Issue: https://bugs.openjdk.org/browse/JDK-8340466
Stats: 154 lines in 1 file changed: 97 ins; 14 del; 43 mod
Patch: https://git.openjdk.org/jdk/pull/21145.diff
Fetch: git fetch https://git.openjdk.org/jdk.git pull/21145/head:pull/21145
PR: https://git.openjdk.org/jdk/pull/21145
More information about the client-libs-dev
mailing list