Skip to content

MitkoTschimev/jsdoc-webpack-plugin

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

33 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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

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