Skip to content

Scaladoc doesn't transfer or link documentation for exports #14342

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
markehammons opened this issue Jan 25, 2022 · 1 comment
Open

Scaladoc doesn't transfer or link documentation for exports #14342

markehammons opened this issue Jan 25, 2022 · 1 comment

Comments

@markehammons
Copy link

markehammons commented Jan 25, 2022

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 markehammons changed the title Scaladoc doesn't transfer or link documentation for export Scaladoc doesn't transfer or link documentation for exports Jan 25, 2022
@KaappoRaivio
Copy link

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

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants