documentationjs / documentationjs/documentation

@ignore entire (CommonJS) module

Open
#727 3 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
5.8k
Forks
481
PR merge metrics
No merged PRs in 30d

Description

For `@ignore`, [JSDoc says](http://usejsdoc.org/tags-ignore.html), “If you use the `@ignore` tag with the `@class` or `@module` tag, the entire class or module will be omitted from the documentation.” I haven’t tried it on a `@class`, but the only effect it seems to have at the `@module` level is to suppress the module entry, not any of its children, as the above implies. I’m using CommonJS modules, if that makes a difference.

`documentation@4.0.0-beta.19`

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.