RFR: 4622866: javax.swing.text.Document.remove(int, int) has a misleading picture
Alexey Ivanov
aivanov at openjdk.org
Wed Sep 13 07:55:06 UTC 2023
The image in the [documentation for `Document.remove`](https://docs.oracle.com/en/java/javase/17/docs/api/java.desktop/javax/swing/text/Document.html#remove(int,int)) looks as if the portion between the offsets 6 and 10 is removed. However, the entire region for _‘quick ’_ is highlighted.
I updated the image to mark the start offset 4 and the end offset 10. The new image is in SVG format which looks crisp on modern High DPI displays.
I added a sentence that describes the image, which makes the documentation accessible and clearer.
Also, I marked up references to classes and members with `{@code}`.
Look at the updated version: [`Document.remove` in JDK 22](https://cr.openjdk.org/~aivanov/4622866/api/java.desktop/javax/swing/text/Document.html#remove(int,int)).
-------------
Commit messages:
- Update example description
- Adjust arrow start to accommodate for larger font
- Remove {@code} formatting from ‘the Document structure’
- Describe the removal of ‘quick’
- Adjust fonts: use Arial by default, increase size to 13px
- Use ‘shape-rendering: crispEdges’ for rectangles and lines
- Delete unused Document-remove.gif
- Markup class and method references with {@code}
- 4622866: javax.swing.text.Document.remove(int, int) has a misleading picture
Changes: https://git.openjdk.org/jdk/pull/15701/files
Webrev: https://webrevs.openjdk.org/?repo=jdk&pr=15701&range=00
Issue: https://bugs.openjdk.org/browse/JDK-4622866
Stats: 174 lines in 3 files changed: 162 ins; 0 del; 12 mod
Patch: https://git.openjdk.org/jdk/pull/15701.diff
Fetch: git fetch https://git.openjdk.org/jdk.git pull/15701/head:pull/15701
PR: https://git.openjdk.org/jdk/pull/15701
More information about the client-libs-dev
mailing list