npm install grunt-jsdoc --save-dev

grunt.loadNpmTasks('grunt-jsdoc');

First, add thejsdoc entry to the options of theinitConfig method of your Gruntfile.js :

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 alsoinclude a README.
• dest : (alias tooptions.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 (seeusejsdocCli documentation).
  • ignoreWarnings : (optional) do not show jsdoc warnings

This plugin is a wrapper aroundjsdoc3. Please refer to thedocumentation for the documentation details.

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

npm install --save-dev ink-docstrap

And in yourGruntfile.js :

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"}}}

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

$> grunt jsdoc

or integrate it to your build sequence :

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

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

Theprivate option follows now the default jsdoc behavior :false by default.

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)

For documentation related issues, please use thejsdoc 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.

• 2.4.0 jsdoc 3.6.0 (security update) and upgrade node support
  • 2.4.1 security update
• 2.3.0 jsdoc 3.5.5 and up to date dependencies
  • 2.3.1 fix version of transitive dependencymarked to preventregex dos
• 2.2.0 jsdoc 3.5.0
  • 2.2.1 fix version of transitive dependencymarked to prevent xss
• 2.1.0 usecross-spawn instead ofcross-spawn-async, addgenerating andgenerated grunt events
• 2.0.0private 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 thedest 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, Addfeature #8
  • 0.1.4 Usechild_process.spawn instead ofexec to run the command

Copyright (c) 2012 Bertrand ChevrierLicensed under the MIT license.