Permalink
Browse files

0.1.0 Initial release.

  • Loading branch information...
1 parent d1e513f commit 6b77920ae59533345f39ca0b3d6a38cfa19ba1f2 @rottmann rottmann committed Apr 10, 2013
Showing with 48 additions and 10 deletions.
  1. +2 −1 Gruntfile.js
  2. +22 −0 LICENSE.md
  3. +4 −4 README.md
  4. +11 −1 bin/apidoc.js
  5. +3 −3 package.json
  6. +2 −1 tasks/apidoc.js
  7. +4 −0 test/fixtures/example.js
View
@@ -1,6 +1,7 @@
/*
* grunt-apidoc
- * https://github.com/inveris/grunt-apidoc
+ * https://github.com/apidoc/grunt-apidoc
+ * http://apidocjs.com
*
* Copyright (c) 2013 inveris OHG
* Author Peter Rottmann <rottmann@inveris.de>
View
@@ -0,0 +1,22 @@
+Copyright (c) 2013 inveris OHG
+Author Peter Rottmann <rottmann@inveris.de>
+Licensed under the MIT license.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
View
@@ -3,7 +3,7 @@
This plugin requires Grunt `~0.4.0`
## About
-Generates a REST-API-Documentation with [apidoc](http://apidocjs.com).
+Generates a RESTful API Documentation with [apidoc](http://apidocjs.com).
Generated example documentation at [http://apidocjs.com/example/](http://apidocjs.com/example/)
@@ -27,7 +27,7 @@ Use only one src and one dest, apidoc search in subdirs for files with apidoc-pa
### Additional options
-All `apidoc` options can be used within options-block, see [apidoc readme](https://github.com/inveris/apidoc/README.md) for details.
+All `apidoc` options can be used within options-block, see [apidoc readme](https://github.com/apidoc/apidoc/README.md) for details.
**Example options:**
@@ -55,6 +55,6 @@ apidoc: {
* `0.1.0` Initial release
## License
-Copyright (c) 2013 [inveris OHG](http://www.inveris.de)
-Author Peter Rottmann
+Copyright (c) 2013 inveris OHG
+Author Peter Rottmann <rottmann@inveris.de>
Licensed under the MIT license.
View
@@ -2,6 +2,16 @@
"use strict";
+/*
+ * grunt-apidoc
+ * https://github.com/apidoc/grunt-apidoc
+ * http://apidocjs.com
+ *
+ * Copyright (c) 2013 inveris OHG
+ * Author Peter Rottmann <rottmann@inveris.de>
+ * Licensed under the MIT license.
+ */
+
// Modules.
var path = require("path");
var grunt = require("grunt");
@@ -18,7 +28,7 @@ grunt.help.queue = [
];
grunt.help.content = function() {
- grunt.log.writeln("grunt-init: Create REST-API-Documentation with apidoc. (v" + pkg.version + ")");
+ grunt.log.writeln("grunt-init: Create RESTful API Documentation with apidoc. (v" + pkg.version + ")");
};
// Version.
View
@@ -1,12 +1,12 @@
{
"name": "grunt-apidoc",
- "version": "0.0.1",
- "description": "Grunt task to generate a REST-API-Documentation with apidoc",
+ "version": "0.1.0",
+ "description": "Grunt task to generate a RESTful API Documentation with apidoc",
"author": "Peter Rottmann <rottmann@inveris.de>",
"license": "MIT",
"repository": {
"type": "git",
- "url": "https://github.com/inveris/grunt-apidoc.git"
+ "url": "https://github.com/apidoc/grunt-apidoc.git"
},
"main": "Gruntfile.js",
"bin": "bin/apidoc",
View
@@ -1,6 +1,7 @@
/*
* grunt-apidoc
- * https://github.com/inveris/grunt-apidoc
+ * https://github.com/apidoc/grunt-apidoc
+ * http://apidocjs.com
*
* Copyright (c) 2013 inveris OHG
* Author Peter Rottmann <rottmann@inveris.de>
@@ -1,4 +1,8 @@
/**
+ * For Details and more examples visit http://apidocjs.com
+ */
+
+/**
* @apiDefinePermission admin Admin access rights needed.
* Optionally you can write here further Informations about the permission.
*

0 comments on commit 6b77920

Please sign in to comment.