RFR: 8355441: Remove antipattern from PassFailJFrame.forcePass javadoc [v4]

[Harshitha Onkar]

On Tue, 29 Apr 2025 12:42:28 GMT, Alexey Ivanov <aivanov at openjdk.org> wrote:

>> test/jdk/java/awt/regtesthelpers/PassFailJFrame.java line 1306:
>> 
>>> 1304:      * <p>A sample usage can be found in
>>> 1305:      * <a href="https://github.com/openjdk/jdk/blob/7283c8b/test/jdk/java/awt/FileDialog/SaveFileNameOverrideTest.java#L84">{@code
>>> 1306:      * SaveFileNameOverrideTest.java}</a>
>> 
>> Javadoc update LGTM. Maybe the doc for forceFail() can be updated similarly?
>> @aivanov-jdk What do you suggest?
>> 
>> It can be done as a part of this PR change or a separate PR. Since it is a similar doc change, I think it can be done as part of this PR by the changing the JBS title appropriately  - _Update javadocs for PassFailJFrame's forcePass() & forceFail() methods_
>
> @honkar-jdk JBS title could be updated… I'm still against doing so.
> 
> Currently, `forcePass` provides an example that shouldn't be followed. It's a problem.
> 
> Expanding the docs for `forcePass` and `forceFail` would be a good addition, but it's not such a big issue. I've submitted [JDK-8355515](https://bugs.openjdk.org/browse/JDK-8355515) to track this work.
> 
> As I mentioned in the description of JDK-8355515, adding a section in the main javadoc of `PassFailJFrame` would be even better. Although a new section doesn't eliminate expanding documentation for the methods themselves.

Sounds good to me if forceFail() docs is going to be handled as separate issue.

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

PR Review Comment: https://git.openjdk.org/jdk/pull/24837#discussion_r2066927589