changeset 46052:30afc40a7f6a

8185669: Doc issues in assorted small jdk.* modules Reviewed-by: bpb, chegar
author jjg
date Tue, 01 Aug 2017 15:23:13 -0700
parents 59e8c76ca7ba
children 6f7e93cb432a
files jdk/src/jdk.httpserver/share/classes/com/sun/net/httpserver/HttpServer.java jdk/src/jdk.incubator.httpclient/share/classes/jdk/incubator/http/HttpResponse.java jdk/src/jdk.net/share/classes/jdk/net/NetworkPermission.java
diffstat 3 files changed, 31 insertions(+), 19 deletions(-) [+]
line wrap: on
line diff
--- a/jdk/src/jdk.httpserver/share/classes/com/sun/net/httpserver/HttpServer.java	Tue Aug 01 08:56:42 2017 -0700
+++ b/jdk/src/jdk.httpserver/share/classes/com/sun/net/httpserver/HttpServer.java	Tue Aug 01 15:23:13 2017 -0700
@@ -59,21 +59,29 @@
  * Paths are matched literally, which means that the strings are compared
  * case sensitively, and with no conversion to or from any encoded forms.
  * For example. Given a HttpServer with the following HttpContexts configured.
- * <table><caption style="display:none">description</caption>
- * <tr><td><i>Context</i></td><td><i>Context path</i></td></tr>
- * <tr><td>ctx1</td><td>"/"</td></tr>
- * <tr><td>ctx2</td><td>"/apps/"</td></tr>
- * <tr><td>ctx3</td><td>"/apps/foo/"</td></tr>
+ * <table class="striped"><caption style="display:none">description</caption>
+ * <thead>
+ * <tr><th scope="col"><i>Context</i></th><th scope="col"><i>Context path</i></th></tr>
+ * </thead>
+ * <tbody>
+ * <tr><th scope="row">ctx1</th><td>"/"</td></tr>
+ * <tr><th scope="row">ctx2</th><td>"/apps/"</td></tr>
+ * <tr><th scope="row">ctx3</th><td>"/apps/foo/"</td></tr>
+ * </tbody>
  * </table>
  * <p>
  * the following table shows some request URIs and which, if any context they would
  * match with.
- * <table><caption style="display:none">description</caption>
- * <tr><td><i>Request URI</i></td><td><i>Matches context</i></td></tr>
- * <tr><td>"http://foo.com/apps/foo/bar"</td><td>ctx3</td></tr>
- * <tr><td>"http://foo.com/apps/Foo/bar"</td><td>no match, wrong case</td></tr>
- * <tr><td>"http://foo.com/apps/app1"</td><td>ctx2</td></tr>
- * <tr><td>"http://foo.com/foo"</td><td>ctx1</td></tr>
+ * <table class="striped"><caption style="display:none">description</caption>
+ * <thead>
+ * <tr><th scope="col"><i>Request URI</i></th><th scope="col"><i>Matches context</i></th></tr>
+ * </thead>
+ * <tbody>
+ * <tr><th scope="row">"http://foo.com/apps/foo/bar"</th><td>ctx3</td></tr>
+ * <tr><th scope="row">"http://foo.com/apps/Foo/bar"</th><td>no match, wrong case</td></tr>
+ * <tr><th scope="row">"http://foo.com/apps/app1"</th><td>ctx2</td></tr>
+ * <tr><th scope="row">"http://foo.com/foo"</th><td>ctx1</td></tr>
+ * </tbody>
  * </table>
  * <p>
  * <b>Note about socket backlogs</b><p>
--- a/jdk/src/jdk.incubator.httpclient/share/classes/jdk/incubator/http/HttpResponse.java	Tue Aug 01 08:56:42 2017 -0700
+++ b/jdk/src/jdk.incubator.httpclient/share/classes/jdk/incubator/http/HttpResponse.java	Tue Aug 01 15:23:13 2017 -0700
@@ -618,7 +618,7 @@
          * on one of the given {@code CompletableFuture<Void}s which themselves complete
          * after all individual responses associated with the multi response
          * have completed, or after all push promises have been received.
-         * <p>
+         *
          * @implNote Implementations might follow the pattern shown below
          * <pre>
          * {@code
@@ -633,7 +633,6 @@
          *      }
          * }
          * </pre>
-         * <p>
          *
          * @param onComplete a CompletableFuture which completes after all
          * responses have been received relating to this multi request.
--- a/jdk/src/jdk.net/share/classes/jdk/net/NetworkPermission.java	Tue Aug 01 08:56:42 2017 -0700
+++ b/jdk/src/jdk.net/share/classes/jdk/net/NetworkPermission.java	Tue Aug 01 15:23:13 2017 -0700
@@ -36,25 +36,30 @@
  *
  * <table class="striped"><caption style="display:none">permission target name,
  *  what the target allows,and associated risks</caption>
+ * <thead>
  * <tr>
- *   <th>Permission Target Name</th>
- *   <th>What the Permission Allows</th>
- *   <th>Risks of Allowing this Permission</th>
+ *   <th scope="col">Permission Target Name</th>
+ *   <th scope="col">What the Permission Allows</th>
+ *   <th scope="col">Risks of Allowing this Permission</th>
  * </tr>
+ * </thead>
+ * <tbody>
  * <tr>
- *   <td>setOption.SO_FLOW_SLA</td>
+ *   <th scope="row">setOption.SO_FLOW_SLA</th>
  *   <td>set the {@link ExtendedSocketOptions#SO_FLOW_SLA SO_FLOW_SLA} option
  *       on any socket that supports it</td>
  *   <td>allows caller to set a higher priority or bandwidth allocation
  *       to sockets it creates, than they might otherwise be allowed.</td>
  * </tr>
  * <tr>
- *   <td>getOption.SO_FLOW_SLA</td>
+ *   <th scope="row">getOption.SO_FLOW_SLA</th>
  *   <td>retrieve the {@link ExtendedSocketOptions#SO_FLOW_SLA SO_FLOW_SLA}
  *       setting from any socket that supports the option</td>
  *   <td>allows caller access to SLA information that it might not
  *       otherwise have</td>
- * </tr></table>
+ * </tr>
+ * </tbody>
+ * </table>
  *
  * @see jdk.net.ExtendedSocketOptions
  *