Cook comments before displaying in the IDE

Author: Duhemm

language-server/src/dotty/tools/languageserver/DottyLanguageServer.scala

@@ -22,6 +22,7 @@ import core._, core.Decorators.{sourcePos => _, _}
 import Comments._, Contexts._, Flags._, Names._, NameOps._, Symbols._, SymDenotations._, Trees._, Types._
 import classpath.ClassPathEntries
 import reporting._, reporting.diagnostic.MessageContainer
+import typer.Typer
 import util._
 import interactive._, interactive.InteractiveDriver._
 import Interactive.Include
@@ -347,7 +348,16 @@ class DottyLanguageServer extends LanguageServer
     if (tpw == NoType) new Hover
     else {
       val symbol = Interactive.enclosingSourceSymbol(trees, pos)
-      val docComment = ctx.docCtx.flatMap(_.docstring(symbol))
+      val docComment = ctx.docCtx.flatMap(_.docstring(symbol)).map {
+        case comment if !comment.isExpanded =>
+          val typer = new Typer()
+          val owner = symbol.owner
+          val cookingCtx = ctx.withOwner(owner)
+          typer.cookComment(symbol, owner)(cookingCtx)
+          ctx.docCtx.get.docstring(symbol).get
+        case comment =>
+          comment
+      }
       val markedStrings = docMarkedStrings(docComment, tpw.show.toString)
       new Hover(markedStrings.map(JEither.forRight(_)).asJava, null)
     }
@@ -468,9 +478,11 @@ object DottyLanguageServer {
 
   private def docMarkedStrings(comment: Option[Comment], typeInfo: String): List[lsp4j.MarkedString] = {
 
-    val docHover = comment.map { comment =>
-      new lsp4j.MarkedString("scala", comment.raw)
-    }
+    val docHover =
+      for {
+        cmt <- comment
+        body <- cmt.expandedBody
+      } yield new lsp4j.MarkedString("scala", body)
 
     val typeInfoHover = new lsp4j.MarkedString()
     typeInfoHover.setValue(typeInfo)

language-server/test/dotty/tools/languageserver/HoverTest.scala

@@ -78,4 +78,16 @@ class HoverTest {
       .hover(m6 to m7, "Int" :: Nil)
   }
 
+  @Test def documentationIsCooked: Unit = {
+    code"""/** A class: $$Variable
+          | *  @define Variable Test
+          | */
+          |class ${m1}Foo${m2}
+          |/** $$Variable */
+          |class ${m3}Bar${m4} extends Foo
+        """.withSource
+      .hover(m1 to m2, "Foo" :: "/** A class: Test\n *  */" :: Nil)
+      .hover(m3 to m4, "Bar" :: "/** Test */" :: Nil)
+  }
+
 }