Fixes to JSDoc for API docs

This commit is contained in:
crandmck 2014-03-13 17:25:21 -07:00
parent 533daf4040
commit 9fb3f3313a
2 changed files with 7 additions and 8 deletions

View File

@ -194,8 +194,8 @@ Principal.SCOPE = 'SCOPE';
/** /**
* Compare if two principals are equal * Compare if two principals are equal
* @param p The other principal * Returns true if argument principal is equal to this principal.
* @returns {boolean} * @param {Object} principal The other principal
*/ */
Principal.prototype.equals = function (p) { Principal.prototype.equals = function (p) {
if (p instanceof Principal) { if (p instanceof Principal) {
@ -205,11 +205,11 @@ Principal.prototype.equals = function (p) {
}; };
/** /**
* A request to access protected resources * A request to access protected resources.
* @param {String} model The model name * @param {String} model The model name
* @param {String} property * @param {String} property
* @param {String} accessType The access type * @param {String} accessType The access type
* @param {String} permission The permission * @param {String} permission The requested permission
* @returns {AccessRequest} * @returns {AccessRequest}
* @class * @class
*/ */

View File

@ -90,7 +90,7 @@ var ApplicationSchema = {
modified: {type: Date, default: Date} modified: {type: Date, default: Date}
}; };
/** /*!
* Application management functions * Application management functions
*/ */
@ -189,8 +189,7 @@ Application.resetKeys = function (appId, cb) {
/** /**
* Authenticate the application id and key. * Authenticate the application id and key.
* *
* `matched` will be one of * `matched` parameter is one of:
*
* - clientKey * - clientKey
* - javaScriptKey * - javaScriptKey
* - restApiKey * - restApiKey
@ -201,7 +200,7 @@ Application.resetKeys = function (appId, cb) {
* @param {String} key * @param {String} key
* @callback {Function} callback * @callback {Function} callback
* @param {Error} err * @param {Error} err
* @param {String} matched - The matching key * @param {String} matched The matching key
*/ */
Application.authenticate = function (appId, key, cb) { Application.authenticate = function (appId, key, cb) {
this.findById(appId, function (err, app) { this.findById(appId, function (err, app) {