search

scala / bug

Scala 2 bug reports only. Please, no questions — proper bug reports only.
https://scala-lang.org
232 stars 21 forks source link

scaladoc silently discards doc comment on abstract member #6598

Open scabug opened 12 years ago

scabug commented 12 years ago

I discovered when modifying the scaladoc for Stream that an entire comment will be dropped if the method is abstract in the class with a concrete implementation inherited from elsewhere. This is the case with "tail", for instance, which has a doc comment nobody will see. The doc comment is mostly redundant, but even a non-redundant one which uses @inheritdoc and adds a small Stream-specific note is discarded.

Concrete methods override abstract ones, but documentation written specifically for class "Foo" is more relevant to "Foo" than any inherited documentation can ever be.

scabug commented 12 years ago

Imported From: https://issues.scala-lang.org/browse/SI-6598?orig=1 Reporter: @paulp Affected Versions: 2.10.0