This is an automated email from the ASF dual-hosted git repository.
guozhang pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/kafka.git
The following commit(s) were added to refs/heads/trunk by this push:
new 6d7723f073 MINOR: fix html generation syntax errors (#12094)
6d7723f073 is described below
commit 6d7723f073ad0b935b02792be9aa4fd49b581b50
Author: Mike Tobola <mtob...@gmail.com>
AuthorDate: Tue Apr 26 16:51:12 2022 -0700
MINOR: fix html generation syntax errors (#12094)
The html document generation has some errors in it, specifically related to
protocols. The two issues identified and resolved are:
* Missing </tbody> closing tags added
* Invalid usage of a <p> tag as a wrapper element for <table> elements.
Changed the <p> tag to be a <div>.
Tested by running ./gradlew siteDocsTar and observing that the output was
properly formed.
Reviewers: Guozhang Wang <wangg...@gmail.com>
---
.../main/java/org/apache/kafka/common/protocol/ApiKeys.java | 2 +-
.../src/main/java/org/apache/kafka/common/protocol/Errors.java | 2 +-
.../main/java/org/apache/kafka/common/protocol/Protocol.java | 10 +++++-----
.../main/java/org/apache/kafka/common/protocol/types/Type.java | 2 +-
4 files changed, 8 insertions(+), 8 deletions(-)
diff --git
a/clients/src/main/java/org/apache/kafka/common/protocol/ApiKeys.java
b/clients/src/main/java/org/apache/kafka/common/protocol/ApiKeys.java
index 399b631d76..628c9407cc 100644
--- a/clients/src/main/java/org/apache/kafka/common/protocol/ApiKeys.java
+++ b/clients/src/main/java/org/apache/kafka/common/protocol/ApiKeys.java
@@ -241,7 +241,7 @@ public enum ApiKeys {
b.append("</td>");
b.append("</tr>\n");
}
- b.append("</table>\n");
+ b.append("</tbody></table>\n");
return b.toString();
}
diff --git a/clients/src/main/java/org/apache/kafka/common/protocol/Errors.java
b/clients/src/main/java/org/apache/kafka/common/protocol/Errors.java
index f48ae6c233..5db9717906 100644
--- a/clients/src/main/java/org/apache/kafka/common/protocol/Errors.java
+++ b/clients/src/main/java/org/apache/kafka/common/protocol/Errors.java
@@ -500,7 +500,7 @@ public enum Errors {
b.append("</td>");
b.append("</tr>\n");
}
- b.append("</table>\n");
+ b.append("</tbody></table>\n");
return b.toString();
}
diff --git
a/clients/src/main/java/org/apache/kafka/common/protocol/Protocol.java
b/clients/src/main/java/org/apache/kafka/common/protocol/Protocol.java
index d455b26eb2..a75eb0661d 100644
--- a/clients/src/main/java/org/apache/kafka/common/protocol/Protocol.java
+++ b/clients/src/main/java/org/apache/kafka/common/protocol/Protocol.java
@@ -112,7 +112,7 @@ public class Protocol {
b.append("</td>");
b.append("</tr>\n");
}
- b.append("</table>\n");
+ b.append("</tbody></table>\n");
}
public static String toHtml() {
@@ -148,7 +148,7 @@ public class Protocol {
Schema schema = requests[i];
// Schema
if (schema != null) {
- b.append("<p>");
+ b.append("<div>");
// Version header
b.append("<pre>");
b.append(key.name);
@@ -159,7 +159,7 @@ public class Protocol {
b.append("</pre>");
schemaToFieldTableHtml(requests[i], b);
}
- b.append("</p>\n");
+ b.append("</div>\n");
}
// Responses
@@ -169,7 +169,7 @@ public class Protocol {
Schema schema = responses[i];
// Schema
if (schema != null) {
- b.append("<p>");
+ b.append("<div>");
// Version header
b.append("<pre>");
b.append(key.name);
@@ -180,7 +180,7 @@ public class Protocol {
b.append("</pre>");
schemaToFieldTableHtml(responses[i], b);
}
- b.append("</p>\n");
+ b.append("</div>\n");
}
}
diff --git
a/clients/src/main/java/org/apache/kafka/common/protocol/types/Type.java
b/clients/src/main/java/org/apache/kafka/common/protocol/types/Type.java
index 46a59bd082..4af74dbf4c 100644
--- a/clients/src/main/java/org/apache/kafka/common/protocol/types/Type.java
+++ b/clients/src/main/java/org/apache/kafka/common/protocol/types/Type.java
@@ -1120,7 +1120,7 @@ public abstract class Type {
b.append("</td>");
b.append("</tr>\n");
}
- b.append("</table>\n");
+ b.append("</tbody></table>\n");
return b.toString();
}
