<i18n dev> RFR: 8312165: Fix typos in java.desktop Swing [v3]

[Alexey Ivanov]

On Wed, 30 Aug 2023 08:43:40 GMT, Andrey Turbanov <aturbanov at openjdk.org> wrote:

>> Found many typos in java.desktop by IDEA's inspection `Proofreading | Typo`
>
> Andrey Turbanov has updated the pull request with a new target base due to a merge or a rebase. The incremental webrev excludes the unrelated changes brought in by the merge/rebase. The pull request contains six additional commits since the last revision:
> 
>  - Merge remote-tracking branch 'origin/master' into fix_typos_java.desktop
>  - 8312165: Fix typos in java.desktop Swing
>    
>    apply suggestions from review
>  - 8312165: Fix typos in java.desktop Swing
>    
>    revert changes from non-swing parts to minimize count of files to review
>  - [PATCH] Fix typos in java.desktop
>  - [PATCH] Fix typos in java.desktop
>    
>    update copyrights
>  - [PATCH] Fix typos in java.desktop

Changes requested by aivanov (Reviewer).

src/java.desktop/share/classes/javax/swing/JLayeredPane.java line 558:

> 556:             if(curLayer == layer) {
> 557:                 results[layerCount++] = getComponent(i);
> 558:             /// Short circuit the counting when we have them all

You should revert this instance too.
Suggestion:

            /// Short-circuit the counting when we have them all

src/java.desktop/share/classes/javax/swing/plaf/metal/MetalComboBoxUI.java line 342:

> 340: 
> 341:     // These two methods were overridden and made public. This was probably a
> 342:     // mistake in the implementation. The functionality that they used to

Suggestion:

    // These two methods were overridden and made public. This was probably
    // a mistake in the implementation. The functionality that they used to

For consistency with the same text below.

src/java.desktop/share/classes/javax/swing/plaf/nimbus/DropShadowEffect.java line 46:

> 44:      * {@inheritDoc}
> 45:      *
> 46:      * @return The effect type

Suggestion:

     * @return {@inheritDoc}

src/java.desktop/share/classes/javax/swing/plaf/nimbus/Effect.java line 46:

> 44: 
> 45:     /**
> 46:      * Get the type of this effect, one of UNDER,BLENDED,OVER.

Suggestion:

     * Get the type of this effect, one of UNDER, BLENDED, OVER.

However, I'd also put them into `{@ }` if you don't mind.
Suggestion:

     * Get the type of this effect, one of {@code UNDER}, {@code BLENDED}, {@code OVER}.

src/java.desktop/share/classes/javax/swing/plaf/nimbus/Effect.java line 49:

> 47:      * UNDER means the result of applying the effect should be painted under the src image.
> 48:      * BLENDED means the result of applying the effect contains a modified src image, so it should just be painted.
> 49:      * OVER means the result of applying the effect should be painted over the src image.

A list would work even better:
Suggestion:

     * <ul>
     *   <li><b>{@code UNDER}</b> means the result of applying the effect should be painted under the src image.</li>
     *   <li><b>{@code BLENDED}</b> means the result of applying the effect contains a modified src image, so it should just be painted.</li>
     *   <li><b>{@code OVER}</b> means the result of applying the effect should be painted over the src image.</li>
     * </ul>

The above requires some wrapping to avoid long lines.

I think it looks better and clearer this way, even though it would be seen rarely, if ever. :)

src/java.desktop/share/classes/javax/swing/plaf/nimbus/InnerShadowEffect.java line 46:

> 44:      * {@inheritDoc}
> 45:      *
> 46:      * @return The effect type

Suggestion:

     * @return {@inheritDoc}

src/java.desktop/share/classes/javax/swing/plaf/synth/SynthParser.java line 185:

> 183: 
> 184:     /**
> 185:      * Defaults properties are placed here.

Suggestion:

     * Default properties are placed here.

I think the word “default” should be in singular here. Or rather “*Default property values* are placed here.”

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

PR Review: https://git.openjdk.org/jdk/pull/14847#pullrequestreview-1602440243
PR Review Comment: https://git.openjdk.org/jdk/pull/14847#discussion_r1310344522
PR Review Comment: https://git.openjdk.org/jdk/pull/14847#discussion_r1310086730
PR Review Comment: https://git.openjdk.org/jdk/pull/14847#discussion_r1310087560
PR Review Comment: https://git.openjdk.org/jdk/pull/14847#discussion_r1310094841
PR Review Comment: https://git.openjdk.org/jdk/pull/14847#discussion_r1310096873
PR Review Comment: https://git.openjdk.org/jdk/pull/14847#discussion_r1310099902
PR Review Comment: https://git.openjdk.org/jdk/pull/14847#discussion_r1310103857