RFR: JDK-8245058: improve presentation of annotations for modules and packages [v3]

Hannes Wallnöfer hannesw at openjdk.java.net
Fri Nov 27 17:48:28 UTC 2020


> 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.

Hannes Wallnöfer has updated the pull request with a new target base due to a merge or a rebase. The incremental webrev excludes the unrelated changes brought in by the merge/rebase. The pull request contains six additional commits since the last revision:

 - Merge branch 'master' into JDK-8245058
 - Fix some of the issues brought up in review
 - Improve HtmlStyle documentation
 - JDK-8245058 unify signature generating code
 - Refactor and unify signature generating code
 - Add proper signatures to module and package pages

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

Changes:
  - all: https://git.openjdk.java.net/jdk/pull/966/files
  - new: https://git.openjdk.java.net/jdk/pull/966/files/68ec5845..8eac51a8

Webrevs:
 - full: https://webrevs.openjdk.java.net/?repo=jdk&pr=966&range=02
 - incr: https://webrevs.openjdk.java.net/?repo=jdk&pr=966&range=01-02

  Stats: 312830 lines in 2626 files changed: 190850 ins; 90236 del; 31744 mod
  Patch: https://git.openjdk.java.net/jdk/pull/966.diff
  Fetch: git fetch https://git.openjdk.java.net/jdk pull/966/head:pull/966

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


More information about the javadoc-dev mailing list