This plugin enables you to integrate the generation of comments based documentation into your Grunt build.
To comply with convention, the package's name was changed from grunt-contrib-jsdoc
to grunt-jsdoc
. You'll have to upgrade your package.json
if you're still using grunt-contrib-jsdoc
.
You need grunt >= 0.4 as well as node and npm installed and running on your system.
Install this grunt plugin next to your project's Gruntfile.js with:
npm install grunt-jsdoc --save-dev
For documentation related issues, please ask the jsdoc3 people. To be sure the issue comes from the Grunt plugin, you can check by running directly jsdoc3 command. Run the task with the --debug
flag and the command to run is outputed.
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
: 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
: (alias tooptions.destination
) set up the destination folder, the grunt wayjsdoc
: (optional) the path to the jsdoc bin (needed only for some border line cases)options
: options used by jsdocdestination
: the folder where the doc is generated- ... all jsdoc options are available (see usejsdocCli documentation).
ignoreWarnings
: (optional) do not show jsdoc warnings
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. To use docstrap, you can use the following configuration:
jsdoc : {
dist : {
src: ['src/**/*.js', 'README.md'],
options: {
destination: 'doc',
template : "node_modules/grunt-jsdoc/node_modules/ink-docstrap/template",
configure : "node_modules/grunt-jsdoc/node_modules/ink-docstrap/template/jsdoc.conf.json"
}
}
}
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/integration tests as far as possible.
- 0.6.0 jsdoc 3.0.0
- 0.5.0 Move to NPM dependencies instead of git, jsdoc 3.2.2 (Fix #65)
- 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.