Merge pull request #11962 from BarkingBad/scaladoc/fix-briefs

Fix bug with doubling comments in Scaladoc
scala · Apr 6, 2021 · 39422ce · 39422ce
2 parents 16776c8 + 2f3eb3c
commit 39422ce
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 18 deletions.
diff --git a/scaladoc/src/dotty/tools/scaladoc/renderers/MemberRenderer.scala b/scaladoc/src/dotty/tools/scaladoc/renderers/MemberRenderer.scala
@@ -92,24 +92,26 @@ class MemberRenderer(signatureRenderer: SignatureRenderer)(using DocContext) ext
     Seq(dt("Deprecated"), dd(content:_*))
   }
 
-  def memberInfo(m: Member): Seq[AppliedTag] =
+  def memberInfo(m: Member, withBrief: Boolean = false): Seq[AppliedTag] =
     val comment = m.docs
     val bodyContents = m.docs.fold(Nil)(e => renderDocPart(e.body) :: Nil)
 
     Seq(
-      div(cls := "documentableBrief doc")(comment.flatMap(_.short).fold("")(renderDocPart)),
-      div(cls := "cover")(
-        div(cls := "doc")(bodyContents),
-        dl(cls := "attributes")(
-          docAttributes(m),
-          companion(m),
-          deprecation(m),
-          defintionClasses(m),
-          inheritedFrom(m),
-          source(m),
+      Option.when(withBrief)(div(cls := "documentableBrief doc")(comment.flatMap(_.short).fold("")(renderDocPart))),
+      Some(
+        div(cls := "cover")(
+          div(cls := "doc")(bodyContents),
+          dl(cls := "attributes")(
+            docAttributes(m),
+            companion(m),
+            deprecation(m),
+            defintionClasses(m),
+            inheritedFrom(m),
+            source(m),
+          )
         )
       )
-    )
+    ).flatten
 
   private def originInfo(m: Member): Seq[TagArg] = m.origin match {
     case Origin.ImplicitlyAddedBy(name, dri) =>
@@ -170,7 +172,7 @@ class MemberRenderer(signatureRenderer: SignatureRenderer)(using DocContext) ext
         span(cls := "modifiers"), // just to have padding on left
         div(
           div(cls := "originInfo")(originInfo(member):_*),
-          div(cls := "memberDocumentation")(memberInfo(member)),
+          div(cls := "memberDocumentation")(memberInfo(member, withBrief = true)),
         )
       )
     )
@@ -382,7 +384,8 @@ class MemberRenderer(signatureRenderer: SignatureRenderer)(using DocContext) ext
 
     div(
       intro,
-      memberInfo(m),
+      memberInfo(m, withBrief = false),
       classLikeParts(m),
       buildDocumentableFilter, // TODO Need to make it work in JS :(
-      buildMembers(m))
+      buildMembers(m)
+    )
diff --git a/scaladoc/test/dotty/tools/scaladoc/BaseHtmlTest.scala b/scaladoc/test/dotty/tools/scaladoc/BaseHtmlTest.scala
@@ -12,7 +12,7 @@ import dotty.tools.scaladoc.test.BuildInfo
 import util.IO
 
 class BaseHtmlTest:
-  val unresolvedLinkSelector = ".documentableBrief span[data-unresolved-link]"
+  val unresolvedLinkSelector = ".documentableBrief span[data-unresolved-link], .cover span[data-unresolved-link]"
 
   def projectName = "Test Project Name"
   def  projectVersion = "1.0.1-M1"
@@ -66,4 +66,4 @@ class BaseHtmlTest:
     val path = summon[ProjectContext].path.resolve(pathStr)
     assertTrue(s"File at $path does not exisits!", Files.exists(path))
     val document = Jsoup.parse(IO.read(path))
-    op(DocumentContext(document, path))
+    op(DocumentContext(document, path))
diff --git a/scaladoc/test/dotty/tools/scaladoc/tasty/comments/IntegrationTest.scala b/scaladoc/test/dotty/tools/scaladoc/tasty/comments/IntegrationTest.scala
@@ -8,7 +8,7 @@ abstract class BaseIntegrationTest(pck: String) extends BaseHtmlTest:
   @Test
   def testLinks: Unit =  withGeneratedDoc(pcks = Seq(pck, "commonlinks")) {
     def checkDocLinks(links: String*)(ctx: DocumentContext): Unit =
-      ctx.assertAttr(".documentableBrief a", "href", links:_*)
+      ctx.assertAttr(".documentableBrief a, .cover a", "href", links:_*)
       ctx.assertNotExists("unresolvedLinkSelector")
 
     def checkUnresolved(ctx: DocumentContext): Unit =