grunt-jsdoc-joel   


This is a fork of grunt-jsdoc
This plugin enables you to integrate the generation of comments based documentation into your Grunt build.

Generate your documentation

$3

This plugin requires Grunt >=0.4.0

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

``shell
npm install grunt-jsdoc-joel --save-dev
`

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

`js
grunt.loadNpmTasks('grunt-jsdoc-joel');
`

$3

First, add the jsdoc entry to the options of the initConfig method of your Gruntfile.js :

`javascript
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 include a README.
* dest : (alias to options.destination) set up the destination folder, the grunt way
* jsdoc: (optional) the path to the jsdoc bin (needed only for some border line cases)
* options : options used by jsdoc
* destination: the folder where the doc is generated
* ... All jsdoc options are available (see usejsdocCli documentation).
* ignoreWarnings : (optional) do not show jsdoc warnings

$3

This plugin is a wrapper around jsdoc3. Please refer to the documentation for the documentation details.

$3

The plugin includes only the jsdoc3 template but you can configure any other jsdoc3 template. For example you can use ink-docstrap.

`
npm install --save-dev ink-docstrap
`

And in your Gruntfile.js :

`javascript
jsdoc : {
dist : {
src: ['src/*/.js', 'README.md'],
options: {
destination : 'doc',
template : "node_modules/ink-docstrap/template",
configure : "node_modules/ink-docstrap/template/jsdoc.conf.json"
}
}
}
`

Generation

To generate the documentation, you need to call the jsdoc task :

`bash
$> grunt jsdoc
`

or integrate it to your build sequence :

`javascript
grunt.registerTask('default', ['lint', 'test', 'jsdoc']);
`

Compatibility

$3

I have removed the direct dependency to ink-docstrap. If you still want it, grab the dependency by yourself (npm install --save-dev ink-docstrap)

$3

The private option follows now the default jsdoc behavior : false by default.

Contributions

Every contribution is more than welcomed. You can:
- report issues
- Fix, improve the configuration, add new features. The best is to fork and submit a pull request
- Test and adapt to other OS
- Fix my English mistakes
- Update the documentation
- Create a better logo
- Offer me a coffee (I'm maintaining this plugin on my free time)

$3

For documentation related issues, please use the jsdoc issue tracker

To be sure the issue comes from the Grunt plugin, you can check by comparing the results with a jsdoc command. Run the task with the --debug flag to retrieve the jsdoc command to run.

Release History


* _2.2.0_ jsdoc 3.5.0
* _2.2.1_ fix version of transitive dependency marked to prevent xss
* _2.1.0_ use cross-spawn instead of cross-spawn-async, add generating and generated grunt events
* _2.0.0_ private behavior, cross-spawn-async instead of manual windows management
* _1.1.0_ update to jsdoc 3.4.0 and make dest optional if a config file is set.
* _1.0.0_ remove direct dependency to docstrap
* _0.6.0_ jsdoc 3.0.0
* _0.6.4_ first stable using jsdoc 3.3.0
* _0.6.5_ code refactoring, docstrap 0.5.3, PR #120, better path management
* _0.6.6_ fix failing test
* _0.6.7_ Fix bug #136 and add more tests
* _0.6.8_ Fix bug #140, #143,
* _0.6.9_ Fix bug #144
* _0.6.10_ Revert wrong moving away docstrap dep
* _0.5.0_ Move to NPM dependencies instead of git, jsdoc 3.2.2 (Fix #65)
* _0.5.1_ Update repo name to prevent confusion with previous version
* _0.5.2_ Upgrade to Grunt 0.4.3 (PR #74)
* _0.5.3_ Fix peer deps issue
* _0.5.4_ Fix peer deps issue
* _0.5.5_ Update docstrap version
* _0.5.6_ Fix dependencies version and bug #87
* _0.5.7_ Update readme, docstrap version
* _0.5.8_ Fix bug #116
* _0.4.0_ Update to jsdoc 3.2.0 stable, Fix #37, add integration tests
* _0.4.1_ Fix #53 and #54
* _0.4.2_ Fix #57
* _0.4.3_ Grunt 0.4.2 compliance, upgrade to jsdoc 3.2.2 and undeprecate the dest option (#60, #63 and #66)
* _0.3.0_ Partial rewrite, Fix #29 and minor typos fixs
* _0.3.1_ Fix #29
* _0.3.2_ Fix #32
* _0.3.3_ Fix #34 and #36
* _0.2.0_ Migrate to grunt 0.4
* _0.2.1_ Fix #10
* _0.2.2_ Fix #11
* _0.2.3_ Fix #14 and #15
* _0.2.4_ Fix Jsdoc 3 dependency to 3.1.1 tag, enables jsdoc options #19, enable to add jsdoc path #13 and add peerDependencies
* _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 of exec` to run the command

License

Copyright (c) 2012 Bertrand Chevrier
Licensed under the MIT license.