-
Enhancement
-
Resolution: Fixed
-
P3
-
15
-
b27
(See attached screenshots for images of the following text fragments.)
For a type element, annotations are displayed as part of the "signature" block, in text like this:
type-description.png
--------------------
Module m
Package p
Class C
java.lang.Object
p.C
@Anno
public class C
extends java.lang.Object
This is a class.
--------------------
However, for a module or package, there is currently no equivalent "signature block", and so the annotations get pushed up into the header (i.e. the <div> immediately below the top navbar, like this:
module-description.png
--------------------
@Anno
Module m
This is a module.
--------------------
package-description.png
--------------------
Module m
@Anno
Package p
This is a package.
--------------------
This definitely looks "weird" and the annotation looks out of place.
A better solution would be to introduce an analogous signature block, similar to that provided on type declaration pages.
This would also help regularize the structure between the pages for module/package/type declaration pages.
For a type element, annotations are displayed as part of the "signature" block, in text like this:
type-description.png
--------------------
Module m
Package p
Class C
java.lang.Object
p.C
@Anno
public class C
extends java.lang.Object
This is a class.
--------------------
However, for a module or package, there is currently no equivalent "signature block", and so the annotations get pushed up into the header (i.e. the <div> immediately below the top navbar, like this:
module-description.png
--------------------
@Anno
Module m
This is a module.
--------------------
package-description.png
--------------------
Module m
@Anno
Package p
This is a package.
--------------------
This definitely looks "weird" and the annotation looks out of place.
A better solution would be to introduce an analogous signature block, similar to that provided on type declaration pages.
This would also help regularize the structure between the pages for module/package/type declaration pages.
- duplicates
-
JDK-8178833 Review the presentation of annotations on modules
- Closed
- relates to
-
JDK-8260223 Handling of unnamed package in javadoc pages
- Resolved
-
JDK-8240681 Large list of supertypes may unnecessarily widen a page
- Resolved