RFR: JDK-8245058: improve presentation of annotations for modules and packages
Hannes Wallnöfer
hannesw at openjdk.java.net
Fri Nov 27 17:14:59 UTC 2020
On Thu, 26 Nov 2020 17:59:33 GMT, Jonathan Gibbons <jjg at openjdk.org> wrote:
>> This PR adds a dedicated signature to module and package overview pages and moves all code for generating signatures to a new `doclets.formats.html.Signatures` utility class. The `Signatures` class contains two public static methods for module and package signatures as well as two inner classes for type and member signatures.
>>
>> Signatures are rendered as `<div>` elements with top level CSS classes that identify the kind of signature: `module-signature`, `package-signature`, `type-signature` and `member-signature`. Signature components are rendered as `<span>` elements with CSS classes that identify the component, e.g.: `modifiers`, `annotations`, `element-name`, `exceptions`.
>>
>> As a side benefit, this PR reduces the number of methods in `HtmlDocletWriter` used to generate annotation information.
>
> src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/ClassWriterImpl.java line 300:
>
>> 298: Set<TypeElement> subclasses = classtree.directSubClasses(typeElement, false);
>> 299: if (!subclasses.isEmpty()) {
>> 300: HtmlTree dl = HtmlTree.DL(HtmlStyle.notes);
>
> I'm surprised this has gone; is this intentional?
This method is part of the type signature generating code, it has been moved to Signatures.TypeSIgnature without functional changes.
-------------
PR: https://git.openjdk.java.net/jdk/pull/966
More information about the javadoc-dev
mailing list