doc: Improved documentation

Author: masterspambot

src/models/Permission.js

@@ -8,6 +8,7 @@
        * Permission definition factory
        * @class PermissionFactory
        * @memberOf permission
+       * @constructs permission.Permission
        *
        * @param $q {$q} Angular promise implementation
        *
@@ -31,6 +32,7 @@
 
         /**
          * Checks if permission is still valid
+         * @method
          *
          * @param toParams {Object} UI-Router params object
          * @returns {Promise}
@@ -47,6 +49,7 @@
 
         /**
          * Converts a value into a promise, if the value is truthy it resolves it, otherwise it rejects it
+         * @method
          * @private
          *
          * @param result {Boolean} Function to be wrapped into promise
@@ -67,6 +70,7 @@
 
         /**
          * Checks if provided permission has accepted parameter types
+         * @method
          * @private
          */
         function validateConstructor(permissionName, validationFunction) {

src/models/PermissionMap.js

@@ -40,8 +40,9 @@
 
         /**
          * Extends permission map by pushing to it state's permissions
+         * @method
          *
-         * @param permissionMap {PermissionMap} Compensated permission map
+         * @param permissionMap {permission.PermissionMap} Compensated permission map
          */
         PermissionMap.prototype.extendPermissionMap = function (permissionMap) {
           this.only = this.only.concat(permissionMap.only);
@@ -50,6 +51,7 @@
 
         /**
          * Redirects to fallback states when permissions fail
+         * @method
          *
          * @param rejectedPermissionName {String} Permission name
          *
@@ -76,6 +78,7 @@
 
         /**
          * Handles function based redirection for rejected permissions
+         * @method
          *
          * @param redirectFunction {Function} Redirection function
          * @param permission {String} Rejected permission
@@ -102,6 +105,7 @@
 
         /**
          * Handles object based redirection for rejected permissions
+         * @method
          *
          * @param redirectObject {Object} Redirection function
          * @param permission {String} Rejected permission
@@ -136,6 +140,7 @@
 
         /**
          * Handles extraction of permission map "only" and "except" properties
+         * @method
          * @private
          *
          * @param property {Array|Function|promise} Permission map property "only" or "except"