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

Alexey Ivanov aivanov at openjdk.org
Tue Sep 24 16:12:29 UTC 2024


> 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.

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

Changes:
  - all: https://git.openjdk.org/jdk/pull/21145/files
  - new: https://git.openjdk.org/jdk/pull/21145/files/c36d4076..ff2e7f82

Webrevs:
 - full: https://webrevs.openjdk.org/?repo=jdk&pr=21145&range=01
 - incr: https://webrevs.openjdk.org/?repo=jdk&pr=21145&range=00-01

  Stats: 3 lines in 1 file changed: 0 ins; 1 del; 2 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