grunt-jsdoc - npm Package Compare versions

Comparing version 0.5.7 to 0.5.8

package.json

		{
		"name": "grunt-jsdoc",
		"description": "Integrates jsdoc3 generation into your Grunt build",
		"version": "0.5.7",
		"version": "0.5.8",
		"homepage": "https://github.com/krampstudio/grunt-jsdoc",
		@@ -47,3 +47,3 @@ "author": {
		"jsdoc": "~3.2.2",
		"ink-docstrap": "~0.4.12"
		"ink-docstrap": "0.4.12"
		},
		@@ -50,0 +50,0 @@ "peerDependencies": {

README.md

		@@ -7,9 +7,8 @@ # grunt-jsdoc [![Build Status](https://travis-ci.org/krampstudio/grunt-jsdoc.png)](https://travis-ci.org/krampstudio/grunt-jsdoc) [![NPM version](https://badge.fury.io/js/grunt-jsdoc.png)](http://badge.fury.io/js/grunt-jsdoc) [![Built with Grunt](https://cdn.gruntjs.com/builtwith.png)](http://gruntjs.com/)

		## To your attention

		The 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.
		I'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.
		## NPM package name change

		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`.

		## Install


		You need [grunt >= 0.4][grunt] as well as [node] and [npm] installed and running on your system.
		@@ -19,3 +18,3 @@

		Install this grunt plugin next to your project's [Gruntfile.js][getting_started] with:
		Install this grunt plugin next to your project's [Gruntfile.js][getting_started] with:

		@@ -48,3 +47,3 @@ ```bash
		## Documentation


		### Configuration
		@@ -60,3 +59,3 @@
		dist : {
		src: ['src/.js', 'test/.js'],
		src: ['src/.js', 'test/.js'],
		options: {
		@@ -70,3 +69,3 @@ destination: 'doc'

		The supported options are
		The supported options are

		@@ -76,3 +75,3 @@ * `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).
		* `jsdoc`: (optional) the path to the jsdoc bin (needed only for some border line cases)
		* `options` : options used by jsdoc
		* `options` : options used by jsdoc
		* `destination`: (required) the folder where the doc is generated
		@@ -84,3 +83,3 @@ * `configure` : (optional) path to a config file

		Then, load the plugin
		Then, load the plugin

		@@ -90,12 +89,25 @@ ```javascript
		```


		### Code Documentation

		The current version supports only [jsdoc3] documentation style. The sources configured
		The current version supports only [jsdoc3] documentation style. The sources configured
		must contains valid [jsdoc3] tags. Consult the [usejsdoc] website for the details.


		### Templates

		The plugin includes [docstrap](https://github.com/terryweiss/docstrap), as well as the default template provided by jsdoc3. You can have a look to the [Gruntfile.js](Gruntfile.js) for the configuration.
		The plugin includes [docstrap](https://github.com/terryweiss/docstrap), as well as the default template provided by jsdoc3. To use docstrap, you can use the following configuration:

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

		### Build
		@@ -109,3 +121,3 @@

		or integrate it to your build sequence :
		or integrate it to your build sequence :

		@@ -115,7 +127,7 @@ ```javascript
		```


		## Contributing

		Any contribution is welcome! Please check the [issues](https://github.com/krampstudio/grunt-jsdoc/issues). Do some unit/integration tests as far as possible.


		## Release History
		@@ -130,5 +142,6 @@ * _0.5.0_ Move to NPM dependencies instead of git, jsdoc 3.2.2 (Fix [#65](https://github.com/krampstudio/grunt-jsdoc/issues/65))
		* _0.5.7_ Update readme, docstrap version
		* _0.5.8_ Fix bug [#116](https://github.com/krampstudio/grunt-jsdoc/issues/116)
		* _0.4.0_ Update to jsdoc 3.2.0 stable, Fix [#37](https://github.com/krampstudio/grunt-jsdoc/issues/37), add integration tests
		* _0.4.1_ Fix [#53](https://github.com/krampstudio/grunt-jsdoc/issues/53) and [#54](https://github.com/krampstudio/grunt-jsdoc/issues/54)
		* _0.4.2_ Fix [#57](https://github.com/krampstudio/grunt-jsdoc/issues/57)
		* _0.4.1_ Fix [#53](https://github.com/krampstudio/grunt-jsdoc/issues/53) and [#54](https://github.com/krampstudio/grunt-jsdoc/issues/54)
		* _0.4.2_ Fix [#57](https://github.com/krampstudio/grunt-jsdoc/issues/57)
		* _0.4.3_ Grunt 0.4.2 compliance, upgrade to jsdoc 3.2.2 and undeprecate the `dest` option ([#60](https://github.com/krampstudio/grunt-jsdoc/issues/60), [#63](https://github.com/krampstudio/grunt-jsdoc/issues/63) and [#66](https://github.com/krampstudio/grunt-jsdoc/issues/66))
		@@ -146,11 +159,11 @@ * _0.3.0_ Partial rewrite, Fix [#29](https://github.com/krampstudio/grunt-jsdoc/pull/30) and minor typos fixs
		* _0.1.1_ Fix [#2](https://github.com/krampstudio/grunt-jsdoc/issues/2)
		* _0.1.2_ Fix [#4](https://github.com/krampstudio/grunt-jsdoc/issues/4)
		* _0.1.2_ Fix [#4](https://github.com/krampstudio/grunt-jsdoc/issues/4)
		* _0.1.3_ Fix [#7](https://github.com/krampstudio/grunt-jsdoc/pull/7), Add [feature #8](https://github.com/krampstudio/grunt-jsdoc/pull/8)
		* _0.1.4_ Use `child_process.spawn` instead of `exec` to run the command



		[jsdoc3]: https://github.com/jsdoc3/jsdoc

		## License
		Copyright (c) 2012 Bertrand Chevrier
		Copyright (c) 2012 Bertrand Chevrier
		Licensed under the MIT license.
		@@ -157,0 +170,0 @@

grunt-jsdoc - npm Package Compare versions

Improved metrics

Dependency changes