Skip to content
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

Scaladoc omits file name from @inheritDoc warning, does not "count" warning #13068

Closed
jphmrst opened this issue Jul 13, 2021 · 0 comments · Fixed by #13199
Closed

Scaladoc omits file name from @inheritDoc warning, does not "count" warning #13068

jphmrst opened this issue Jul 13, 2021 · 0 comments · Fixed by #13199
Assignees
Milestone

Comments

@jphmrst
Copy link

jphmrst commented Jul 13, 2021

Compiler version

3.0.1

Minimized code

class Test {
  /** {@inheritDoc} */
  def f: Unit = { }
}

Output

Output via sbt:

<43..43>: the comment for method f contains @inheritdoc, but no parent comment is available to inherit from.

Expectation

First, I would expect it to mention the file name --- important in a larger project with many uses of the same method name.

Second, note that the sbt output is not prefixed [warn] or [error] --- seems like sbt should pick up this issue as one or the other. It is not included in the total-warnings count.

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

Successfully merging a pull request may close this issue.

4 participants