Merge pull request #4573 from dotty-staging/fix/dottydoc-package-doc

Dottydoc: Keep documentation on package objects

Author: allanrenucci

doc-tool/src/dotty/tools/dottydoc/DocCompiler.scala

@@ -30,8 +30,8 @@ class DocCompiler extends Compiler {
     List(new DocImplicitsPhase) ::
     List(new DocASTPhase) ::
     List(DocMiniTransformations(new UsecasePhase,
-                                new DocstringPhase,
-                                new PackageObjectsPhase,
+                                new DocstringPhase)) ::
+    List(DocMiniTransformations(new PackageObjectsPhase,
                                 new LinkReturnTypes,
                                 new LinkParamListTypes,
                                 new LinkImplicitlyAddedTypes,

doc-tool/test/SimpleComments.scala

@@ -49,4 +49,17 @@ class TestSimpleComments extends DottyDocTest {
       assertEquals(traitCmt, "<p>Hello, world!</p>")
     }
   }
+
+  @Test def commentOnPackageObject = {
+    val source =
+      """
+      |/** Hello, world! */
+      |package object foobar { class A }
+      """.stripMargin
+
+    checkSource(source) { packages =>
+      val packageCmt = packages("foobar").comment.get.body
+      assertEquals("<p>Hello, world!</p>", packageCmt)
+    }
+  }
 }