Skip to content

scaladoc silently discards doc comment on abstract member #6598

Open
@scabug

Description

@scabug

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.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions