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

@inheritdoc Warnings Generated by Scaladoc #5599

Closed
scabug opened this issue Mar 22, 2012 · 2 comments
Closed

@inheritdoc Warnings Generated by Scaladoc #5599

scabug opened this issue Mar 22, 2012 · 2 comments
Assignees
Labels
Milestone

Comments

@scabug
Copy link

@scabug scabug commented Mar 22, 2012

When generating Scaladoc, I get a deluge of warnings about inheritdoc:

 [scaladoc] /Users/heather/git/scala/src/library/scala/collection/GenIterableLike.scala:142: The "@tparam B" annotation of the method zipAll comment contains @inheritdoc, but the corresponding section in the parent is not defined.
 [scaladoc]   def zipAll[B, A1 >: A, That](that: GenIterable[B], thisElem: A1, thatElem: B)(implicit bf: CBF[Repr, (A1, B), That]): That
 [scaladoc]       ^
 [scaladoc] /Users/heather/git/scala/src/library/scala/collection/GenIterableLike.scala:111: The "@example" annotation of the method zipWithIndex comment contains @inheritdoc, but the corresponding section in the parent is not defined.
 [scaladoc]   def zipWithIndex[A1 >: A, That](implicit bf: CBF[Repr, (A1, Int), That]): That
 [scaladoc]       ^
 [scaladoc] /Users/heather/git/scala/src/library/scala/collection/parallel/ParIterableLike.scala:778: The "@tparam B" annotation of the method zipAll comment contains @inheritdoc, but the corresponding section in the parent is not defined.
 [scaladoc]   def zipAll[S, U >: T, That](that: GenIterable[S], thisElem: U, thatElem: S)(implicit bf: CanBuildFrom[Repr, (U, S), That]): That = if (bf(repr).isCombiner && that.isParSeq) {
 [scaladoc]       ^
 [scaladoc] /Users/heather/git/scala/src/library/scala/collection/parallel/ParIterableLike.scala:776: The "@example" annotation of the method zipWithIndex comment contains @inheritdoc, but the corresponding section in the parent is not defined.
 [scaladoc]   def zipWithIndex[U >: T, That](implicit bf: CanBuildFrom[Repr, (U, Int), That]): That = this zip immutable.ParRange(0, size, 1, false)

...

@scabug

This comment has been minimized.

Copy link
Author

@scabug scabug commented Mar 22, 2012

@scabug

This comment has been minimized.

Copy link
Author

@scabug scabug commented Mar 26, 2012

@VladUreche said:
Fixed in 2c58044335.

@scabug scabug closed this Mar 26, 2012
@scabug scabug added this to the 2.10.0-M2 milestone Apr 7, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
2 participants
You can’t perform that action at this time.