Skip to content
This repository has been archived by the owner on Mar 8, 2021. It is now read-only.

Commit

Permalink
tweaking docblocks
Browse files Browse the repository at this point in the history
  • Loading branch information
@tymondesigns
tymondesigns committed Jun 21, 2015
1 parent d3fe315 commit 6ebb3a5
Show file tree
Hide file tree
Showing 3 changed files with 83 additions and 77 deletions.
79 changes: 41 additions & 38 deletions dist/angular-locker.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@
*
* @private
*
* @param {Mixed} value - The value to execute or return
* @param {Mixed} param - The parameter to pass to function if applicable
* @param {Mixed} value The value to execute or return
* @param {Mixed} param The parameter to pass to function if applicable
*
* @return {Mixed}
*/
Expand All @@ -43,7 +43,9 @@
/**
* Determine whether a value is defined and not null
*
* @param {Mixed} value - The value to check
* @private
*
* @param {Mixed} value The value to check
*
* @return {Boolean}
*/
Expand All @@ -54,9 +56,10 @@
/**
* Trigger an error
*
* @private
* @throws {Error}
*
* @param {String} msg - The error message
* @param {String} msg The error message
*/
var _error = function (msg) {
throw new Error('[angular-locker] ' + msg);
Expand All @@ -82,7 +85,7 @@
/**
* Allow the defaults to be specified via the `lockerProvider`
*
* @param {Object} value - The defaults to override
* @param {Object} value The defaults to override
*/
defaults: function (value) {
if (! _defined(value)) return defaults;
Expand All @@ -103,7 +106,7 @@
* @public
* @constructor
*
* @param {Object} options - The config options to initialize with
* @param {Object} options The config options to initialize with
*/
function Locker (options) {

Expand Down Expand Up @@ -133,7 +136,7 @@
*
* @private
*
* @param {String} driver - The storage driver identifier
* @param {String} driver The storage driver identifier
*
* @return {Storage}
*/
Expand Down Expand Up @@ -187,7 +190,7 @@
* @private
* @see github.com/Modernizr/Modernizr/blob/master/feature-detects/storage/localstorage.js#L38-L47
*
* @param {String} driver
* @param {String} driver The driver to check support with
*
* @return {Boolean}
*/
Expand All @@ -211,7 +214,7 @@
*
* @private
*
* @param {String} key
* @param {String} key The key to build the prefix with
*
* @return {String}
*/
Expand All @@ -226,7 +229,7 @@
*
* @private
*
* @param {Mixed} value
* @param {Mixed} value The value to serialize
*
* @return {Mixed}
*/
Expand All @@ -244,7 +247,7 @@
*
* @private
*
* @param {String} value
* @param {String} value The value to unserialize
*
* @return {Mixed}
*/
Expand All @@ -261,8 +264,8 @@
*
* @private
*
* @param {String} name
* @param {Object} payload
* @param {String} name The name of the event to trigger
* @param {Object} payload The data to pass along with event
*/
this._event = function (name, payload) {
if (this._options.eventsEnabled) {
Expand All @@ -279,8 +282,8 @@
* @private
* @throws {Error} if browser support fails
*
* @param {String} key
* @param {Mixed} value
* @param {String} key The key to add
* @param {Mixed} value The value to add
*/
this._setItem = function (key, value) {
if (! this._checkSupport()) {
Expand Down Expand Up @@ -312,7 +315,7 @@
* @private
* @throws {Error} if browser support fails
*
* @param {String} key
* @param {String} key The key to get
*
* @return {Mixed}
*/
Expand All @@ -330,7 +333,7 @@
* @private
* @throws {Error} if browser support fails
*
* @param {String} key
* @param {String} key The key to check for existence
*
* @return {Boolean}
*/
Expand All @@ -348,7 +351,7 @@
* @private
* @throws {Error} if browser support fails
*
* @param {String} key
* @param {String} key The key to remove
*
* @return {Boolean}
*/
Expand Down Expand Up @@ -380,9 +383,9 @@
*
* @public
*
* @param {Mixed} key - The key
* @param {Mixed} value - The value
* @param {Mixed} def - The default
* @param {Mixed} key The key to add
* @param {Mixed} value The value to add
* @param {Mixed} def The default to pass to function if doesn't already exist
*
* @return {Locker|Boolean}
*/
Expand All @@ -408,9 +411,9 @@
*
* @public
*
* @param {Mixed} key - The key to add
* @param {Mixed} value - The value to add
* @param {Mixed} def - The default
* @param {Mixed} key The key to add
* @param {Mixed} value The value to add
* @param {Mixed} def The default to pass to function if doesn't already exist
*
* @return {Boolean}
*/
Expand All @@ -428,8 +431,8 @@
*
* @public
*
* @param {String|Array} key - The key to get
* @param {Mixed} def - The default value if it does not exist
* @param {String|Array} key The key to get
* @param {Mixed} def The default value if it does not exist
*
* @return {Mixed}
*/
Expand Down Expand Up @@ -466,7 +469,7 @@
*
* @public
*
* @param {String|Array} key - The key or array of keys to remove
* @param {String|Array} key The key or array of keys to remove
*
* @return {Object}
*/
Expand All @@ -487,8 +490,8 @@
*
* @public
*
* @param {String|Array} key - The key to pull from storage
* @param {Mixed} def - The default value if it does not exist
* @param {String|Array} key The key to pull from storage
* @param {Mixed} def The default value if it does not exist
*
* @return {Mixed}
*/
Expand Down Expand Up @@ -570,9 +573,9 @@
*
* @public
*
* @param {Object} $scope
* @param {String} key
* @param {Mixed} def
* @param {Object} $scope The angular $scope object
* @param {String} key The key in storage to bind to
* @param {Mixed} def The default value to initially bind
*
* @return {Locker}
*/
Expand All @@ -595,8 +598,8 @@
*
* @public
*
* @param {Object} $scope
* @param {String} key
* @param {Object} $scope The angular $scope object
* @param {String} key The key to remove from bindings
*
* @return {Locker}
*/
Expand All @@ -620,7 +623,7 @@
*
* @public
*
* @param {String} driver - The driver to switch to
* @param {String} driver The driver to switch to
*
* @return {Locker}
*/
Expand All @@ -647,7 +650,7 @@
*
* @public
*
* @param {String} namespace - The namespace to switch to
* @param {String} namespace The namespace to switch to
*
* @return {Locker}
*/
Expand Down Expand Up @@ -675,7 +678,7 @@
* @public
* @see github.com/Modernizr/Modernizr/blob/master/feature-detects/storage/localstorage.js#L38-L47
*
* @param {String} driver - The driver to check support with
* @param {String} driver The driver to check support with
*
* @return {Boolean}
*/
Expand All @@ -688,7 +691,7 @@
*
* @public
*
* @param {Object} options - The config options to instantiate with
* @param {Object} options The config options to instantiate with
*
* @return {Locker}
*/
Expand Down
Loading

0 comments on commit 6ebb3a5

Please sign in to comment.