{"ts":1372850832610,"silentsave":true,"restoring":false,"patch":[[{"diffs":[[1,"# grunt-jsdoc-plugin [![Build Status](https://travis-ci.org/krampstudio/grunt-jsdoc-plugin.png)](https://travis-ci.org/krampstudio/grunt-jsdoc-plugin)\n\nThis plugin enables you to integrate the generation of comments based documentation into your Grunt build.\n\n## To your attention\n\nThe 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.\nI'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.\n\n## Install\n\nYou need [grunt >= 0.4][grunt] as well as [node] and [npm] installed and running on your system.\n\nYou also need `java` installed and a valid `JAVA_HOME` environment variable set.\n\nInstall this grunt plugin next to your project's [Gruntfile.js][getting_started] with: \n\n```bash\nnpm install grunt-jsdoc --save-dev\n```\n\nIf you use the previous version of Grunt (0.3), you can install it with:\n\n```bash\nnpm install grunt-jsdoc-plugin\n```\n\n\n## Documentation\n\n### Configuration\n\nConfigure the plugin to your project's [Gruntfile.js][getting_started].\n\nFirst, add the `jsdoc` entry to the options of the `initConfig` method :\n\n```javascript\ngrunt.initConfig({\n    jsdoc : {\n        dist : {\n            src: ['src/*.js', 'test/*.js'], \n            options: {\n                destination: 'doc'\n            }\n        }\n    }\n});\n```\n\nThe supported options are \n\n * `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](http://usejsdoc.org/about-including-readme.html).\n * `dest` : (deprecated) to support the previous way to set up destination folder\n * `jsdoc`: (optional) the path to the jsdoc bin (needed only for some border line cases)\n * `options` : options used by jsdoc \n   * `destination`: (required) the folder where the doc is generated\n   * `configure` : (optional) path to a config file\n   * `template` : (optional) path or name to a different template\n   * `private` : (optional) include the private functions to the doc (`true` by default).\n   * ... refer the [usejsdocCli] documentation for all the available options.\n\nThen, load the plugin \n\n```javascript\ngrunt.loadNpmTasks('grunt-jsdoc');\n```\n\n### Documentation\n\nThe current version supports only [jsdoc3] documentation style. The sources configured \nmust contains valid [jsdoc3] tags. Consult the [usejsdoc] website for the details.\n\n### Build\n\nTo generate the documentation, you need to call the `jsdoc` task :\n\n```bash\n$> grunt jsdoc\n```\n\nor integrate it to your build sequence : \n\n```javascript\ngrunt.registerTask('default', ['lint', 'test', 'jsdoc']);\n```\n\n## Contributing\n\nAny contribution is welcome! Please check the [issues](https://github.com/krampstudio/grunt-jsdoc-plugin/issues). Do some unit tests as far as possible.\n\n## Release History\n * _0.3.0_ Partial rewrite, Fix [bug #29](https://github.com/krampstudio/grunt-jsdoc-plugin/pull/30) and minor typos fixs\n   * _0.3.1_ Fix [bug #29](https://github.com/krampstudio/grunt-jsdoc-plugin/issues/29)\n   * _0.3.2_ Fix [bug #32](https://github.com/krampstudio/grunt-jsdoc-plugin/issues/32)\n   * _0.3.3_ Fix [bug #34](https://github.com/krampstudio/grunt-jsdoc-plugin/issues/34) and [bug #36](https://github.com/krampstudio/grunt-jsdoc-plugin/issues/34)\n   * _0.3.4_ Fix [bug #37](https://github.com/krampstudio/grunt-jsdoc-plugin/issues/37)\n * _0.2.0_ Migrate to grunt 0.4\n   * _0.2.1_ Fix [bug #10](https://github.com/krampstudio/grunt-jsdoc-plugin/issues/10)\n   * _0.2.2_ Fix [bug #11](https://github.com/krampstudio/grunt-jsdoc-plugin/issues/11)\n   * _0.2.3_ Fix [bug #14](https://github.com/krampstudio/grunt-jsdoc-plugin/pull/14) and [bug #15](https://github.com/krampstudio/grunt-jsdoc-plugin/issues/15)\n   * _0.2.4_ Fix Jsdoc 3 dependency to 3.1.1 tag, enables jsdoc options [issue #19](https://github.com/krampstudio/grunt-jsdoc-plugin/issues/19), enable to add jsdoc path [issue #13](https://github.com/krampstudio/grunt-jsdoc-plugin/issues/13) and add peerDependencies\n * _0.1.0_ First release, includes basic support of [jsdoc3]\n   * _0.1.1_ Fix [bug #2](https://github.com/krampstudio/grunt-jsdoc-plugin/issues/2)\n   * _0.1.2_ Fix [bug #4](https://github.com/krampstudio/grunt-jsdoc-plugin/issues/4) \n   * _0.1.3_ Fix [bug #7](https://github.com/krampstudio/grunt-jsdoc-plugin/pull/7), Add [feature #8](https://github.com/krampstudio/grunt-jsdoc-plugin/pull/8)\n   * _0.1.4_ Use `child_process.spawn` instead of `exec` to run the command\n \n\n[jsdoc3]: https://github.com/jsdoc3/jsdoc\n\n## License\nCopyright (c) 2012 Bertrand Chevrier  \nLicensed under the MIT license.\n\n\n[grunt]: https://gruntjs.com\n[node]: http://nodejs.org\n[npm]: http://npmjs.org\n[getting_started]: https://github.com/gruntjs/grunt/wiki/Getting-started\n[usejsdoc]: http://usejsdoc.org\n[usejsdocCli]: http://usejsdoc.org/about-commandline.html\n"]],"start1":0,"start2":0,"length1":0,"length2":5000}]],"length":5000}
{"contributors":[],"silentsave":false,"ts":1372850983361,"patch":[[{"diffs":[[0,"History\n"],[1," * _0.4.0_ Update to jsdoc 3.2.0 stable, Fix [bug #37](https://github.com/krampstudio/grunt-jsdoc-plugin/issues/37), add integration tests\n"],[0," * _0.3."]],"start1":2963,"start2":2963,"length1":16,"length2":155},{"diffs":[[0,"34)\n"],[-1,"   * _0.3.4_ Fix [bug #37](https://github.com/krampstudio/grunt-jsdoc-plugin/issues/37)\n"],[0," * _"]],"start1":3567,"start2":3567,"length1":96,"length2":8}]],"length":5051,"saved":false}
