Skip to content
JsDoc Webpack Plugin
JavaScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.gitignore Initial commit May 6, 2016
LICENSE Initial commit May 6, 2016
README.md Merge branch 'bugfix-enoent-error' into release-0.2.0 Aug 18, 2019
index.js
package.json

README.md

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
        })
    ]
}

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
You can’t perform that action at this time.