From 8af1b96a47e48a16756ff925a74ff213524b697f Mon Sep 17 00:00:00 2001
From: Rand McKinney <rand@strongloop.com>
Date: Wed, 1 Oct 2014 17:21:22 -0700
Subject: [PATCH] Document ACL class properties

---
 lib/models/acl.js | 30 ++++++++++--------------------
 1 file changed, 10 insertions(+), 20 deletions(-)

diff --git a/lib/models/acl.js b/lib/models/acl.js
index 65578b97..81eb93a5 100644
--- a/lib/models/acl.js
+++ b/lib/models/acl.js
@@ -58,29 +58,9 @@ var Role = role.Role;
 var ACLSchema = {
   model: String, // The name of the model
   property: String, // The name of the property, method, scope, or relation
-
-  /**
-   * Name of the access type - READ/WRITE/EXECUTE
-   * @property accessType {String} Name of the access type - READ/WRITE/EXECUTE
-   */
   accessType: String,
-
-  /**
-   * ALARM - Generate an alarm, in a system dependent way, the access specified
-   * in the permissions component of the ACL entry.
-   * ALLOW - Explicitly grants access to the resource.
-   * AUDIT - Log, in a system dependent way, the access specified in the
-   * permissions component of the ACL entry.
-   * DENY - Explicitly denies access to the resource.
-   */
   permission: String,
-  /**
-   * Type of the principal - Application/User/Role
-   */
   principalType: String,
-  /**
-   * Id of the principal - such as appId, userId or roleId
-   */
   principalId: String
 };
 
@@ -88,6 +68,16 @@ var ACLSchema = {
  * A Model for access control meta data.
  *
  * @header ACL
+ * @property {String} model Name of the model.
+ * @property {String} property Name of the property, method, scope, or relation.
+ * @property {String} accessType Type of access being granted: one of READ, WRITE, or EXECUTE.
+ * @property {String} permission Type of permission granted. One of:
+ *  - ALARM: Generate an alarm, in a system-dependent way, the access specified in the permissions component of the ACL entry.
+ *  - ALLOW: Explicitly grants access to the resource.
+ *  - AUDIT: Log, in a system-dependent way, the access specified in the permissions component of the ACL entry.
+ *  - DENY: Explicitly denies access to the resource.
+ * @property {String} principalType Type of the principal; one of: Application, Use, Role.
+ * @property {String} principalId ID of the principal - such as appId, userId or roleId
  * @class
  * @inherits Model
  */