@panzhiyue/jsdoc-webpack-plugin

1.0.0 • Public • Published

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

  1. It takes the information from the jsdoc config file "source.include"
  2. If no "source.include" provided, it takes the original files from your bundles and creates a temporary file

Readme

Keywords

Package Sidebar

Install

npm i @panzhiyue/jsdoc-webpack-plugin

Weekly Downloads

0

Version

1.0.0

License

MIT

Unpacked Size

8.13 kB

Total Files

4

Last publish

Collaborators

  • panzhiyue