RFR : JDK-8215038 : Add a page that lists all system properties

Jonathan Gibbons jonathan.gibbons at oracle.com
Thu May 30 00:14:49 UTC 2019


HtmlDoclet.java or SystemPropertiesWriter.
The system properties page should not be generated if there are no uses 
of {@systemProperty}
There should also be a test case for this.

HtmlDocletWriter
typo/spelling in name "getVerticalSeperator" ... should be "Separator".
It's a bit of overkill to add a new style for verticalSeparator, but 
it's not wrong.  I guess it does allow to increase the margin either side.

SingleIndexWriter and SplitIndexWriter
Is the test configuration.tagSearchIndex.isEmpty() correct ... what if 
other tags are defined but no system properties: you'll get a link to an 
empty page

stylesheet.css
General: uuugh, not wrong, but just ugly; one of these days we will fix 
the stylesheet
line 782: do you still need this, now that the properties are in a 
table, not a list?

SystemPropertiesWriter
line 25: add a blank line between the comment and the package statement

75, 79, do you really need both a public static method and a private 
static method? If the private static method is only called from the 
public one, I suggest inlining it

161 ... expression really needs explaining and/or a comment.   I know 
what you're trying to do, but there has to be a better way to do it. I'd 
be tempted to convert the url into a "real URL" to separate the fragment 
from the filename, and then use `lastIndexOf` to get the end of the 
filename.  EVen the following would be better:

     String url = searchIndexItem.getUrl();
     int fragmentSeparator = url.lastIndexOf("#");
     int lastFileSeparator = url.lastIndexOf("/", fragmentSeparator);
     return url.substring(lastFileSeparator + 1, fragmentSeparator);

-- Jon


On 05/27/2019 03:47 AM, Priya Lakshmi Muthuswamy wrote:
> Hi,
>
> Kindly the changes made for adding a page for listing all system 
> properties.
> The link for system properties pages is included in the index page
>
> JBS: https://bugs.openjdk.java.net/browse/JDK-8215038
> webrev: http://cr.openjdk.java.net/~pmuthuswamy/8215038/review.02/webrev/
> api: http://cr.openjdk.java.net/~pmuthuswamy/8215038/review.02/api/
>
> Thanks,
> Priya
>
>

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://mail.openjdk.java.net/pipermail/javadoc-dev/attachments/20190529/62aebca6/attachment.html>


More information about the javadoc-dev mailing list