apidoc - npm Package Compare versions

Comparing version 0.4.3 to 0.4.4

CHANGELOG.md

		# apiDoc Changelog

		#### 0.4.4
		Preserve other files when copying template files to the destination output dir.

		#### 0.4.3
		@@ -4,0 +7,0 @@ Added a short-circuit check. (Mattias Festin https://github.com/apidoc/apidoc/issues/41)

lib/apidoc.js

		var _ = require("underscore");
		var fs = require("fs");
		var path = require("path");
		@@ -7,3 +6,2 @@ var semver = require("semver");
		var path = require("path");
		var wrench = require("wrench");
		var Parser = require("./parser");
		@@ -14,2 +12,3 @@ var Worker = require("./worker");
		var colors = require("colors");
		var fs = require("fs-extra");

		@@ -248,6 +247,6 @@ // Options
		app.debug("create dir: " + options.dest);
		if( ! options.simulate) wrench.mkdirSyncRecursive(options.dest);
		if( ! options.simulate) fs.mkdirsSync(options.dest);

		app.debug("copy template " + options.template + " to: " + options.dest);
		if( ! options.simulate) wrench.copyDirSyncRecursive(options.template, options.dest, { forceDelete: true });
		if( ! options.simulate) fs.copySync(options.template, options.dest);

		@@ -254,0 +253,0 @@ // api_data

package.json

		{
		"name": "apidoc",
		"version": "0.4.3",
		"version": "0.4.4",
		"description": "RESTful web API Documentation Generator",
		"author": "Peter Rottmann <rottmann@inveris.de>",
		"license": "MIT",
		"preferGlobal": true,
		"homepage": "http://apidocjs.com",
		"repository": {
		@@ -11,2 +12,9 @@ "type": "git",
		},
		"license": {
		"type": "MIT",
		"url": "https://github.com/apidoc/apidoc/blob/master/LICENSE.md"
		},
		"bugs": {
		"url": "https://github.com/apidoc/apidoc/issues"
		},
		"main": "./lib/apidoc",
		@@ -26,17 +34,18 @@ "bin": "bin/apidoc",
		"dependencies": {
		"wrench": "~1.5.8",
		"underscore": "~1.6.0",
		"semver": "~2.2.1",
		"colors": "~0.6.2",
		"fs-extra": "^0.9.1",
		"lodash": "~2.4.1",
		"marked": "~0.3.2",
		"optimist": "~0.6.1",
		"colors": "~0.6.2",
		"marked": "~0.3.1"
		"semver": "~2.3.0",
		"underscore": "~1.6.0",
		"wrench": "~1.5.8"
		},
		"devDependencies": {
		"grunt": "~0.4.2",
		"grunt": "~0.4.5",
		"grunt-contrib-clean": "~0.5.0",
		"grunt-contrib-jshint": "~0.8.0",
		"grunt-contrib-jshint": "~0.10.0",
		"grunt-simple-mocha": "~0.4.0",
		"should": "~3.1.3"
		"should": "~4.0.1"
		}
		}
		}

README.md

		@@ -9,2 +9,28 @@ # apiDoc 0.4.x


		## Installation

		`npm install apidoc -g`


		## Example

		```javascript
		/**
		* @api {get} /user/:id Request User information
		* @apiName GetUser
		* @apiGroup User
		*
		* @apiParam {Number} id Users unique ID.
		*
		* @apiSuccess {String} firstname Firstname of the User.
		* @apiSuccess {String} lastname Lastname of the User.
		*/
		```

		`apidoc -i example/ -o doc/`

		Creates from input files in `example/` a documentation in path `doc/`.


		## Supported programming languages
		@@ -52,17 +78,6 @@

		## Installation

		`npm install apidoc -g`


		## Example

		`apidoc -i example/ -o doc/`

		Creates from input files a documentation in path `doc/`.


		## Grunt Module

		[grund-apidoc](https://github.com/apidoc/grunt-apidoc) `npm install grunt-apidoc`.
		[grunt-apidoc](https://github.com/apidoc/grunt-apidoc) `npm install grunt-apidoc`.

		@@ -69,0 +84,0 @@

template/index.html

Sorry, the diff of this file is not supported yet

New alerts