Skip to content

Option to always render documentation for exported items #235

@killercup

Description

@killercup

I'm think about my JS projects in terms of modules (basically, files) that import other modules and export data or functions.

Since ES2015 syntax makes it pretty obvious which values are exported, I'd love to have an option for documentation.js to always render documentation for those values, even if they don't have a JSDoc comment (!). I know this may not always look great, but it's better than not having a complete list of the API surface.

For items without a doc comment, using humanized exported name (camelCase/snake_case to separate words) as a title should suffice.

(Similarly, I'd like to have an option to hide non-exported items in the documentation. That's not really important to me, though.)

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions