babel-plugin-add-jsdoc-properties
v0.1.4
Published
Adds JSDoc annotations to source code
Downloads
135
Readme
babel-plugin-add-jsdoc-properties
Adds JSDoc annotations to source code.
This module only handles a handful of cases at the moment, designed to take the tedium out of documenting ES2015+ classes with JSDoc.
Installation
$ npm install babel-plugin-add-jsdoc-properties
Usage
Via JSDoc (Recommended)
Install jsdoc-babel and load babel-plugin-add-jsdoc-properties
within it.
{
"plugins": ["node_modules/jsdoc-babel"],
"babel": {
"plugins": ["jsdoc"]
}
}
Via .babelrc
.babelrc
{
"plugins": ["jsdoc"]
}
Via CLI
$ babel --plugins jsdoc script.js
Via Node API
require('babel').transform('code', {
plugins: ['jsdoc']
});