Skip to content

Feature request: a way to suppress useless companion objects from javadoc #200

@mikehearn

Description

@mikehearn

Companion objects that consist of no fields and all @JvmStatic methods are effectively redundant, especially for Java users who will want to use static methods as normal. Currently these things clutter up the generated javadocs, making them ugly.

Whilst arguably the Kotlin compiler should optimise them out entirely in this case, that's a separate discussion (which I raised on youtrack). For now it'd be nice to recognise this pattern and suppress emission of references to the companions.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementAn issue for a feature or an overall improvementformat: JavadocAn issue/PR related to Dokka's Javadoc output format or the Javadoc comments in generalplugin: kotlin-as-javaAn issue/PR related to Dokka's kotlin-as-java plugin

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions