scala3 icon indicating copy to clipboard operation
scala3 copied to clipboard

Scaladoc doesn't transfer or link documentation for exports

Open markehammons opened this issue 3 years ago • 1 comments

Compiler version

3.1.0

Minimized code

package io.gitlab.mypackage.components

object Tools:
  /**I've documented this tool
  */
  def sharedTool = println("hello world")

  def nonSharedTool = println("i don't get shared")

in syntax.scala

package io.gitlab.mypackage

export Tools.sharedTool

Output

Scala doc shows sharedTool as an export to mypackage, but no documentation, and clicking it doesn't take you to the documentation that's available in components.Tools.

Expectation

Documentation should not be lost on exported definitions.

You can look at the docs here: https://mhammons.gitlab.io/slinc/io/gitlab/mhammons/slinc.html#AsciiChar-0

asAsciiChar is an exported extension method on char. There's no documentation, no link to the original definition. The original definition is documented.

markehammons avatar Jan 25 '22 09:01 markehammons

Is this still a thing? Or is the report stale?

Thanks!

KaappoRaivio avatar Jun 13 '25 11:06 KaappoRaivio