jsdoc-plugin-just-comments v0.1.1

jsdoc-plugin-just-comments

A super simple JSDoc plugin that makes JSDoc ignore all code in your source files and rely solely on your comments. Intended for use with .ts typescript files.

Install

npm install --save-dev jsdoc-plugin-just-comments

Example

// config.json
{
    "source": {
        "include": "./src/",
        "includePattern": "\\.(js|jsx|jsdoc|ts|tsx|tsdoc)$"
    },
    "plugins": [
        "jsdoc-plugin-just-comments"
    ]
}