Re: RFR[8251496]: ‘Fix doclint warnings in jdk.net.httpserver’

[Roger Riggs]

Hi Patrick,

Usually, the @param and @returns text does not edit a period (unless it 
is a complete sentence).

The indentation of the new comment blocks is in a few places off.
I.e.

+++ b/src/jdk.httpserver/share/classes/com/sun/net/httpserver/Headers.java	Mon Aug 31 16:57:06 2020 +0100
@@ -65,6 +65,9 @@
  
          HashMap<String,List<String>> map;
  
+        /**
+        * Creates an empty instance of Headers.
+        */


HttpServer.java: 109

+     * @throws IOException if I/O error occurs"   -> "+     * @throws IOException if *an* I/O error occurs



The block is interesting but looks to be obsolete. HttpsParameters.java: 
26...

  //BEGIN_TIGER_EXCLUDE
-import javax.net.ssl.SSLParameters;
  //END_TIGER_EXCLUDE


And will need to be updated as a new PR under git.

Thanks, Roger


On 8/31/20 12:12 PM, Patrick Concannon wrote:
> Hi,
>
> Could someone please review my doc-only fix for JDK-8251496 - ‘Fix doclint warnings in jdk.net.httpserver’ ?
>
> This fix addresses the warnings generated by `javadoc -Xdoclint` due to missing/incomplete API documentation for several classes within `jdk.net.httpserver`.
>
> issue: https://bugs.openjdk.java.net/browse/JDK-8251496
> webrev:  http://cr.openjdk.java.net/~pconcannon/8251496/webrevs/webrev.00/
> CSR: https://bugs.openjdk.java.net/browse/JDK-8252585
>
> Kind regards,
> Patrick

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://mail.openjdk.java.net/pipermail/net-dev/attachments/20200908/a56ca622/attachment-0001.htm>