rushstack icon indicating copy to clipboard operation
rushstack copied to clipboard

[api-extractor] Add option to require API documentation

Open Josmithr opened this issue 3 years ago • 0 comments

API-Extractor offers the option (for a number of settings) to either report issues in the generated API report file, xor fail with a console error. Missing documentation is not one of these.

For many of the projects I have worked on, it would be really handy to have a strict rule against missing documentation (specifically the summary comment field) on APIs being exported via the package rollup. Currently, we have to rely on PR code reviews to enforce documentation practices, but this is obviously hit-or-miss. Having the build fail on missing docs would be greatly preferable.

Feature request: add such an option to configure missing documentation to either be reported in the generated API repor, xor fail with a console error. I.e. what currently gets reported as:

// (undocumented)

in the API reports.

One caveat to this though is the use of {@link inheritDoc}. In this case (though it gets labeled as "undocumented" in the generated report), we would obviously like it to not fail the build.

Josmithr avatar Jun 03 '22 17:06 Josmithr