8187448: 360 doc issues in jdwp-protocol.html

Reviewed-by: sspitsyn, amenkov
This commit is contained in:
Daniil Titov 2018-01-09 09:51:10 -08:00
parent 84d83a6998
commit 03c717a5a9
8 changed files with 42 additions and 31 deletions

View File

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 1998, 2017, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 1998, 2018, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -869,7 +869,6 @@ JDWP "Java(tm) Debug Wire Protocol"
"section in " "section in "
"<cite>The Java&trade; Virtual Machine Specification</cite>. " "<cite>The Java&trade; Virtual Machine Specification</cite>. "
"Since JDWP version 1.5." "Since JDWP version 1.5."
"<p>
(Out (Out
(referenceType refType "The reference type ID.") (referenceType refType "The reference type ID.")
) )
@ -2723,7 +2722,6 @@ JDWP "Java(tm) Debug Wire Protocol"
"<P>" "<P>"
"The events that are grouped in a composite event are restricted in the " "The events that are grouped in a composite event are restricted in the "
"following ways: " "following ways: "
"<P>"
"<UL>" "<UL>"
"<LI>Only with other thread start events for the same thread:" "<LI>Only with other thread start events for the same thread:"
" <UL>" " <UL>"

View File

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 1998, 2013, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 1998, 2018, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -30,8 +30,8 @@ import java.io.*;
class AbstractCommandNode extends AbstractNamedNode { class AbstractCommandNode extends AbstractNamedNode {
void document(PrintWriter writer) { void document(PrintWriter writer) {
writer.println("<h5><a name=\"" + context.whereC + "\">" + name + writer.println("<h5 id=\"" + context.whereC + "\">" + name +
" Command</a> (" + nameNode.value() + ")</h5>"); " Command (" + nameNode.value() + ")</h5>");
writer.println(comment()); writer.println(comment());
writer.println("<dl>"); writer.println("<dl>");
for (Node node : components) { for (Node node : components) {

View File

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 1998, 2013, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 1998, 2018, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -62,8 +62,8 @@ abstract class AbstractNamedNode extends Node {
} }
void document(PrintWriter writer) { void document(PrintWriter writer) {
writer.println("<h4><a name=" + name + ">" + name + writer.println("<h4 id=\"" + name + "\">" + name +
" Command Set</a></h4>"); " Command Set</h4>");
for (Node node : components) { for (Node node : components) {
node.document(writer); node.document(writer);
} }

View File

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 1998, 2013, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 1998, 2018, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -43,11 +43,11 @@ abstract class AbstractTypeListNode extends AbstractNamedNode {
if (components.isEmpty()) { if (components.isEmpty()) {
writer.println("<dd>(None)"); writer.println("<dd>(None)");
} else { } else {
writer.println("<dd><table border=1 cellpadding=3 cellspacing=0 width=\"90%\" summary=\"\"><tr>"); writer.println("<dd><table><tr>");
for (int i = maxStructIndent; i > 0; --i) { for (int i = maxStructIndent; i > 0; --i) {
writer.print("<th width=\"4%\">"); writer.print("<th style=\"width: 4%\">");
} }
writer.println("<th width=\"15%\"><th width=\"65%\">"); writer.println("<th style=\"width: 15%\"><th style=\"width: 65%\">");
writer.println(""); writer.println("");
for (Node node : components) { for (Node node : components) {
node.document(writer); node.document(writer);

View File

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 1998, 2013, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 1998, 2018, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -38,8 +38,8 @@ class CommandSetNode extends AbstractNamedNode {
} }
void document(PrintWriter writer) { void document(PrintWriter writer) {
writer.println("<h4><a name=\"" + context.whereC + "\">" + name + writer.println("<h4 id=\"" + context.whereC + "\">" + name +
" Command Set</a> (" + " Command Set (" +
nameNode.value() + ")</h4>"); nameNode.value() + ")</h4>");
writer.println(comment()); writer.println(comment());
for (Node node : components) { for (Node node : components) {
@ -51,11 +51,13 @@ class CommandSetNode extends AbstractNamedNode {
writer.print("<li><a href=\"#" + context.whereC + "\">"); writer.print("<li><a href=\"#" + context.whereC + "\">");
writer.println(name() + "</a> Command Set (" + writer.println(name() + "</a> Command Set (" +
nameNode.value() + ")"); nameNode.value() + ")");
writer.println("<ul>"); if (components.size() > 0) {
for (Node node : components) { writer.println("<ul>");
node.documentIndex(writer); for (Node node : components) {
node.documentIndex(writer);
}
writer.println("</ul>");
} }
writer.println("</ul>");
} }
void genJavaClassSpecifics(PrintWriter writer, int depth) { void genJavaClassSpecifics(PrintWriter writer, int depth) {

View File

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 1998, 2013, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 1998, 2018, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -54,15 +54,15 @@ class ConstantSetNode extends AbstractNamedNode {
} }
void document(PrintWriter writer) { void document(PrintWriter writer) {
writer.println("<h4><a name=\"" + context.whereC + "\">" + name + writer.println("<h4 id=\"" + context.whereC + "\">" + name +
" Constants</a></h4>"); " Constants</h4>");
writer.println(comment()); writer.println(comment());
writer.println("<dd><table border=1 cellpadding=3 cellspacing=0 width=\"90%\" summary=\"\"><tr>"); writer.println("<table><tr>");
writer.println("<th width=\"20%\"><th width=\"5%\"><th width=\"65%\">"); writer.println("<th style=\"width: 20%\"><th style=\"width: 5%\"><th style=\"width: 65%\">");
ConstantNode n; ConstantNode n;
for (Node node : components) { for (Node node : components) {
n = (ConstantNode)node; n = (ConstantNode)node;
writer.println("<a NAME=\"" + name + "_" + n.name + "\"></a>"); writer.println("<span id=\"" + name + "_" + n.name + "\"></span>");
n.document(writer); n.document(writer);
} }
writer.println("</table>"); writer.println("</table>");

View File

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2001, 2013, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 2001, 2018, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -43,7 +43,7 @@ class ErrorSetNode extends AbstractSimpleNode {
if (components.isEmpty()) { if (components.isEmpty()) {
writer.println("<dd>(None)"); writer.println("<dd>(None)");
} else { } else {
writer.println("<dd><table border=1 cellpadding=3 cellspacing=0 width=\"90%\" summary=\"\">"); writer.println("<dd><table>");
for (Node node : components) { for (Node node : components) {
node.document(writer); node.document(writer);
} }

View File

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 1998, 2013, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 1998, 2018, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -41,11 +41,22 @@ class RootNode extends AbstractNamedNode {
void document(PrintWriter writer) { void document(PrintWriter writer) {
writer.println("<!DOCTYPE html>"); writer.println("<!DOCTYPE html>");
writer.println("<html><head><title>" + comment() + "</title></head>"); writer.println("<html lang=\"en\">");
writer.println("<body bgcolor=\"white\">"); writer.println("<head>");
writer.println("<meta charset=\"utf-8\"/>");
writer.println("<title>" + comment() + "</title>");
writer.println("<style>");
writer.println("body {background-color:white;}");
writer.println("table {border: 1px solid grey; border-spacing:0px; border-collapse: separate; width: 90%;}");
writer.println("td, th {padding: 3px; border: 1px solid black;}");
writer.println("</style>");
writer.println("</head>");
writer.println("<body>");
writer.println("<ul>");
for (Node node : components) { for (Node node : components) {
node.documentIndex(writer); node.documentIndex(writer);
} }
writer.println("</ul>");
for (Node node : components) { for (Node node : components) {
node.document(writer); node.document(writer);
} }