This plugin enables you to integrate the generation of comments based documentation into your Grunt build.
The grunt team ask me to change the plugin name into NPM. The grunt-contrib
namespace is now reserved to the tasks developed by the Grunt Team.
I'll in a first time, deprecate the module in NPM and then update the name to grunt-jsdoc
. You'll have to upgrade your package.json
once the plugin will be removed from NPM.
You need grunt >= 0.4 as well as node and npm installed and running on your system.
You also need java
installed and a valid JAVA_HOME
environment variable set.
Install this grunt plugin next to your project's Gruntfile.js with:
npm install grunt-jsdoc --save-dev
If you use the previous version of Grunt (0.3), you can install it with:
npm install grunt-jsdoc-plugin
Configure the plugin to your project's Gruntfile.js.
First, add the jsdoc
entry to the options of the initConfig
method :
grunt.initConfig({
jsdoc : {
dist : {
src: ['src/*.js', 'test/*.js'],
options: {
destination: 'doc'
}
}
}
});
The supported options are
src
: (required) an array of pattern that matches the files to extract the documentation from. You can also add the pattern to a README.md file to include it in your doc as described there.dest
: (deprecated) to support the previous way to set up destination folderjsdoc
: (optional) the path to the jsdoc bin (needed only for some border line cases)options
: options used by jsdocdestination
: (required) the folder where the doc is generatedconfigure
: (optional) path to a config filetemplate
: (optional) path or name to a different templateprivate
: (optional) include the private functions to the doc (true
by default).- ... refer the usejsdocCli documentation for all the available options.
Then, load the plugin
grunt.loadNpmTasks('grunt-jsdoc');
The current version supports only jsdoc3 documentation style. The sources configured must contains valid jsdoc3 tags. Consult the usejsdoc website for the details.
The plugin includes docstrap, as well as the default template provided by jsdoc3. You can have a look to the Gruntfile.js for the configuration.
To generate the documentation, you need to call the jsdoc
task :
$> grunt jsdoc
or integrate it to your build sequence :
grunt.registerTask('default', ['lint', 'test', 'jsdoc']);
Any contribution is welcome! Please check the issues. Do some unit tests as far as possible.
- 0.4.0 Update to jsdoc 3.2.0 stable, Fix #37, add integration tests
- 0.3.0 Partial rewrite, Fix #29 and minor typos fixs
- 0.2.0 Migrate to grunt 0.4
- 0.1.0 First release, includes basic support of jsdoc3
- 0.1.1 Fix #2
- 0.1.2 Fix #4
- 0.1.3 Fix #7, Add feature #8
- 0.1.4 Use
child_process.spawn
instead ofexec
to run the command
Copyright (c) 2012 Bertrand Chevrier
Licensed under the MIT license.