Merge pull request scala#5681 from Philippus/issue/9704

SI-9704 don't add a closing HtmlTag if it is already closed

Author: lrytz

src/scaladoc/scala/tools/nsc/doc/base/comment/Body.scala

@@ -74,9 +74,8 @@ object EntityLink {
   def unapply(el: EntityLink): Option[(Inline, LinkTo)] = Some((el.title, el.link))
 }
 final case class HtmlTag(data: String) extends Inline {
-  private val Pattern = """(?ms)\A<(/?)(.*?)[\s>].*\z""".r
   private val (isEnd, tagName) = data match {
-    case Pattern(s1, s2) =>
+    case HtmlTag.Pattern(s1, s2) =>
       (! s1.isEmpty, Some(s2.toLowerCase))
     case _ =>
       (false, None)
@@ -86,8 +85,13 @@ final case class HtmlTag(data: String) extends Inline {
     isEnd && tagName == open.tagName
   }
 
+  def close = tagName collect {
+    case name if !HtmlTag.TagsNotToClose(name) && !data.endsWith(s"</$name>") => HtmlTag(s"</$name>")
+  }
+}
+object HtmlTag {
+  private val Pattern = """(?ms)\A<(/?)(.*?)[\s>].*\z""".r
   private val TagsNotToClose = Set("br", "img")
-  def close = tagName collect { case name if !TagsNotToClose(name) => HtmlTag(s"</$name>") }
 }
 
 /** The summary of a comment, usually its first sentence. There must be exactly one summary per body. */

test/scaladoc/run/SI-9704.check

@@ -0,0 +1,4 @@
+Chain(List(Chain(List(Text(Demonstrates a scala issue in which the closing link tag is duplicated), Text(
+), HtmlTag(<a href="https://link">title</a>), Text(
+), Text()))))
+Done.

test/scaladoc/run/SI-9704.scala

@@ -0,0 +1,22 @@
+import scala.tools.nsc.doc.model._
+import scala.tools.partest.ScaladocModelTest
+
+object Test extends ScaladocModelTest {
+  override def code = """
+  object Foo {
+    /**
+    * Demonstrates a scala issue in which the closing link tag is duplicated
+    * <a href="https://link">title</a>
+    */
+    def bar = ???
+  }
+  """
+
+  def scaladocSettings = ""
+
+  def testModel(root: Package) = {
+    import access._
+    val thing = root._object("Foo")._method("bar")
+    println(thing.comment.get.short)
+  }
+}