Cannot add package description in ScalaDoc (Scala 3)

Question

I cannot add a package description in ScalaDoc with Scala 3

/** package description */
package foo {
    /** some scaladoc comment */
    def method():A = ???
}

Then I generate the doc with sbt (1.5.3)

sbt> doc

I don't get the description of the package itself in the index.html file, but only the description of the method inside the package.

Maybe it is not possible anymore, as the scala 3 library do not use package comment, and `package object` is becoming deprecated — lepaincestbon, Jun 13 '21 at 16:52

score 5 · Accepted Answer · edited Nov 20 '21 at 01:18

5

I finally found the answer

Scaladoc comments can go before fields, methods, classes, traits, objects. For now, scaladoc doesn't support straightforward solution to document packages. There is a dedicated github issue, where you can check the current status of the problem.

https://github.com/lampepfl/dotty/issues/11284

edited Nov 20 '21 at 01:18

Karl Bielefeldt

47,314
10
60
94

answered Jun 13 '21 at 17:00

lepaincestbon

331
1
5

I'm also interested in this issue, but the URL above is broken. – Michel Charpentier Nov 19 '21 at 18:17
@MichelCharpentier, I updated the link. – Karl Bielefeldt Nov 20 '21 at 01:24

Cannot add package description in ScalaDoc (Scala 3)

1 Answers1