RFR [14] 8215038: Add a page that lists all system properties
Pavel Rappo
pavel.rappo at oracle.com
Wed Dec 11 20:12:49 UTC 2019
Roger,
We have the same concern. I think it should be addressed in a follow-up bug along with some other issues. Meanwhile we should ponder on a particular mechanism of extracting meaningful descriptions in the case of html files. It might be done using <title>, <h1>, <meta>, or whatever. Falling back on the relative URL, the filename (as of today) plus extra context. These are details though.
As of today we can get away with what we have because of the combination of factors. 1. We don't seem to have many definitions of system properties in the html files. 2. Those definitions we have are inside nicely named html files (e.g. net-properties.html). So there are no nondescriptive or ambiguous links.
-Pavel
> On 11 Dec 2019, at 19:18, Roger Riggs <Roger.Riggs at oracle.com> wrote:
>
> Hi,
>
> For the links to the .html files, it would look better if it extracted the <TITLE>xx</TITLE>
> from the page to use for the "Referenced In" column. It fit better with the package and class references.
>
> And yes, any index is better than none.
>
> Thanks, Roger
>
>
> On 12/11/19 12:26 PM, Pavel Rappo wrote:
>> Hello,
>>
>> Please review the following change for https://bugs.openjdk.java.net/browse/JDK-8215038:
>>
>> http://cr.openjdk.java.net/~prappo/8215038/webrev.00/
>>
>> This change proposes a summary page for system properties. The change is largely based on prior work of Priya Lakshmi Muthuswamy (pmuthuswamy). The result can be seen here:
>>
>> http://cr.openjdk.java.net/~prappo/8215038/docs/
>>
>> For practical reasons the link above leads to only a small part of the API docs, so most links will NOT work. From the navigation bar click on the "INDEX" link and then on the "System Properties" link immediately below the letter index.
>>
>> We still have a ways to go with this particular functionality, but I reckon this is a good start.
>>
>> Thanks,
>> -Pavel
>>
>
More information about the javadoc-dev
mailing list