grunt-jsdoc-plugin
This plugin enables you to integrate generation of comment based documentation into your Grunt build.
Install
You need grunt 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 grunt.js gruntfile with:
npm install grunt-jsdoc-plugin`
Documentation
Configuration
Configure the plugin to your project's grunt.js gruntfile:
First, add the jsdoc
entry to the options of the initConfig
method :
grunt;
The only 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
: the directory where the documentation will be generated (it will be created if needed).config
: (optional) a path to a jsdoc config file (refer the usejsdoc documentation below for more information).
Then, load the plugin
grunt;
Documentation
The current version supports only jsdoc3 documentation style. The sources configured must contains valid jsdoc3 tags. Consult the usejsdoc website for the details.
Build
To generate the documentation, you need to call the jsdoc
task :
$> grunt jsdoc
or integrate it to your build sequence :
grunt;
Contributing
Any contribution is welcome! Please check the issues.
Release History
- 0.1.0 First release, includes basic support of jsdoc3
- 0.1.1 Fix bug #2
- 0.1.2 Fix bug #4
- 0.1.3 Fix bug #7, Add feature #8
- 0.1.4 Use
child_process.spawn
instead ofexec
to run the command
License
Copyright (c) 2012 Bertrand Chevrier
Licensed under the MIT license.