RFR: 8313810: BoxLayout uses <blockquote> instead of list for layout options

Alexey Ivanov aivanov at openjdk.org
Mon Aug 7 19:54:39 UTC 2023


On Mon, 7 Aug 2023 19:43:38 GMT, Alexey Ivanov <aivanov at openjdk.org> wrote:

> A clean-up of documentation for [`BoxLayout`](https://docs.oracle.com/en/java/javase/17/docs/api/java.desktop/javax/swing/BoxLayout.html#class-description):
> 
> 1. Use the `<ul>` element instead of `<blockquote>` to list layout options or axes.
> 2. Add links to `GridBagLayout` and `Box` classes.
> 3. Markup references to classes, mostly `BoxLayout` itself, with `{@code}`.
> 4. Separate the introduction to layout description from the description of horizontal layout. They're now in different paragraphs for easier scanning.
> 5. Add the missing ‘a’ articles.
> 6. Organise imports, including expanding the wildcard import.
> 
> The updated version: [**`BoxLayout.html`**](https://cr.openjdk.org/~aivanov/8313810/api/java.desktop/javax/swing/BoxLayout.html#class-description) (without the CSS).

An alternative version [**`BoxLayout-list.html`**](https://cr.openjdk.org/~aivanov/8313810/api/java.desktop/javax/swing/BoxLayout-layout-list.html#class-description) which uses *a list* to describe the layout.

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

PR Comment: https://git.openjdk.org/jdk/pull/15182#issuecomment-1668485081



More information about the client-libs-dev mailing list