Skip to content

Commit 4a24d42

Browse files
committedMay 7, 2015
Remove deprecated annotations.
1 parent 5864c89 commit 4a24d42

File tree

3 files changed

+16
-16
lines changed

3 files changed

+16
-16
lines changed
 

‎example/_apidoc.js

+8-8
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,12 @@
1111
// Current Errors.
1212
// ------------------------------------------------------------------------------------------
1313
/**
14-
* @apiDefineErrorStructure CreateUserError
14+
* @apiDefine CreateUserError
1515
* @apiVersion 0.2.0
16-
*
16+
*
1717
* @apiError NoAccessRight Only authenticated Admins can access the data.
1818
* @apiError UserNameTooShort Minimum of 5 characters required.
19-
*
19+
*
2020
* @apiErrorExample Response (example):
2121
* HTTP/1.1 400 Bad Request
2222
* {
@@ -29,7 +29,7 @@
2929
// Current Permissions.
3030
// ------------------------------------------------------------------------------------------
3131
/**
32-
* @apiDefinePermission admin Admin access rights needed.
32+
* @apiDefine admin Admin access rights needed.
3333
* Optionally you can write here further Informations about the permission.
3434
*
3535
* An "apiDefinePermission"-block can have an "apiVersion", so you can attach the block to a specific version.
@@ -42,7 +42,7 @@
4242
// History.
4343
// ------------------------------------------------------------------------------------------
4444
/**
45-
* @apiDefinePermission admin This title is visible in version 0.1.0 and 0.2.0
45+
* @apiDefine admin This title is visible in version 0.1.0 and 0.2.0
4646
* @apiVersion 0.1.0
4747
*/
4848

@@ -91,10 +91,10 @@
9191
*
9292
* @apiDescription In this case "apiErrorStructure" is defined and used.
9393
* Define blocks with params that will be used in several functions, so you dont have to rewrite them.
94-
*
94+
*
9595
* @apiParam {String} name Name of the User.
9696
*
9797
* @apiSuccess {String} id The Users-ID.
9898
*
99-
* @apiErrorStructure CreateUserError
100-
*/
99+
* @apiUse CreateUserError
100+
*/

‎example/apidoc.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,4 +17,4 @@
1717
"withCompare": true,
1818
"withGenerator": true
1919
}
20-
}
20+
}

‎example/example.js

+7-7
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@
66
* @apiPermission admin
77
*
88
* @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.
9-
*
9+
*
1010
* @apiParam {Number} id The Users-ID.
1111
*
1212
* @apiExample Example usage:
1313
* curl -i http://localhost/user/4711
1414
*
1515
* @apiSuccess {Number} id The Users-ID.
16-
* @apiSuccess {Date} registered Registration Date.
16+
* @apiSuccess {Date} registered Registration Date.
1717
* @apiSuccess {Date} name Fullname of the User.
1818
* @apiSuccess {String[]} nicknames List of Users nicknames (Array of Strings).
1919
* @apiSuccess {Object} profile Profile data (example for an Object)
@@ -25,7 +25,7 @@
2525
*
2626
* @apiError NoAccessRight Only authenticated Admins can access the data.
2727
* @apiError UserNotFound The <code>id</code> of the User was not found.
28-
*
28+
*
2929
* @apiErrorExample Response (example):
3030
* HTTP/1.1 401 Not Authenticated
3131
* {
@@ -43,12 +43,12 @@ function getUser() { return; }
4343
*
4444
* @apiDescription In this case "apiErrorStructure" is defined and used.
4545
* Define blocks with params that will be used in several functions, so you dont have to rewrite them.
46-
*
46+
*
4747
* @apiParam {String} name Name of the User.
4848
*
4949
* @apiSuccess {Number} id The new Users-ID.
5050
*
51-
* @apiErrorStructure CreateUserError
51+
* @apiUse CreateUserError
5252
*/
5353
function postUser() { return; }
5454

@@ -63,6 +63,6 @@ function postUser() { return; }
6363
*
6464
* @apiParam {String} name Name of the User.
6565
*
66-
* @apiErrorStructure CreateUserError
66+
* @apiUse CreateUserError
6767
*/
68-
function putUser() { return; }
68+
function putUser() { return; }

0 commit comments

Comments
 (0)
Please sign in to comment.