RFR: 8253475: Javadoc clean up in HttpExchange and HttpServer

[Daniel Fuchs]

On Mon, 5 Oct 2020 14:38:35 GMT, Patrick Concannon <pconcannon at openjdk.org> wrote:

> Hi,
> 
> Could someone please review my doc-only fix for JDK-8253475 - 'Javadoc clean up in HttpExchange and HttpServer' ?
> 
> This fix is set of formatting changes intended to clean up the javadoc of the following classes :
> 
> `com.sun.net.httpserver.HttpExchange`
> `com.sun.net.httpserver.HttpServer`
> 
> This issue is a sub-task of [JDK-8252822](https://bugs.openjdk.java.net/browse/JDK-8252822)
> 
> Kind regards,
> Patrick

src/jdk.httpserver/share/classes/com/sun/net/httpserver/HttpExchange.java line 46:

> 44:  *     <li>{@link #getRequestHeaders()} to examine the request headers (if
> 45:  *     needed).
> 46:  *     <li>{@link #getRequestBody()} returns a {@link java.io.InputStream} for

Hi Patrick, could you double check what the text of the link is in the generated javadoc here? Is it a
`java.io.InputStream` or just a `InputStream` (in which case `a` should be `an`)

src/jdk.httpserver/share/classes/com/sun/net/httpserver/HttpExchange.java line 275:

> 273:
> 274:     /**
> 275:      * Used by {@linkplain #Filter Filters} to wrap either (or both) of this exchange's InputStream

Are you sure about the # here? Can you double check that the generated link is working? InputStream should be {@code
InputStream}. OutputStream below should be {@code OutputStream}.

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

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