@panzhiyue/jsdoc-webpack-plugin
v1.0.0
Published
JsDoc Webpack Plugin
Downloads
1
Readme
jsdoc-webpack-plugin
WebPack plugin that runs jsdoc on your bundles
Usage
In webpack.config.js:
var webpack = require('webpack');
var JsDocPlugin = require('jsdoc-webpack-plugin');
module.exports = {
/// ... rest of config
plugins: [
new JsDocPlugin({
conf: 'jsdoc.conf.js',
cwd: '.',
preserveTmpFile: false,
recursive: false,
args:["-P", "../../../package.json", "-d", "../../../build/apidoc"]
})
]
}
There are two ways how this plugin recognizes the files
- It takes the information from the jsdoc config file "source.include"
- If no "source.include" provided, it takes the original files from your bundles and creates a temporary file