Multiple Folder

example/_apidoc.js → example/exam1/_apidoc.js

@@ -1,100 +1,100 @@
-// ------------------------------------------------------------------------------------------
-// General apiDoc documentation blocks and old history blocks.
-// ------------------------------------------------------------------------------------------
-
-// ------------------------------------------------------------------------------------------
-// Current Success.
-// ------------------------------------------------------------------------------------------
-
-
-// ------------------------------------------------------------------------------------------
-// Current Errors.
-// ------------------------------------------------------------------------------------------
-/**
- * @apiDefine CreateUserError
- * @apiVersion 0.2.0
- *
- * @apiError NoAccessRight Only authenticated Admins can access the data.
- * @apiError UserNameTooShort Minimum of 5 characters required.
- *
- * @apiErrorExample  Response (example):
- *     HTTP/1.1 400 Bad Request
- *     {
- *       "error": "UserNameTooShort"
- *     }
- */
-
-
-// ------------------------------------------------------------------------------------------
-// Current Permissions.
-// ------------------------------------------------------------------------------------------
-/**
- * @apiDefine admin Admin access rights needed.
- * Optionally you can write here further Informations about the permission.
- *
- * An "apiDefinePermission"-block can have an "apiVersion", so you can attach the block to a specific version.
- *
- * @apiVersion 0.3.0
- */
-
-
-// ------------------------------------------------------------------------------------------
-// History.
-// ------------------------------------------------------------------------------------------
-/**
- * @apiDefine admin This title is visible in version 0.1.0 and 0.2.0
- * @apiVersion 0.1.0
- */
-
-/**
- * @api {get} /user/:id Read data of a User
- * @apiVersion 0.2.0
- * @apiName GetUser
- * @apiGroup User
- * @apiPermission admin
- *
- * @apiDescription Here you can describe the function.
- * Multilines are possible.
- *
- * @apiParam {String} id The Users-ID.
- *
- * @apiSuccess {String} id         The Users-ID.
- * @apiSuccess {Date}   name       Fullname of the User.
- *
- * @apiError UserNotFound   The <code>id</code> of the User was not found.
- */
-
-/**
- * @api {get} /user/:id Read data of a User
- * @apiVersion 0.1.0
- * @apiName GetUser
- * @apiGroup User
- * @apiPermission admin
- *
- * @apiDescription Here you can describe the function.
- * Multilines are possible.
- *
- * @apiParam {String} id The Users-ID.
- *
- * @apiSuccess {String} id         The Users-ID.
- * @apiSuccess {Date}   name       Fullname of the User.
- *
- * @apiError UserNotFound   The error description text in version 0.1.0.
- */
-
-/**
- * @api {post} /user Create a User
- * @apiVersion 0.2.0
- * @apiName PostUser
- * @apiGroup User
- * @apiPermission none
- *
- * @apiDescription In this case "apiErrorStructure" is defined and used.
- * Define blocks with params that will be used in several functions, so you dont have to rewrite them.
- *
- * @apiParam {String} name Name of the User.
- *
- * @apiSuccess {String} id         The Users-ID.
- *
- * @apiUse CreateUserError
+// ------------------------------------------------------------------------------------------
+// General apiDoc documentation blocks and old history blocks.
+// ------------------------------------------------------------------------------------------
+
+// ------------------------------------------------------------------------------------------
+// Current Success.
+// ------------------------------------------------------------------------------------------
+
+
+// ------------------------------------------------------------------------------------------
+// Current Errors.
+// ------------------------------------------------------------------------------------------
+/**
+ * @apiDefine CreateUserError
+ * @apiVersion 0.2.0
+ *
+ * @apiError NoAccessRight Only authenticated Admins can access the data.
+ * @apiError UserNameTooShort Minimum of 5 characters required.
+ *
+ * @apiErrorExample  Response (example):
+ *     HTTP/1.1 400 Bad Request
+ *     {
+ *       "error": "UserNameTooShort"
+ *     }
+ */
+
+
+// ------------------------------------------------------------------------------------------
+// Current Permissions.
+// ------------------------------------------------------------------------------------------
+/**
+ * @apiDefine admin Admin access rights needed.
+ * Optionally you can write here further Informations about the permission.
+ *
+ * An "apiDefinePermission"-block can have an "apiVersion", so you can attach the block to a specific version.
+ *
+ * @apiVersion 0.3.0
+ */
+
+
+// ------------------------------------------------------------------------------------------
+// History.
+// ------------------------------------------------------------------------------------------
+/**
+ * @apiDefine admin This title is visible in version 0.1.0 and 0.2.0
+ * @apiVersion 0.1.0
+ */
+
+/**
+ * @api {get} /user/:id Read data of a User
+ * @apiVersion 0.2.0
+ * @apiName GetUser
+ * @apiGroup User
+ * @apiPermission admin
+ *
+ * @apiDescription Here you can describe the function.
+ * Multilines are possible.
+ *
+ * @apiParam {String} id The Users-ID.
+ *
+ * @apiSuccess {String} id         The Users-ID.
+ * @apiSuccess {Date}   name       Fullname of the User.
+ *
+ * @apiError UserNotFound   The <code>id</code> of the User was not found.
+ */
+
+/**
+ * @api {get} /user/:id Read data of a User
+ * @apiVersion 0.1.0
+ * @apiName GetUser
+ * @apiGroup User
+ * @apiPermission admin
+ *
+ * @apiDescription Here you can describe the function.
+ * Multilines are possible.
+ *
+ * @apiParam {String} id The Users-ID.
+ *
+ * @apiSuccess {String} id         The Users-ID.
+ * @apiSuccess {Date}   name       Fullname of the User.
+ *
+ * @apiError UserNotFound   The error description text in version 0.1.0.
+ */
+
+/**
+ * @api {post} /user Create a User
+ * @apiVersion 0.2.0
+ * @apiName PostUser
+ * @apiGroup User
+ * @apiPermission none
+ *
+ * @apiDescription In this case "apiErrorStructure" is defined and used.
+ * Define blocks with params that will be used in several functions, so you dont have to rewrite them.
+ *
+ * @apiParam {String} name Name of the User.
+ *
+ * @apiSuccess {String} id         The Users-ID.
+ *
+ * @apiUse CreateUserError
  */

example/apidoc.json → example/exam1/apidoc.json

@@ -1,20 +1,20 @@
-{
-  "name": "apidoc-example",
-  "version": "0.3.0",
-  "description": "apidoc example project",
-  "title": "Custom apiDoc browser title",
-  "url" : "https://api.github.com/v1",
-  "sampleUrl": "https://api.github.com/v1",
-  "header": {
-    "title": "My own header title",
-    "filename": "header.md"
-  },
-  "footer": {
-    "title": "My own footer title",
-    "filename": "footer.md"
-  },
-  "template": {
-  	"withCompare": true,
-  	"withGenerator": true
-  }
+{
+  "name": "apidoc-example",
+  "version": "0.3.0",
+  "description": "apidoc example project",
+  "title": "Custom apiDoc browser title",
+  "url" : "https://api.github.com/v1",
+  "sampleUrl": "https://api.github.com/v1",
+  "header": {
+    "title": "My own header title",
+    "filename": "header.md"
+  },
+  "footer": {
+    "title": "My own footer title",
+    "filename": "footer.md"
+  },
+  "template": {
+  	"withCompare": true,
+  	"withGenerator": true
+  }
 }

example/example.js → example/exam1/example.js

@@ -1,68 +1,68 @@
-/**
- * @api {get} /user/:id Read data of a User
- * @apiVersion 0.3.0
- * @apiName GetUser
- * @apiGroup User
- * @apiPermission admin
- *
- * @apiDescription Compare Verison 0.3.0 with 0.2.0 and you will see the green markers with new items in version 0.3.0 and red markers with removed items since 0.2.0.
- *
- * @apiParam {Number} id The Users-ID.
- *
- * @apiExample Example usage:
- * curl -i http://localhost/user/4711
- *
- * @apiSuccess {Number}   id            The Users-ID.
- * @apiSuccess {Date}     registered    Registration Date.
- * @apiSuccess {Date}     name          Fullname of the User.
- * @apiSuccess {String[]} nicknames     List of Users nicknames (Array of Strings).
- * @apiSuccess {Object}   profile       Profile data (example for an Object)
- * @apiSuccess {Number}   profile.age   Users age.
- * @apiSuccess {String}   profile.image Avatar-Image.
- * @apiSuccess {Object[]} options       List of Users options (Array of Objects).
- * @apiSuccess {String}   options.name  Option Name.
- * @apiSuccess {String}   options.value Option Value.
- *
- * @apiError NoAccessRight Only authenticated Admins can access the data.
- * @apiError UserNotFound   The <code>id</code> of the User was not found.
- *
- * @apiErrorExample Response (example):
- *     HTTP/1.1 401 Not Authenticated
- *     {
- *       "error": "NoAccessRight"
- *     }
- */
-function getUser() { return; }
-
-/**
- * @api {post} /user Create a new User
- * @apiVersion 0.3.0
- * @apiName PostUser
- * @apiGroup User
- * @apiPermission none
- *
- * @apiDescription In this case "apiErrorStructure" is defined and used.
- * Define blocks with params that will be used in several functions, so you dont have to rewrite them.
- *
- * @apiParam {String} name Name of the User.
- *
- * @apiSuccess {Number} id         The new Users-ID.
- *
- * @apiUse CreateUserError
- */
-function postUser() { return; }
-
-/**
- * @api {put} /user/:id Change a User
- * @apiVersion 0.3.0
- * @apiName PutUser
- * @apiGroup User
- * @apiPermission none
- *
- * @apiDescription This function has same errors like POST /user, but errors not defined again, they were included with "apiErrorStructure"
- *
- * @apiParam {String} name Name of the User.
- *
- * @apiUse CreateUserError
- */
+/**
+ * @api {get} /user/:id Read data of a User
+ * @apiVersion 0.3.0
+ * @apiName GetUser
+ * @apiGroup User
+ * @apiPermission admin
+ *
+ * @apiDescription Compare Verison 0.3.0 with 0.2.0 and you will see the green markers with new items in version 0.3.0 and red markers with removed items since 0.2.0.
+ *
+ * @apiParam {Number} id The Users-ID.
+ *
+ * @apiExample Example usage:
+ * curl -i http://localhost/user/4711
+ *
+ * @apiSuccess {Number}   id            The Users-ID.
+ * @apiSuccess {Date}     registered    Registration Date.
+ * @apiSuccess {Date}     name          Fullname of the User.
+ * @apiSuccess {String[]} nicknames     List of Users nicknames (Array of Strings).
+ * @apiSuccess {Object}   profile       Profile data (example for an Object)
+ * @apiSuccess {Number}   profile.age   Users age.
+ * @apiSuccess {String}   profile.image Avatar-Image.
+ * @apiSuccess {Object[]} options       List of Users options (Array of Objects).
+ * @apiSuccess {String}   options.name  Option Name.
+ * @apiSuccess {String}   options.value Option Value.
+ *
+ * @apiError NoAccessRight Only authenticated Admins can access the data.
+ * @apiError UserNotFound   The <code>id</code> of the User was not found.
+ *
+ * @apiErrorExample Response (example):
+ *     HTTP/1.1 401 Not Authenticated
+ *     {
+ *       "error": "NoAccessRight"
+ *     }
+ */
+function getUser() { return; }
+
+/**
+ * @api {post} /user Create a new User
+ * @apiVersion 0.3.0
+ * @apiName PostUser
+ * @apiGroup User
+ * @apiPermission none
+ *
+ * @apiDescription In this case "apiErrorStructure" is defined and used.
+ * Define blocks with params that will be used in several functions, so you dont have to rewrite them.
+ *
+ * @apiParam {String} name Name of the User.
+ *
+ * @apiSuccess {Number} id         The new Users-ID.
+ *
+ * @apiUse CreateUserError
+ */
+function postUser() { return; }
+
+/**
+ * @api {put} /user/:id Change a User
+ * @apiVersion 0.3.0
+ * @apiName PutUser
+ * @apiGroup User
+ * @apiPermission none
+ *
+ * @apiDescription This function has same errors like POST /user, but errors not defined again, they were included with "apiErrorStructure"
+ *
+ * @apiParam {String} name Name of the User.
+ *
+ * @apiUse CreateUserError
+ */
 function putUser() { return; }