microsoft / tsdoc

A doc comment standard for TypeScript
https://tsdoc.org/
MIT License
4.74k stars 131 forks source link

Is there a way to require documentation for all functions/classes? #228

Closed micthiesen closed 4 years ago

micthiesen commented 4 years ago

Apologies if this is documented somewhere, but if it was I couldn't find it.

I'm looking for a way to enforce that at least some level of documentation is provided for every function (or interface, React component, etc.) in my team's project. Thank you.

octogonz commented 4 years ago

Duplicate of https://github.com/microsoft/tsdoc/issues/209

As noted mentioned in that issue, we would like to build this feature into the eslint-plugin-tsdoc ruleset for ESLint. We need someone to propose a design. The actual implementation is probably pretty easy.