RFR: JDK-8242326: use new "summary-list" CSS class instead of general "block-list" for list of summary sections

Hannes Wallnoefer HANNES.WALLNOEFER at ORACLE.COM
Fri Apr 10 15:51:33 UTC 2020


Hi Jon, 

I’m not quite sure if we talked about this in one of the previous review threads or maybe on Slack. But I can’t find it now so here we go:

With this changeset there are now three get*ListItem(Content) methods in SubWriterHolderWriter, all with the same implementation returning HtmlTree.LI(content). These methods are only called from the local `formats.html` package. Two of them, #getSummariesListItem and #getDetailsListItem are also defined in the ClassWriter interface, although they are never invoked on that interface or the implementing ClassWriterImpl class, only on SubWriterHolderWriter. 

I guess all of the above could be justified by completeness and symmetry (for lack of better terms). But I wonder if these methods actually do carry their weight, both for having distinct methods and for defining some of them in ClassWriter. 

Note that this is not a criticism, just something I’m curious about. 

Other than that the changes look good.

Hannes

> Am 08.04.2020 um 03:41 schrieb Jonathan Gibbons <jonathan.gibbons at oracle.com>:
> 
> Please review the latest in the series of updates to change uses of CSS class `block-list` to use separate class names.  This is for the list of summary sections that appear on most declaration pages.
> 
> The pattern is much the same as before, so I won't go into a lot of details.  As before, the changes percolate  from the builder classes to the writer classes to the writer-impl classes.
> 
> Some of the changes are cosmetic, updating the doc comment, and updating the name of parameters and local variables to better reflect their usage.
> 
> There's one more similar change in the pipeline, for the summary tables. When that has been done, I'll do another round of update on the comments in HtmlStyle.
> 
> -- Jon
> 
> JBS: https://bugs.openjdk.java.net/browse/JDK-8242326
> Webrev: http://cr.openjdk.java.net/~jjg/8242326/webrev.00/
> API: http://cr.openjdk.java.net/~jjg/8242326/api.00/
> 



More information about the javadoc-dev mailing list