RFR: JDK-8254721: Improve support for conditionally generated files

Jonathan Gibbons jjg at openjdk.java.net
Mon Oct 19 17:08:24 UTC 2020


On Mon, 19 Oct 2020 14:45:09 GMT, Hannes Wallnöfer <hannesw at openjdk.org> wrote:

>> The overall pages is very dynamic and depends on a lot of factors, such as the input files and the command-line
>> options. Some of the summary files depend on the content of the classes being documented, such as:
>> * any constant values declared in the files
>> * any deprecated elements
>> * any serializable classes
>> * any classes whose description references system properties
>> 
>> This change is a step towards handling these files in a uniform manner.
>> 
>> There is a new test to test the consistency of the new behavior..
>
> src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/HelpWriter.java line 276:
> 
>> 274:         if (configuration.conditionalPages.contains(HtmlConfiguration.PageKind.SYSTEM_PROPERTIES)) {
>> 275:             section = newHelpSection(contents.systemPropertiesLabel);
>> 276:             Content constantsBody = getContent("doclet.help.systemProperties.body",
> 
> Not an actual problem, but `constantsBody` is the name used for the constant values page. Should be either a generic
> name or one hinting at the system properties content.

Good catch; will fix.

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

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


More information about the javadoc-dev mailing list