From 0ced42bddb0d5eb93f280e1ebcc0329718242088 Mon Sep 17 00:00:00 2001
From: Trask Stalnaker <trask.stalnaker@gmail.com>
Date: Sun, 24 Nov 2024 09:41:58 -0800
Subject: [PATCH] Fix javadoc warning

---
 crates/weaver_forge/README.md                    |  1 -
 .../expected_output/comment_format/example.java  |  2 --
 crates/weaver_forge/src/extensions/code.rs       |  7 -------
 crates/weaver_forge/src/formats/html.rs          | 16 +++++++++-------
 4 files changed, 9 insertions(+), 17 deletions(-)

diff --git a/crates/weaver_forge/README.md b/crates/weaver_forge/README.md
index 8d90df92..42f4993c 100644
--- a/crates/weaver_forge/README.md
+++ b/crates/weaver_forge/README.md
@@ -757,7 +757,6 @@ The resulting comment in JavaDoc format would be:
    * This is a note about the attribute {@code attr}. It can be multiline.
    * <p>
    * It can contain a list:
-   * <p>
    * <ul>
    *   <li>item <strong>1</strong>,
    *   <li>lorem ipsum dolor sit amet, consectetur
diff --git a/crates/weaver_forge/expected_output/comment_format/example.java b/crates/weaver_forge/expected_output/comment_format/example.java
index 79aa4f3a..c657c358 100644
--- a/crates/weaver_forge/expected_output/comment_format/example.java
+++ b/crates/weaver_forge/expected_output/comment_format/example.java
@@ -60,7 +60,6 @@
    * <p>
    * If a specific domain defines its own set of error identifiers (such as HTTP or gRPC status codes),
    * it's RECOMMENDED to:
-   * <p>
    * <ul>
    *   <li>Use a domain-specific attribute
    *   <li>Set {@code error.type} to capture all errors, regardless of whether they are defined within the domain-specific set or not
@@ -77,7 +76,6 @@
    * This is a note about the attribute {@code attr}. It can be multiline.
    * <p>
    * It can contain a list:
-   * <p>
    * <ul>
    *   <li>item <strong>1</strong>,
    *   <li>lorem ipsum dolor sit amet, consectetur
diff --git a/crates/weaver_forge/src/extensions/code.rs b/crates/weaver_forge/src/extensions/code.rs
index 90c87155..736e3561 100644
--- a/crates/weaver_forge/src/extensions/code.rs
+++ b/crates/weaver_forge/src/extensions/code.rs
@@ -364,7 +364,6 @@ it's RECOMMENDED to:
    * <p>
    * If a specific domain defines its own set of error identifiers (such as HTTP or gRPC status codes),
    * it's RECOMMENDED to:
-   * <p>
    * <ul>
    *   <li>Use a domain-specific attribute
    *   <li>Set {@code error.type} to capture all errors, regardless of whether they are defined within the domain-specific set or not
@@ -395,7 +394,6 @@ it's RECOMMENDED to:
    * <p>
    * If a specific domain defines its own set of error identifiers (such as HTTP or gRPC status codes),
    * it's RECOMMENDED to:
-   * <p>
    * <ul>
    *   <li>Use a domain-specific attribute
    *   <li>Set {@code error.type} to capture all errors, regardless of whether they are defined within the domain-specific set or not
@@ -426,7 +424,6 @@ it's RECOMMENDED to:
    * <p>
    * If a specific domain defines its own set of error identifiers (such as HTTP or gRPC status codes),
    * it's RECOMMENDED to:
-   * <p>
    * <ul>
    *   <li>Use a domain-specific attribute
    *   <li>Set {@code error.type} to capture all errors, regardless of whether they are defined within the domain-specific set or not
@@ -457,7 +454,6 @@ it's RECOMMENDED to:
 		 * <p>
 		 * If a specific domain defines its own set of error identifiers (such as HTTP or gRPC status codes),
 		 * it's RECOMMENDED to:
-		 * <p>
 		 * <ul>
 		 *   <li>Use a domain-specific attribute
 		 *   <li>Set {@code error.type} to capture all errors, regardless of whether they are defined within the domain-specific set or not
@@ -476,7 +472,6 @@ it's RECOMMENDED to:
  * The {@code error.type}
  * SHOULD be predictable, and
  * SHOULD have low cardinality.
- *
  * <p>
  * When {@code error.type} is
  * set to a type (e.g., an
@@ -484,7 +479,6 @@ it's RECOMMENDED to:
  * canonical class name
  * identifying the type within
  * the artifact SHOULD be used.
- *
  * <p>
  * Instrumentations SHOULD
  * document the list of errors
@@ -514,7 +508,6 @@ it's RECOMMENDED to:
  * identifiers (such as HTTP or
  * gRPC status codes), it's
  * RECOMMENDED to:
- * <p>
  * <ul>
  *   <li>Use a domain-specific
  *   attribute
diff --git a/crates/weaver_forge/src/formats/html.rs b/crates/weaver_forge/src/formats/html.rs
index 903a021c..59c427bf 100644
--- a/crates/weaver_forge/src/formats/html.rs
+++ b/crates/weaver_forge/src/formats/html.rs
@@ -70,7 +70,7 @@ struct RenderContext {
     // node following the current one in the AST traversal. This field contains
     // such a tag left by the previous node, which must be added by the current
     // node during rendering, if it exists.
-    leftover_tag: Option<String>,
+    add_old_style_paragraph: bool,
 
     // Context for wrapping words.
     word_wrap: WordWrapContext,
@@ -80,7 +80,7 @@ impl RenderContext {
     fn new(cfg: &WordWrapConfig) -> Self {
         Self {
             html: Default::default(),
-            leftover_tag: Default::default(),
+            add_old_style_paragraph: Default::default(),
             word_wrap: WordWrapContext::new(cfg),
         }
     }
@@ -243,8 +243,12 @@ impl<'source> HtmlRenderer<'source> {
         format: &str,
         options: &HtmlRenderOptions,
     ) -> Result<(), Error> {
-        if let Some(tag) = ctx.leftover_tag.take() {
-            ctx.push_unbroken_ln(&tag, indent)?;
+        if ctx.add_old_style_paragraph {
+            ctx.pushln(indent)?;
+            if !matches!(md_node, Node::List(_)) {
+                ctx.push_unbroken_ln("<p>", indent)?;
+            }
+            ctx.add_old_style_paragraph = false;
         }
 
         match md_node {
@@ -264,7 +268,7 @@ impl<'source> HtmlRenderer<'source> {
                     self.write_html_to(ctx, indent, child, format, options)?;
                 }
                 if options.old_style_paragraph {
-                    ctx.leftover_tag = Some("\n<p>".to_owned());
+                    ctx.add_old_style_paragraph = true;
                 } else {
                     ctx.push_unbroken_ln("</p>", indent)?;
                 }
@@ -544,7 +548,6 @@ If the operation has completed successfully, instrumentations SHOULD NOT set {@c
 <p>
 If a specific domain defines its own set of error identifiers (such as HTTP or gRPC status codes),
 it's RECOMMENDED to:
-<p>
 <ul>
   <li>Use a domain-specific attribute
   <li>Set {@code error.type} to capture all errors, regardless of whether they are defined within the domain-specific set or not.
@@ -766,7 +769,6 @@ its own set of error
 identifiers (such as HTTP or
 gRPC status codes), it's
 RECOMMENDED to:
-<p>
 <ul>
   <li>Use a domain-specific
   attribute