RFR: 8296804: Document HttpClient configuration properties in java.net.http module-info [v7]

[Daniel Fuchs]

On Thu, 24 Nov 2022 11:18:33 GMT, Michael McMahon <michaelm at openjdk.org> wrote:

>> Hi,
>> 
>> Could I get the following doc change reviewed please? It documents the system/networking properties used by the java.net.http HTTP client in its module-info. (CSR to follow)
>> 
>> Thanks,
>> Michael
>
> Michael McMahon has updated the pull request incrementally with one additional commit since the last revision:
> 
>   update to be compatible with JDK-8297030

Changes requested by dfuchs (Reviewer).

src/java.net.http/share/classes/module-info.java line 76:

> 74:  * <li><p><b>{@systemProperty jdk.httpclient.HttpClient.log}</b> (default: none)<br>
> 75:  * Enables high-level logging of various events through the Java Logging API (which is contained in the
> 76:  * package java.util.logging). The value contains a comma-separated list of any of the following items:

java.util.logging is actually only the default backend, so I'd suggest to reword as:

 * Enables high-level logging of various events through the {@linkplain java.lang.System.Logger Platform Logging API}.
 * The value contains ...
 ```

src/java.net.http/share/classes/module-info.java line 94:

> 92:  * </ul><br>
> 93:  * Specifying an item adds it to the HTTP client's log. For example, if you specify the following value,
> 94:  * then the Java Logging API logs all possible HTTP Client events:<br>

Same here - use `Platform Logging API` rather than `Java Logging API`.

src/java.net.http/share/classes/module-info.java line 102:

> 100:  * The number of seconds to keep idle HTTP connections alive in the keep alive cache. This property
> 101:  * applies to both HTTP/1.1 and HTTP/2. The value for HTTP/2 can be overridden with the
> 102:  * jdk.httpclient.keepalive.timeout.h2 property.

`{@code jdk.httpclient.keepalive.timeout.h2}` ?

src/java.net.http/share/classes/module-info.java line 106:

> 104:  * <li><p><b>{@systemProperty jdk.httpclient.keepalive.timeout.h2}</b> (default: see below)<br>
> 105:  * The number of seconds to keep idle HTTP/2 connections alive. If not set, then the
> 106:  * jdk.httpclient.keepalive.timeout setting is used.

`{@code jdk.httpclient.keepalive.timeout}` ?

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

PR: https://git.openjdk.org/jdk/pull/11241