Integrated: JDK-8232644: bugs in serialized-form.html

Hannes Wallnöfer hannesw at openjdk.java.net
Fri May 7 15:37:59 UTC 2021


On Fri, 30 Apr 2021 14:06:13 GMT, Hannes Wallnöfer <hannesw at openjdk.org> wrote:

> This implements most suggestions implemented in the JBS issue. The heading for class entries in the page is shortened to "<element-type-kind> <name>", followed by a simplified signature line like "class X extends Y implements Serializable".
> 
> Furthermore, package names in package headings now link to the package page, `@param` info is added to the methods, Externalizable is used for classes that implement it. I also added a check for content in `@serial` tags to avoid spurious empty ` ` lines in the output.
> 
> I increased the font size for headings `h4` to `h6` in the stylesheets because their size was smaller than the default text size, which looked strange. Although the change in font size from `h3` to `h4` and beyond is now smaller I think it's still recognizable. Headings `h4` to `h5` are used very little in Javadoc (mostly static doc files and the serialized-form page). I looked at some of the static files and they looked good to me with the new larger heading fonts.
> 
> Although I didn't end up using the `Signatures` class to generate the class signatures (they're just too simple and too specific in what they list), I left in some cleanup of `Signatures.TypeSignature`, most significantly moving the processing of modifiers from `ClassWriterImpl` to `Signatures.TypeSignature`.
> 
> I only removed the obsolete resources from the English resource file out of habit of not touching the Chinese and Japanese ones. I guess I could remove it there too.

This pull request has now been integrated.

Changeset: c6aa8f19
Author:    Hannes Wallnöfer <hannesw at openjdk.org>
URL:       https://git.openjdk.java.net/jdk/commit/c6aa8f19aca13d30c7a0340dc64da1214b76550f
Stats:     103 lines in 14 files changed: 35 ins; 13 del; 55 mod

8232644: bugs in serialized-form.html

Reviewed-by: jjg

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

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


More information about the javadoc-dev mailing list