RFR: 8290501 : Typo Found In The javax.swing Interface BoundedRangeModel Documentation

[Alexey Ivanov]

On Sat, 10 Aug 2024 01:14:09 GMT, Phil Race <prr at openjdk.org> wrote:

>> Agreed. 
>> 
>> @Renjithkannath Minor typo that can be addressed in this PR
>> "an" can be removed from the following line 
>> For **an** example of specifying custom bounded range models used by sliders,
>
> No, that would be introducing incorrect grammar, not fixing a typo.
> 
> Maybe we are just done here.

I agree it's not worth it. Yes, the javadoc comment can be improved further:

- `JSlider` and `JProgressBar` could be marked up with `{@link}`;
- All references to classes and methods could be marked up with `{@code}`;
- `<code>Slider</code>` and `<code>ScrollBar</code>` should be referenced by prose, as they refer to component concepts rather than component classes, alternatively these can be changed to `JSlider` and `JScrollBar` correspondingly.

The above changes don't make much difference and don't considerably improve the specification.

> > For **an** example of specifying custom bounded range models used by sliders,
>
> No, that would be introducing incorrect grammar, not fixing a typo.

No, *“an”* shouldn't be removed in this case.

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

PR Review Comment: https://git.openjdk.org/jdk/pull/20465#discussion_r1713478135