Skip to content

Add publicOnly option to other rules #725

Open
@DMartens

Description

@DMartens

Motivation

Add the publicOnly option from require-jsdoc to other rules.
Personally I want to require jsdoc for all top-level functions for the types and only require descriptions when the functions are exported.
I am willing to create a PR for this functionality.

Current behavior

Currently only the rule require-jsdoc has the option publicOnly

Desired behavior

Add the same option to other rules. I would add them to require-description, require-param-description and require-returns-description.

Alternatives considered

This could also be a new rule as otherwise many other rules would be modified.
This new rule has a list of tag names requiring a description as an option.


Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions