RFR: JDK-8263300: add HtmlId for the block containing a class's description.

Jonathan Gibbons jjg at openjdk.java.net
Thu Mar 25 01:20:42 UTC 2021


On Fri, 12 Mar 2021 14:04:04 GMT, Hannes Wallnöfer <hannesw at openjdk.org> wrote:

> This is a relatively simple change to add an `id="class-description"` to the description section of type pages. It also changes the CSS class for this section from `description` to `class-description` for consistency with package and module pages. 
> 
> My initial plan was to move the beginning of the section to after the type signature, as this is how it is done for package and module pages. However, I'm not sure there's any benefit to this that would be worth the change, so I decided to keep it simple.

Nice.  I agree with keeping it simple, for now, in this proposed change.

We might want to revisit the policy for *all* elements (module, page, class or interface, and members) with a view to improving consistency of the "description" section where appropriate.

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

Marked as reviewed by jjg (Reviewer).

PR: https://git.openjdk.java.net/jdk/pull/2971


More information about the javadoc-dev mailing list