diff --git a/source/ajax/Ajax.js b/source/ajax/Ajax.js index 660d87fe5..d80795cd1 100644 --- a/source/ajax/Ajax.js +++ b/source/ajax/Ajax.js @@ -49,7 +49,7 @@ * @private */ constructor: enyo.inherit(function (sup) { - return function(inParams) { + return function (inParams) { enyo.mixin(this, inParams); sup.apply(this, arguments); }; @@ -59,7 +59,7 @@ * @private */ destroy: enyo.inherit(function (sup) { - return function() { + return function () { // explicilty release any XHR refs this.xhr = null; sup.apply(this, arguments); @@ -94,12 +94,12 @@ * @see enyo.AjaxProperties * @see enyo.Ajax#xhrResponse * @see enyo.Ajax~xhrResponse - * @param {(Object|String)} [params] A [string]{@glossary String} or + * @param {(Object|String)} [params] - A [string]{@glossary String} or * [hash]{@glossary Object} to be used as the query string. * @returns {this} The callee for chaining. * @public */ - go: function(params) { + go: function (params) { this.failed = false; this.startTimer(); this.request(params); @@ -109,7 +109,7 @@ /** * @private */ - request: function(params) { + request: function (params) { var parts = this.url.split('?'); var uri = parts.shift() || ''; var args = parts.length ? (parts.join('?').split('&')) : []; @@ -196,7 +196,7 @@ /** * @private */ - receive: function(inText, inXhr) { + receive: function (inText, inXhr) { if (!this.failed && !this.destroyed) { var body; if (inXhr.responseType === 'arraybuffer') { @@ -224,7 +224,7 @@ * @private */ fail: enyo.inherit(function (sup) { - return function(inError) { + return function (inError) { // on failure, explicitly cancel the XHR to prevent // further responses. cancellation also resets the // response headers & body, @@ -239,7 +239,7 @@ /** * @private */ - xhrToResponse: function(inXhr) { + xhrToResponse: function (inXhr) { if (inXhr) { return this[(this.handleAs || 'text') + 'Handler'](inXhr); } @@ -248,7 +248,7 @@ /** * @private */ - isFailure: function(inXhr) { + isFailure: function (inXhr) { // if any exceptions are thrown while checking fields in the xhr, // assume a failure. try { @@ -285,21 +285,21 @@ /** * @private */ - xmlHandler: function(inXhr) { + xmlHandler: function (inXhr) { return inXhr.responseXML; }, /** * @private */ - textHandler: function(inXhr) { + textHandler: function (inXhr) { return inXhr.responseText; }, /** * @private */ - jsonHandler: function(inXhr) { + jsonHandler: function (inXhr) { var r = inXhr.responseText; try { return r && enyo.json.parse(r); @@ -312,14 +312,14 @@ /** * @private */ - binaryHandler: function(inXhr) { + binaryHandler: function (inXhr) { return inXhr.response; }, /** * @private */ - updateProgress: function(event) { + updateProgress: function (event) { // filter out 'input' as it causes exceptions on some Firefox versions // due to unimplemented internal APIs var ev = {}; @@ -335,7 +335,7 @@ * @private */ statics: { - objectToQuery: function(/*Object*/ map) { + objectToQuery: function (/*Object*/ map) { var enc = encodeURIComponent; var pairs = []; var backstop = {}; @@ -360,7 +360,7 @@ * @private */ protectedStatics: { - parseResponseHeaders: function(xhr) { + parseResponseHeaders: function (xhr) { var headers = {}; var headersStr = []; if (xhr.getAllResponseHeaders) { diff --git a/source/ajax/Async.js b/source/ajax/Async.js index c4a9a4868..7d02ac736 100644 --- a/source/ajax/Async.js +++ b/source/ajax/Async.js @@ -119,8 +119,8 @@ * [execution]{@link enyo.Async#go} is completed successfully. Parameters may be * in any order, to preserve backward compatibility. * - * @param {Function} fn The callback to register. - * @param {Object} [ctx] The optional context under which to execute the callback. + * @param {Function} fn - The callback to register. + * @param {Object} [ctx] - The optional context under which to execute the callback. * @returns {this} The callee for chaining. * @public */ @@ -134,8 +134,8 @@ * [execution]{@link enyo.Async#go} completes with an error. Parameters may be * in any order, to preserve backward compatibility. * - * @param {Function} fn The callback to register. - * @param {Object} [ctx] The optional context under which to execute the callback. + * @param {Function} fn - The callback to register. + * @param {Object} [ctx] - The optional context under which to execute the callback. * @returns {this} The callee for chaining. * @public */ @@ -148,8 +148,8 @@ * Registers a [function]{@glossary Function} to be fired on progress events. * Parameters may be in any order, to preserve backward compatibility. * - * @param {Function} fn The callback to register. - * @param {Object} [ctx] The optional context under which to execute the callback. + * @param {Function} fn - The callback to register. + * @param {Object} [ctx] - The optional context under which to execute the callback. * @returns {this} The callee for chaining. * @public */ @@ -237,7 +237,7 @@ * Fails the [task]{@link enyo.Async} and triggers the error chain. May be called from any * handler. * - * @param {*} err The error value to pass to error handlers. + * @param {*} err - The error value to pass to error handlers. * @returns {this} The callee for chaining. * @public */ @@ -280,7 +280,7 @@ * successfully. This method is usually overloaded in [subkinds]{@glossary subkind}. * * @virtual - * @param {*} value The value to pass to responders. + * @param {*} - value The value to pass to responders. * @returns {this} The callee for chaining. * @public */ diff --git a/source/ajax/Jsonp.js b/source/ajax/Jsonp.js index 07abdaa62..d05d5ab41 100644 --- a/source/ajax/Jsonp.js +++ b/source/ajax/Jsonp.js @@ -146,7 +146,7 @@ * Initiates the asynchronous routine and will supply the given value if it completes * successfully. Overloaded from [enyo.Async.go()]{@link enyo.Async#go}. * - * @param {*} value The value to pass to responders. + * @param {*} value - The value to pass to responders. * @returns {this} The callee for chaining. * @public */ diff --git a/source/ajax/WebService.js b/source/ajax/WebService.js index 146199162..0315a334a 100644 --- a/source/ajax/WebService.js +++ b/source/ajax/WebService.js @@ -3,7 +3,7 @@ /** * Fires when a response is received. * - * @event enyo.WebService#event:onResponse + * @event enyo.WebService#onResponse * @type {Object} * @property {enyo.Async} ajax - The {@link enyo.Async} instance associated with the request. * @property {*} data - Any response data associated with the request. @@ -13,7 +13,7 @@ /** * Fires when an error is received. * - * @event enyo.WebService#event:onError + * @event enyo.WebService#onError * @type {Object} * @property {enyo.Async} ajax - The {@link enyo.Async} instance associated with the request. * @property {*} data - Any response data associated with the request. @@ -25,7 +25,7 @@ * [ProgressEvent]{@glossary ProgressEvent}. * * @see {@glossary ProgressEvent} - * @event enyo.WebService#event:onProgress + * @event enyo.WebService#onProgress * @type {Object} * @property {Boolean} lengthComputable - The read-only flag indicating whether the progress * is computable. @@ -147,8 +147,8 @@ * Sends an XHR request with the given parameters, returning the associated * {@link enyo.Async} instance. * - * @param {Object} params The parameters to pass to the request. - * @param {Object} [props] The optional properties to override the + * @param {Object} params - The parameters to pass to the request. + * @param {Object} [props] - The optional properties to override the * {@link enyo.AjaxProperties} of the request. * @returns {enyo.Async} The associated {@link enyo.Async} instance. * @public diff --git a/source/ajax/cookie.js b/source/ajax/cookie.js index c228a6abd..1259faed5 100644 --- a/source/ajax/cookie.js +++ b/source/ajax/cookie.js @@ -19,8 +19,8 @@ * Retrieves the given [cookie]{@glossary cookie} from * [document.cookie]{@glossary document.cookie}. * - * @param {String} nom The name of the cookie to retrieve. - * @returns {(String|undefined)} The [decoded]{@glossary decoreURIComponent} cookie, or + * @param {String} nom - The name of the cookie to retrieve. + * @returns {(String|undefined)} The [decoded]{@glossary decodeURIComponent} cookie, or * `undefined` if it could not be retrieved. * @public */ @@ -40,8 +40,8 @@ * application, Chrome must be started from the command line with the * `--enable-file-cookies` switch to allow cookies to be set. * - * @param {String} nom The name of the cookie. - * @param {*} value The value to be [encoded]{@glossary encodeURIComponent} for storage. + * @param {String} nom - The name of the cookie. + * @param {*} value - The value to be [encoded]{@glossary encodeURIComponent} for storage. * @param {enyo~CookieProperties} [props] The optional configuration properties to apply to * the cookie. * @public diff --git a/source/ajax/json.js b/source/ajax/json.js index 55acf6ed8..1fae320f4 100644 --- a/source/ajax/json.js +++ b/source/ajax/json.js @@ -14,13 +14,13 @@ * [object]{@glossary Object}. * * @see {@glossary JSON.stringify} - * @param {Object} value The [object]{@glossary Object} to convert to a + * @param {Object} value - The [object]{@glossary Object} to convert to a * [JSON]{@glossary JSON} [string]{@glossary String}. * @param {(Function|String[])} [replacer] An optional parameter indicating either an * [array]{@glossary Array} of keys to include in the final output or a * [function]{@glossary Function} that will have the opportunity to dynamically return * values to include for keys. - * @param {(Number|String)} [space] Determines the spacing (if any) for pretty-printed + * @param {(Number|String)} [space] - Determines the spacing (if any) for pretty-printed * output of the JSON string. A [number]{@glossary Number} indicates the number of * spaces to use in the output, while a string will be used verbatim. * @returns {String} The JSON string for the given object. @@ -36,9 +36,9 @@ * [object]{@glossary Object}, or `null` if the parameters are invalid. * * @see {@glossary JSON.parse} - * @param {String} json The [JSON]{@glossary JSON} [string]{@glossary String} to + * @param {String} json - The [JSON]{@glossary JSON} [string]{@glossary String} to * parse into an [object]{@glossary Object}. - * @param {Function} [reviver] The optional [function]{@glossary Function} to use to + * @param {Function} [reviver] - The optional [function]{@glossary Function} to use to * parse individual keys of the return object. * @returns {(Object|null)} If parameters are valid, an [object]{@glossary Object} * is returned; otherwise, `null`. diff --git a/source/ajax/xhr.js b/source/ajax/xhr.js index 03b2ef12c..8913f2196 100644 --- a/source/ajax/xhr.js +++ b/source/ajax/xhr.js @@ -36,7 +36,7 @@ * cached. To disable this, use the `header` property to specify an object where * `cache-control` is set to `null`. * - * @param {enyo.xhr.request~Options} params The options and properties for this XHR request. + * @param {enyo.xhr.request~Options} params - The options and properties for this XHR request. * @returns {XMLHttpRequest} The XHR request object. * @private */ @@ -91,7 +91,7 @@ * Removes any callbacks that might be set from Enyo code for an existing XHR * and stops the XHR from completing (if possible). * - * @param {XMLHttpRequest} The request to cancel. + * @param {XMLHttpRequest} The - request to cancel. * @private */ cancel: function (xhr) { diff --git a/source/boot/boot.js b/source/boot/boot.js index 5da7d3b7e..494f144c7 100644 --- a/source/boot/boot.js +++ b/source/boot/boot.js @@ -4,7 +4,7 @@ * @private */ enyo.machine = { - sheet: function(inPath) { + sheet: function (inPath) { var type = 'text/css'; var rel = 'stylesheet'; var isLess = (inPath.slice(-5) == '.less'); @@ -36,13 +36,13 @@ if (isLess && window.less) { window.less.sheets.push(link); if (!enyo.loader.finishCallbacks.lessRefresh) { - enyo.loader.finishCallbacks.lessRefresh = function() { + enyo.loader.finishCallbacks.lessRefresh = function () { window.less.refresh(true); }; } } }, - script: function(inSrc, onLoad, onError) { + script: function (inSrc, onLoad, onError) { if (enyo.runtimeLoading) { var script = document.createElement('script'); script.src = inSrc; @@ -60,7 +60,7 @@ /* jshint evil: false */ } }, - inject: function(inCode) { + inject: function (inCode) { /* jshint evil: true */ document.write('' + inCode + ''); /* jshint evil: false */ @@ -79,7 +79,7 @@ * * @private */ - enyo.depends = function() { + enyo.depends = function () { var ldr = enyo.loader; if (!ldr.packageFolder) { var tag = enyo.locateScript('package.js'); @@ -93,12 +93,12 @@ }; // Runtime loader - (function() { + (function () { var enyo = window.enyo; var runtimeLoadQueue = []; var domLoaded = false; - enyo.ready(function() { + enyo.ready(function () { domLoaded = true; }); @@ -112,10 +112,10 @@ * @name enyo.load * @method * @param {(String|String[])} depends The path (or paths) to load. - * @param {Function} callback The callback to execute after the package has loaded. + * @param {Function} callback - The callback to execute after the package has loaded. * @public */ - enyo.load = function(depends, callback) { + enyo.load = function (depends, callback) { if (domLoaded) { runtimeLoadQueue.push(arguments); if (!enyo.runtimeLoading) { @@ -145,12 +145,12 @@ var depends = args[0]; var dependsArg = enyo.isArray(depends) ? depends : [depends]; var onLoadCallback = args[1]; - enyo.loader.finishCallbacks.runtimeLoader = function(inBlock) { + enyo.loader.finishCallbacks.runtimeLoader = function (inBlock) { // Once loader is done loading a package, we chain a call to runtimeLoad(), // which will call the onLoadCallback from the original load call, passing // a reference to the depends argument from the original call for tracking, // followed by kicking off any additionally queued load() calls - runtimeLoad(function() { + runtimeLoad(function () { if (onLoadCallback) { onLoadCallback(inBlock); } diff --git a/source/boot/enyo.js b/source/boot/enyo.js index 99257bb11..18526eeba 100644 --- a/source/boot/enyo.js +++ b/source/boot/enyo.js @@ -1,4 +1,4 @@ -(function() { +(function () { // enyo can use information from the script tag that loads this bootstrap file var thisScript = "enyo.js"; @@ -9,7 +9,7 @@ /** * @private */ - enyo.locateScript = function(inName) { + enyo.locateScript = function (inName) { var scripts = document.getElementsByTagName("script"); for (var i=scripts.length-1, s, src, l=inName.length; (i>=0) && (s=scripts[i]); i--) { if (!s.located) { diff --git a/source/boot/ready.js b/source/boot/ready.js index c357c230c..f77a30208 100644 --- a/source/boot/ready.js +++ b/source/boot/ready.js @@ -24,8 +24,8 @@ * * @name enyo.ready * @method - * @param {Function} fn The method to execute when the DOM is ready. - * @param {Object} [context] The optional context (`this`) under which to execute the + * @param {Function} fn - The method to execute when the DOM is ready. + * @param {Object} [context] - The optional context (`this`) under which to execute the * callback method. * @public */ diff --git a/source/boot/rendered.js b/source/boot/rendered.js index d0ac143f3..f73e69805 100644 --- a/source/boot/rendered.js +++ b/source/boot/rendered.js @@ -28,7 +28,7 @@ * * @name enyo.rendered * @method - * @param {Function} method The callback to execute. + * @param {Function} method - The callback to execute. * @param {Object} [context=enyo.global] The context under which to execute the callback. * @public */ diff --git a/source/data/BucketFilter.js b/source/data/BucketFilter.js index d3f1283b8..f7ffe052a 100644 --- a/source/data/BucketFilter.js +++ b/source/data/BucketFilter.js @@ -64,7 +64,7 @@ * set it as the active filter (if it wasn't already active). Otherwise, it will set the * `activeFilter` property to the special `'*'` character and proxy its complete dataset. * - * @param {Object} [opts] The options to be passed to the internal + * @param {Object} [opts] - The options to be passed to the internal * {@link enyo.Object#set} method. * @returns {this} The callee for chaining. * @public diff --git a/source/data/Collection.js b/source/data/Collection.js index 3cfa4260f..d7c5fc294 100644 --- a/source/data/Collection.js +++ b/source/data/Collection.js @@ -71,7 +71,7 @@ * Fires when the [collection]{@link enyo.Collection} has been reset and its * contents have been updated arbitrarily. * - * @event enyo.Collection#event:reset + * @event enyo.Collection#reset * @type {Object} * @property {enyo.Model[]} models - An [array]{@glossary Array} of all * [models]{@link enyo.Model} as they are currently. @@ -202,27 +202,27 @@ /** * @callback enyo.Collection~Success - * @param {enyo.Collection} collection The [collection]{@link enyo.Collection} + * @param {enyo.Collection} collection - The [collection]{@link enyo.Collection} * that is returning successfully. - * @param {enyo.Collection~ActionOptions} opts The original options passed to the action method + * @param {enyo.Collection~ActionOptions} - opts The original options passed to the action method * that is returning successfully. - * @param {*} res The result, if any, returned by the [source]{@link enyo.Source} that + * @param {*} - res The result, if any, returned by the [source]{@link enyo.Source} that * executed it. - * @param {String} source The name of the [source]{@link enyo.Collection#source} that has + * @param {String} source - The name of the [source]{@link enyo.Collection#source} that has * returned successfully. */ /** * @callback enyo.Collection~Error - * @param {enyo.Collection} collection The [collection]{@link enyo.Collection} + * @param {enyo.Collection} collection - The [collection]{@link enyo.Collection} * that is returning an error. - * @param {String} action The name of the action that failed, one of `'FETCHING'`, + * @param {String} action - The name of the action that failed, one of `'FETCHING'`, * `'COMMITTING'`, or `'DESTROYING'`. - * @param {enyo.Collection~ActionOptions} opts The original options passed to the + * @param {enyo.Collection~ActionOptions} opts - The original options passed to the * action method that is returning an error. - * @param {*} res The result, if any, returned by the [source]{@link enyo.Source} + * @param {*} res - The result, if any, returned by the [source]{@link enyo.Source} * that executed it. - * @param {String} source The name of the [source]{@link enyo.Collection#source} + * @param {String} source - The name of the [source]{@link enyo.Collection#source} * that has returned an error. */ @@ -234,8 +234,8 @@ * @see enyo.Collection#sort * @see enyo.Collection#comparator * @callback enyo.Collection~Comparator - * @param {enyo.Model} a The first [model]{@link enyo.Model} to compare. - * @param {enyo.Model} b The second model to compare. + * @param {enyo.Model} a - The first [model]{@link enyo.Model} to compare. + * @param {enyo.Model} b - The second model to compare. * @returns {Number} `-1` if `a` should have the lower index, `0` if they are the same, * or `1` if `b` should have the lower index. */ @@ -320,7 +320,7 @@ * {@link enyo.Collection}. The array should not be modified directly, nor * should the property be set directly. It is used as a container by the * collection. If [set]{@link enyo.Collection#set} directly, it will - * [emit]{@link enyo.EventEmitter.emit} a [reset]{@link enyo.Collection#event:reset} + * [emit]{@link enyo.EventEmitter.emit} a [reset]{@link enyo.Collection#reset} * event. * * @see enyo.Collection#modelsChanged @@ -380,7 +380,7 @@ * modification before it can be added to the [collection]{@link enyo.Collection}. * This is a virtual method and must be implemented. * - * @param {*} data The incoming data passed to the + * @param {*} data - The incoming data passed to the * [constructor]{@link enyo.Collection#constructor} or returned by a successful * [fetch]{@link enyo.Collection#fetch}. * @returns {Array} The properly formatted data to be accepted by the @@ -403,13 +403,13 @@ * ensure that loops do not consecutively call this method but instead * build an array to pass as the first parameter. * - * @fires enyo.Collection#event:add + * @fires enyo.Collection#add * @param {(Object|Object[]|enyo.Model|enyo.Model[])} models The data to add to the * {@link enyo.Collection} that can be a [hash]{@glossary Object}, an array of * hashes, an {@link enyo.Model} instance, or and array of `enyo.Model` instances. * Note that if the [parse]{@link enyo.Collection#options#parse} configuration * option is `true`, it will use the returned value as this parameter. - * @param {enyo.Collection~AddOptions} [opts] The configuration options that modify + * @param {enyo.Collection~AddOptions} [opts] - The configuration options that modify * the behavior of this method. The default values will be merged with these options * before evaluating. * @returns {enyo.Model[]} The models that were added, if any. @@ -580,7 +580,7 @@ * @fires enyo.Collection#remove * @param {(enyo.Model|enyo.Model[])} models The [models]{@link enyo.Model} to remove * if they exist in the [collection]{@link enyo.Collection}. - * @param {enyo.Collection~RemoveOptions} [opts] The configuration options that modify + * @param {enyo.Collection~RemoveOptions} [opts] - The configuration options that modify * the behavior of this method. * @returns {enyo.Model[]} The models that were removed, if any. * @public @@ -643,7 +643,7 @@ /** * Retrieves a [model]{@link enyo.Model} for the provided index. * - * @param {Number} idx The index to return from the [collection]{@link enyo.Collection}. + * @param {Number} idx - The index to return from the [collection]{@link enyo.Collection}. * @returns {(enyo.Model|undefined)} The [model]{@link enyo.Model} at the given index or * `undefined` if it cannot be found. * @public @@ -670,7 +670,7 @@ * Determines if the specified [model]{@link enyo.Model} is contained by this * [collection]{@link enyo.Collection}. * - * @param {enyo.Model} model The [model]{@link enyo.Model} to check. + * @param {enyo.Model} model - The [model]{@link enyo.Model} to check. * @returns {Boolean} Whether or not the model belongs to the * [collection]{@link enyo.Collection}. * @public @@ -745,7 +745,7 @@ * @param {(enyo.Model|enyo.Model[])} [models] The [model or models]{@link enyo.Model} * to use as a replacement for the current set of models in the * {@link enyo.Collection}. - * @param {enyo.Collection~Options} [opts] The options that will modify the behavior + * @param {enyo.Collection~Options} [opts] - The options that will modify the behavior * of this method. * @returns {enyo.Model[]} The models that were removed from the collection. * @public @@ -798,14 +798,14 @@ * [comparator]{@link enyo.Collection#comparator} (if any) from the * [collection]{@link enyo.Collection}. Note that the collection is sorted in-place * and returns a reference to itself. The collection - * [emits]{@link enyo.EventEmitter.emit} the [sort]{@link enyo.Collection#event:sort} + * [emits]{@link enyo.EventEmitter.emit} the [sort]{@link enyo.Collection#sort} * event. * - * @fires enyo.Collection#event:sort + * @fires enyo.Collection#sort * @see {@glossary Array.sort} - * @param {enyo.Collection~Comparator} [fn] The [comparator]{@link enyo.Collection#comparator} + * @param {enyo.Collection~Comparator} [fn] - The [comparator]{@link enyo.Collection#comparator} * method. - * @param {enyo.Collection~Options} [opts] The configuration options. + * @param {enyo.Collection~Options} [opts] - The configuration options. * @returns {this} The callee for chaining. * @public */ @@ -837,7 +837,7 @@ * * @see enyo.Collection#committed * @see enyo.Collection#status - * @param {enyo.Collection~ActionOptions} [opts] Optional configuration options. + * @param {enyo.Collection~ActionOptions} [opts] - Optional configuration options. * @returns {this} The callee for chaining. * @public */ @@ -889,7 +889,7 @@ * * @see enyo.Collection#fetched * @see enyo.Collection#status - * @param {enyo.Collection~ActionOptions} [opts] Optional configuration options. + * @param {enyo.Collection~ActionOptions} [opts] - Optional configuration options. * @returns {this} The callee for chaining. * @public */ @@ -944,7 +944,7 @@ * it will remove this flag (even if it fails). * * @see enyo.Collection#status - * @param {enyo.Collection~ActionOptions} [opts] Optional configuration options. + * @param {enyo.Collection~ActionOptions} [opts] - Optional configuration options. * @returns {this} The callee for chaining. * @method * @public @@ -1074,12 +1074,12 @@ * flag. If a [success]{@link enyo.Collection~Success} callback was provided, it will be * called once for each source. * - * @param {enyo.Collection~ActionOptions} opts The original options passed to + * @param {enyo.Collection~ActionOptions} opts - The original options passed to * [commit()]{@link enyo.Collection#commit}, merged with the defaults. - * @param {*} [res] The result provided from the given + * @param {*} [res] - The result provided from the given * [source]{@link enyo.Collection#source}, if any. This will vary depending * on the source. - * @param {String} source The name of the source that has completed successfully. + * @param {String} source - The name of the source that has completed successfully. * @public */ committed: function (opts, res, source) { @@ -1111,12 +1111,12 @@ * a [success]{@link enyo.Collection~Success} callback was provided, it will be called * once for each source. * - * @param {enyo.Collection~ActionOptions} opts The original options passed to + * @param {enyo.Collection~ActionOptions} opts - The original options passed to * [fetch()]{@link enyo.Collection#fetch}, merged with the defaults. - * @param {*} [res] The result provided from the given + * @param {*} [res] - The result provided from the given * [source]{@link enyo.Collection#source}, if any. This will vary depending * on the source. - * @param {String} source The name of the source that has completed successfully. + * @param {String} source - The name of the source that has completed successfully. * @public */ fetched: function (opts, res, source) { @@ -1154,13 +1154,13 @@ * [error handler]{@link enyo.Collection~ErrorCallback}. If the error handler * exists, it will be called. * - * @param {String} action The name of the action that failed, + * @param {String} action - The name of the action that failed, * one of `'FETCHING'` or `'COMMITTING'`. - * @param {enyo.Collection~ActionOptions} opts The options hash originally + * @param {enyo.Collection~ActionOptions} opts - The options hash originally * passed along with the original action. - * @param {*} [res] The result of the requested `action`; varies depending on the + * @param {*} [res] - The result of the requested `action`; varies depending on the * requested [source]{@link enyo.Collection#source}. - * @param {String} source The name of the source that has returned an error. + * @param {String} source - The name of the source that has returned an error. * @public */ errored: function (action, opts, res, source) { @@ -1215,7 +1215,7 @@ * Responds to changes to the [models]{@link enyo.Collection#models} property. * * @see enyo.Collection#models - * @fires enyo.Collection#event:reset + * @fires enyo.Collection#reset * @type {enyo.ObserverSupport~Observer} * @public */ @@ -1235,9 +1235,9 @@ * of either [models]{@link enyo.Model} or [hashes]{@glossary Object} used to * initialize the [collection]{@link enyo.Collection}, or an [object]{@glossary Object} * equivalent to the `props` parameter. - * @param {Object} [props] A hash of properties to apply directly to the + * @param {Object} [props] - A hash of properties to apply directly to the * collection. - * @param {Object} [opts] A hash. + * @param {Object} [opts] - A hash. * @method * @public */ diff --git a/source/data/Model.js b/source/data/Model.js index b4e045e4a..17e3626c4 100644 --- a/source/data/Model.js +++ b/source/data/Model.js @@ -63,25 +63,25 @@ /** * @callback enyo.Model~Success - * @param {enyo.Model} model The [model]{@link enyo.Model} that is returning successfully. - * @param {enyo.Model~ActionOptions} opts The original options passed to the action method + * @param {enyo.Model} model - The [model]{@link enyo.Model} that is returning successfully. + * @param {enyo.Model~ActionOptions} opts - The original options passed to the action method * that is returning successfully. - * @param {*} res The result, if any, returned by the [source]{@link enyo.Source} that + * @param {*} res - The result, if any, returned by the [source]{@link enyo.Source} that * executed it. - * @param {String} source The name of the [source]{@link enyo.Model#source} that has + * @param {String} source - The name of the [source]{@link enyo.Model#source} that has * returned successfully. */ /** * @callback enyo.Model~Error - * @param {enyo.Model} model The model that is returning an error. - * @param {String} action The name of the action that failed, one of `'FETCHING'`, + * @param {enyo.Model} model - The model that is returning an error. + * @param {String} action - The name of the action that failed, one of `'FETCHING'`, * `'COMMITTING'`, or `'DESTROYING'`. - * @param {enyo.Model~Options} opts The original options passed to the action method + * @param {enyo.Model~Options} opts - The original options passed to the action method * that is returning an error. - * @param {*} res The result, if any, returned by the [source]{@link enyo.Source} that + * @param {*} res - The result, if any, returned by the [source]{@link enyo.Source} that * executed it. - * @param {String} source The name of the [source]{@link enyo.Model#source} that has + * @param {String} source - The name of the [source]{@link enyo.Model#source} that has * returned an error. */ @@ -268,7 +268,7 @@ * given implementation's needs. * * @see enyo.Model~Options.parse - * @param {*} data The incoming data that may need to be restructured or reduced prior to + * @param {*} data - The incoming data that may need to be restructured or reduced prior to * being [set]{@link enyo.Model#set} on the [model]{@link enyo.Model}. * @returns {Object} The [hash]{@glossary Object} to apply to the * model via [set()]{@link enyo.Model#set}. @@ -327,7 +327,7 @@ * * @see enyo.Model#set * @see enyo.Model#previous - * @param {String} [prop] The [attribute]{@link enyo.Model#attributes} to + * @param {String} [prop] - The [attribute]{@link enyo.Model#attributes} to * [restore]{@link enyo.Model#restore}. If not provided, all attributes will be * restored to their previous values. * @returns {this} The callee for chaining. @@ -355,7 +355,7 @@ * * @see enyo.Model#committed * @see enyo.Model#status - * @param {enyo.Model~ActionOptions} [opts] Optional configuration options. + * @param {enyo.Model~ActionOptions} [opts] - Optional configuration options. * @returns {this} The callee for chaining. * @public */ @@ -408,7 +408,7 @@ * * @see enyo.Model#fetched * @see enyo.Model#status - * @param {enyo.Model~ActionOptions} [opts] Optional configuration options. + * @param {enyo.Model~ActionOptions} [opts] - Optional configuration options. * @returns {this} The callee for chaining. * @public */ @@ -463,7 +463,7 @@ * will remove this flag (even if it fails). * * @see enyo.Model#status - * @param {enyo.Model~ActionOptions} [opts] Optional configuration options. + * @param {enyo.Model~ActionOptions} [opts] - Optional configuration options. * @returns {this} The callee for chaining. * @public */ @@ -556,7 +556,7 @@ * that value; otherwise, it will attempt to retrieve the value from the * [attributes hash]{@link enyo.Model#attributes}. * - * @param {String} path The property to retrieve. + * @param {String} path - The property to retrieve. * @returns {*} The value for the requested property or path, or `undefined` if * it cannot be found or does not exist. * @public @@ -574,15 +574,15 @@ * individual [notifications]{@link enyo.ObserverSupport.notify} for the * properties that were modified. * - * @fires enyo.Model#event:change + * @fires enyo.Model#change * @see enyo.ObserverSupport * @see enyo.BindingSupport - * @param {(String|Object)} path Either the property name or a [hash]{@glossary Object} + * @param {(String|Object)} path - Either the property name or a [hash]{@glossary Object} * of properties and values to set. * @param {(*|enyo.Model~Options)} is If `path` is a [string]{@glossary String}, * this should be the value to set for the given property; otherwise, it should be * an optional hash of available [configuration options]{@link enyo.Model~Options}. - * @param {enyo.Model~Options} [opts] If `path` is a string, this should be the + * @param {enyo.Model~Options} [opts] - If `path` is a string, this should be the * optional hash of available configuration options; otherwise, it will not be used. * @returns {this} The callee for chaining. * @public @@ -673,13 +673,13 @@ * Initializes the [model]{@link enyo.Model}. Unlike some methods, the parameters are not * interchangeable. If you are not using a particular (optional) parameter, pass in `null`. * - * @param {Object} [attrs] Optionally initialize the [model]{@link enyo.Model} with some + * @param {Object} [attrs] - Optionally initialize the [model]{@link enyo.Model} with some * [attributes]{@link enyo.Model#attributes}. - * @param {Object} [props] Properties to apply directly to the [model]{@link enyo.Model} and + * @param {Object} [props] - Properties to apply directly to the [model]{@link enyo.Model} and * not the [attributes hash]{@link enyo.Model#attributes}. If these properties contain an * `options` property (a [hash]{@glossary Object}) it will be merged with existing * [options]{@link enyo.Model#options}. - * @param {enyo.Model~Options} [opts] This is a one-time [options hash]{@link enyo.Model~Options} that + * @param {enyo.Model~Options} [opts] - This is a one-time [options hash]{@link enyo.Model~Options} that * is only used during initialization and not applied as defaults. * @public */ @@ -766,11 +766,11 @@ * If a [success]{@link enyo.Model~Success} callback was provided, it will be called * once for each source. * - * @param {enyo.Model~ActionOptions} opts The original options passed to + * @param {enyo.Model~ActionOptions} opts - The original options passed to * [fetch()]{@link enyo.Model#fetch}, merged with the defaults. - * @param {*} [res] The result provided from the given [source]{@link enyo.Model#source}, + * @param {*} [res] - The result provided from the given [source]{@link enyo.Model#source}, * if any. This will vary depending on the source. - * @param {String} source The name of the source that has completed successfully. + * @param {String} source - The name of the source that has completed successfully. * @public */ fetched: function (opts, res, source) { @@ -810,11 +810,11 @@ * [success]{@link enyo.Model~Success} callback was provided, it will be called once for * each source. * - * @param {enyo.Model~ActionOptions} opts The original options passed to + * @param {enyo.Model~ActionOptions} opts - The original options passed to * [commit()]{@link enyo.Model#commit}, merged with the defaults. - * @param {*} [res] The result provided from the given [source]{@link enyo.Model#source}, + * @param {*} [res] - The result provided from the given [source]{@link enyo.Model#source}, * if any. This will vary depending on the source. - * @param {String} source The name of the source that has completed successfully. + * @param {String} source - The name of the source that has completed successfully. * @public */ committed: function (opts, res, source) { @@ -850,13 +850,13 @@ * will execute it. * * @see enyo.StateSupport.clearError - * @param {String} action The action (one of `'FETCHING'`, `'COMMITTING'`, or + * @param {String} action - The action (one of `'FETCHING'`, `'COMMITTING'`, or * `'DESTROYING'`) that failed and is now in an [error state]{@link enyo.States.ERROR}. - * @param {enyo.Model~ActionOptions} opts The original options passed to the `action` + * @param {enyo.Model~ActionOptions} opts - The original options passed to the `action` * method, merged with the defaults. - * @param {*} [res] The result provided from the given [source]{@link enyo.Model#source}, + * @param {*} [res] - The result provided from the given [source]{@link enyo.Model#source}, * if any. This will vary depending on the source. - * @param {String} source The name of the source that has returned an error. + * @param {String} source - The name of the source that has returned an error. * @public */ errored: function (action, opts, res, source) { diff --git a/source/data/ModelList.js b/source/data/ModelList.js index f5505e232..63e3505ce 100644 --- a/source/data/ModelList.js +++ b/source/data/ModelList.js @@ -26,7 +26,7 @@ * @method * @param {(enyo.Model|enyo.Model[])} models The [model or models]{@link enyo.Model} * to add to the [list]{@link enyo.ModelList}. - * @param {Number} [idx] If provided and valid, the models will be + * @param {Number} [idx] - If provided and valid, the models will be * [spliced]{@glossary Array.splice} into the list at this position. * @returns {enyo.Model[]} An immutable [array]{@glossary Array} of models * that were actually added to the list. @@ -142,7 +142,7 @@ * * @name enyo.ModelList#resolve * @method - * @param {(String|Number)} model An identifier (either a + * @param {(String|Number)} model - An identifier (either a * [primaryKey]{@link enyo.Model#primaryKey} or an [euid]{@glossary euid}). * @returns {(undefined|null|enyo.Model)} If the identifier could be resolved, a * [model]{@link enyo.Model} instance is returned; otherwise, `undefined`, or diff --git a/source/data/RelationalModel.js b/source/data/RelationalModel.js index 7d0370523..75a8e538f 100644 --- a/source/data/RelationalModel.js +++ b/source/data/RelationalModel.js @@ -938,7 +938,7 @@ * Retrieves the relation instance for a given key * ([attribute]{@link enyo.Model#attributes}). * - * @param {String} key The key as defined in the + * @param {String} key - The key as defined in the * [relations]{@link enyo.RelationalModel#relations} property. * @returns {(Relation|undefined)} The correct relation instance, or * `undefined` if not found. @@ -953,7 +953,7 @@ /** * Determines whether the requested key is the name of a relation. * - * @param {String} key The key as defined in the + * @param {String} key - The key as defined in the * [relations]{@link enyo.RelationalModel#relations} property. * @returns {(Relation|undefined)} The correct relation instance, or * `undefined` if not found. diff --git a/source/data/Source.js b/source/data/Source.js index 08aa9bd09..7bc2bce73 100644 --- a/source/data/Source.js +++ b/source/data/Source.js @@ -42,7 +42,7 @@ * These properties should include the name by which it will be referenced in * the application. * - * @param {Object} [props] The properties to set on itself. + * @param {Object} [props] - The properties to set on itself. * @public */ constructor: function (props) { @@ -61,7 +61,7 @@ * @virtual * @param {(enyo.Model|enyo.Collection)} model The [model]{@link enyo.Model} or * [collection]{@link enyo.Collection} to be retrieved. - * @param {Object} opts The configuration options [hash]{@glossary Object}, including + * @param {Object} opts - The configuration options [hash]{@glossary Object}, including * `success` and `error` callbacks. */ fetch: function (model, opts) { @@ -76,7 +76,7 @@ * @virtual * @param {(enyo.Model|enyo.Collection)} model The [model]{@link enyo.Model} or * [collection]{@link enyo.Collection} to be persisted. - * @param {Object} opts The configuration options [hash]{@glossary Object}, including + * @param {Object} opts - The configuration options [hash]{@glossary Object}, including * `success` and `error` callback. */ commit: function (model, opts) { @@ -92,7 +92,7 @@ * * @param {(enyo.Model|enyo.Collection)} model The [model]{@link enyo.Model} or * [collection]{@link enyo.Collection} to be deleted. - * @param {Object} opts The configuration options [hash]{@glossary Object}, including + * @param {Object} opts - The configuration options [hash]{@glossary Object}, including * `success` and `error` callbacks. */ destroy: function (model, opts) { @@ -111,9 +111,9 @@ * properties, including `success` and `error` callbacks to handle the result. * * @virtual - * @param {Function} ctor The constructor for the [kind]{@glossary kind} of + * @param {Function} ctor - The constructor for the [kind]{@glossary kind} of * {@link enyo.Model} or {@link enyo.Collection} to be queried. - * @param {Object} opts The configuration options [hash]{@glossary Object}, including + * @param {Object} opts - The configuration options [hash]{@glossary Object}, including * `success` and `error` callbacks. */ find: function (ctor, opts) { @@ -154,7 +154,7 @@ * @name enyo.Source.create * @static * @method - * @param {Object} props The properties to pass to the constructor for the requested + * @param {Object} props - The properties to pass to the constructor for the requested * [kind]{@glossary kind} of [source]{@link enyo.Source}. * @returns {enyo.Source} An instance of the requested kind of source. * @public diff --git a/source/data/States.js b/source/data/States.js index 73c37706b..3addb365f 100644 --- a/source/data/States.js +++ b/source/data/States.js @@ -227,7 +227,7 @@ * (or the optional passed-in value) is an [error state]{@link enyo.States.ERROR}. * The passed-in value will only be used if it is a [Number]{@glossary Number}. * - * @param {enyo.States} [status] The specific value to compare as an + * @param {enyo.States} [status] - The specific value to compare as an * [error state]{@link enyo.States.ERROR}. * @returns {Boolean} Whether the value is an [error state]{@link enyo.States.ERROR} or not. * @public @@ -242,7 +242,7 @@ * (or the optional passed-in value) is a [busy state]{@link enyo.States.BUSY}. The * passed-in value will only be used if it is a [Number]{@glossary Number}. * - * @param {enyo.States} [status] The specific value to compare as a + * @param {enyo.States} [status] - The specific value to compare as a * [busy state]{@link enyo.States.BUSY}. * @returns {Boolean} Whether the value is a [busy state]{@link enyo.States.BUSY} or not. * @public @@ -257,7 +257,7 @@ * (or the optional passed-in value) is a [ready state]{@link enyo.States.READY}. The * passed-in value will only be used if it is a [Number]{@glossary Number}. * - * @param {enyo.States} [status] The specific value to compare as a + * @param {enyo.States} [status] - The specific value to compare as a * [ready state]{@link enyo.States.READY}. * @returns {Boolean} Whether the value is a [ready state]{@link enyo.States.BUSY} or not. * @public diff --git a/source/data/Store.js b/source/data/Store.js index fa45202f8..9cabc32c2 100644 --- a/source/data/Store.js +++ b/source/data/Store.js @@ -25,7 +25,7 @@ * method. * * @callback enyo.Store~Filter - * @param {enyo.Model} model The [model]{@link enyo.Model} to filter. + * @param {enyo.Model} model - The [model]{@link enyo.Model} to filter. * @returns {Boolean} `true` if the model meets the filter requirements; * otherwise, `false`. */ @@ -64,10 +64,10 @@ * match. * * @see {@glossary Array.find} - * @param {enyo.Model} ctor The constructor for the [kind]{@glossary kind} of + * @param {enyo.Model} ctor - The constructor for the [kind]{@glossary kind} of * [model]{@link enyo.Model} to be filtered. - * @param {enyo.Store~Filter} fn The filter method. - * @param {enyo.Store~FindOptions} [opts] The options parameter. + * @param {enyo.Store~Filter} fn - The filter method. + * @param {enyo.Store~FindOptions} [opts] - The options parameter. * @returns {(enyo.Model|enyo.Model[]|undefined)} If the `all` flag is `true`, * returns an array of models; otherwise, returns the first model that returned * that returned `true` from the filter method. Returns `undefined` if `all` is diff --git a/source/data/sources/localStorage.js b/source/data/sources/localStorage.js index dc1e37f44..16d2daeac 100644 --- a/source/data/sources/localStorage.js +++ b/source/data/sources/localStorage.js @@ -57,6 +57,8 @@ * [collections]{@link enyo.Collection} that will be stored by this * {@link enyo.LocalStorageSource}. * + * @type {String} + * @default 'enyo-app' * @public */ prefix: 'enyo-app', diff --git a/source/data/sources/xhr.js b/source/data/sources/xhr.js index 12075ef97..c6a74d26f 100644 --- a/source/data/sources/xhr.js +++ b/source/data/sources/xhr.js @@ -77,7 +77,7 @@ * * @param {(enyo.Model|enyo.Collection)} model The [model]{@link enyo.Model} or * [collection]{@link enyo.Collection} to use to derive the `url`. - * @param {Object} [opts] The options hash with possible `url` property. + * @param {Object} [opts] - The options hash with possible `url` property. * @returns {String} The normalized `url` [string]{@glossary String}. * @method * @public @@ -138,7 +138,7 @@ * * @param {(enyo.Model|enyo.Collection)} model The [model]{@link enyo.Model} or * [collection]{@link enyo.Collection} from which to build the `url`. - * @param {Object} opts The options [hash]{@glossary Object} passed to + * @param {Object} opts - The options [hash]{@glossary Object} passed to * [buildUrl()]{@link enyo.XHRSource#buildUrl} and possessing `method` and `attributes` * properties. * @public diff --git a/source/dom/Control.js b/source/dom/Control.js index 4ba13329e..dfbd7ab99 100644 --- a/source/dom/Control.js +++ b/source/dom/Control.js @@ -186,7 +186,7 @@ * [string]{@link exteral:String} to be applied to each of the position/size * assignments. * - * @param {Object} bounds An [object]{@glossary Object}, optionally + * @param {Object} bounds - An [object]{@glossary Object}, optionally * containing one or more of the following properties: `width`, `height`, * `top`, `right`, `bottom`, and `left`. * @param {String} [unit='px'] @@ -302,7 +302,7 @@ * [hash]{@glossary Object}, from its cache of node attributes, or, if it has * yet to be cached, from the [node]{@glossary Node} itself. * - * @param {String} name The attribute name to get. + * @param {String} name - The attribute name to get. * @returns {(String|Null)} The value of the requested attribute, or `null` * if there isn't a [DOM node]{@glossary Node} yet. * @public @@ -331,8 +331,8 @@ * `name` a value of `null`, `false`, or the empty string `("")` will remove * the attribute from the node altogether. * - * @param {String} name Attribute name to assign/remove. - * @param {(String|Number|null)} value The value to assign to `name` + * @param {String} name - Attribute name to assign/remove. + * @param {(String|Number|null)} value - The value to assign to `name` * @returns {this} Callee for chaining. * @public */ @@ -358,8 +358,8 @@ * Reads the `name` property directly from the [node]{@glossary Node}. You * may provide a default (`def`) to use if there is no node yet. * - * @param {String} name The [node]{@glossary Node} property name to get. - * @param {*} def The default value to apply if there is no node. + * @param {String} name - The [node]{@glossary Node} property name to get. + * @param {*} def - The default value to apply if there is no node. * @returns {String} The value of the `name` property, or `def` if the node * was not available. * @public @@ -371,8 +371,8 @@ /** * Sets the value of a property (`name`) directly on the [node]{@glossary Node}. * - * @param {String} name The [node]{@glossary Node} property name to set. - * @param {*} value The value to assign to the property. + * @param {String} name - The [node]{@glossary Node} property name to set. + * @param {*} value - The value to assign to the property. * @returns {this} The callee for chaining. * @public */ @@ -384,7 +384,7 @@ /** * Appends additional content to this control. * - * @param {String} content The new string to add to the end of the `content` + * @param {String} content - The new string to add to the end of the `content` * property. * @returns {this} The callee for chaining. * @public @@ -401,7 +401,7 @@ /** * Determines whether this control has the class `name`. * - * @param {String} name The name of the class (or classes) to check for. + * @param {String} name - The name of the class (or classes) to check for. * @returns {Boolean} Whether the control has the class `name`. * @public */ @@ -412,7 +412,7 @@ /** * Adds the specified class to this control's list of classes. * - * @param {String} name The name of the class to add. + * @param {String} name - The name of the class to add. * @returns {this} The callee for chaining. * @public */ @@ -438,7 +438,7 @@ * class names into this method. Instead, call the method once for each class * name that you want to remove.** * - * @param {String} name The name of the class to remove. + * @param {String} name - The name of the class to remove. * @returns {this} The callee for chaining. * @public */ @@ -456,8 +456,8 @@ * Adds or removes the specified class conditionally, based on the state * of the `add` argument. * - * @param {String} name The name of the class to add or remove. - * @param {Boolean} add If `true`, `name` will be added as a class; if + * @param {String} name - The name of the class to add or remove. + * @param {Boolean} add - If `true`, `name` will be added as a class; if * `false`, it will be removed. * @returns {this} The callee for chaining. * @public @@ -498,8 +498,8 @@ * the desired value. Setting `value` to `null` will remove the CSS property * `prop` altogether. * - * @param {String} prop The CSS property to assign. - * @param {(String|Number|null|undefined)} value The value to assign to + * @param {String} prop - The CSS property to assign. + * @param {(String|Number|null|undefined)} value - The value to assign to * `prop`. Setting a value of `null`, `undefined`, or the empty string `("")` * will remove the property `prop` from the control. * @returns {this} Callee for chaining. @@ -566,8 +566,9 @@ * Allows the addition of several CSS properties and values at once, via a * single string, similar to how the HTML `style` attribute works. * - * @param {String} css A string containing one or more valid CSS styles. + * @param {String} css - A string containing one or more valid CSS styles. * @returns {this} The callee for chaining. + * @public */ addStyles: function (css) { var key, @@ -610,8 +611,8 @@ * the "computed" value. If the control isn't been rendered yet, and you need * a default value (such as `0`), include it in the arguments as `def`. * - * @param {String} prop The property name to get. - * @param {*} [def] An optional default value, in case the control isn't + * @param {String} prop - The property name to get. + * @param {*} [def] - An optional default value, in case the control isn't * rendered yet. * @returns {(String|Number)} The computed value of `prop`, as the browser * sees it. @@ -697,7 +698,7 @@ /** * Returns true if this control and all parents are showing. * - * @param {Boolean} ignoreBounds If `true`, it will not force a layout by retrieving + * @param {Boolean} ignoreBounds - If `true`, it will not force a layout by retrieving * computed bounds and rely on the return from {@link enyo.Control.showing} exclusively. * @returns {Boolean} Indicates whether the control is showing (visible). * @public @@ -853,7 +854,7 @@ * [DOM node]{@glossary Node}. This will replace any existing nodes in the * target `parentNode`. * - * @param {Node} parentNode The new parent of this control. + * @param {Node} parentNode - The new parent of this control. * @returns {this} The callee for chaining. * @public */ diff --git a/source/dom/animation.js b/source/dom/animation.js index 0a0badc5b..19724075c 100644 --- a/source/dom/animation.js +++ b/source/dom/animation.js @@ -53,9 +53,9 @@ * On compatible browsers, if `node` is defined, the [callback]{@glossary callback} will * fire only if `node` is visible. * - * @param {Function} callback A [callback]{@glossary callback} to be executed on the + * @param {Function} callback - A [callback]{@glossary callback} to be executed on the * animation frame. - * @param {Node} node The DOM node to request the animation frame for. + * @param {Node} node - The DOM node to request the animation frame for. * @returns {Object} A request id to be used with * [enyo.cancelRequestAnimationFrame()]{@link enyo.cancelRequestAnimationFrame}. * @public @@ -137,11 +137,11 @@ * method applies the `easing` function to the percentage of time elapsed * divided by duration, capped at 100%. * - * @param {Number} t0 Start time. - * @param {Number} duration Duration in milliseconds. - * @param {Function} easing An easing [function]{@glossary Function} reference from + * @param {Number} t0 - Start time. + * @param {Number} duration - Duration in milliseconds. + * @param {Function} easing - An easing [function]{@glossary Function} reference from * {@link enyo.easing}. - * @param {Boolean} reverse Whether the animation will run in reverse. + * @param {Boolean} reverse - Whether the animation will run in reverse. * @returns {Number} The resulting position, capped at a maximum of 100%. * @public */ @@ -161,13 +161,13 @@ * Applies the `easing` function with a wider range of variables to allow for * more complex animations. * - * @param {Number} t0 Start time. - * @param {Number} duration Duration in milliseconds. - * @param {Function} easing An easing [function]{@glossary Function} reference from + * @param {Number} t0 - Start time. + * @param {Number} duration - Duration in milliseconds. + * @param {Function} easing - An easing [function]{@glossary Function} reference from * {@link enyo.easing}. - * @param {Boolean} reverse Whether the animation will run in reverse. + * @param {Boolean} reverse - Whether the animation will run in reverse. * @param {Number} time - * @param {Number} startValue Starting value. + * @param {Number} startValue - Starting value. * @param {Number} valueChange * @returns {Number} The resulting position, capped at a maximum of 100%. * @public diff --git a/source/dom/dispatcher.js b/source/dom/dispatcher.js index db3c2112c..228d0747f 100644 --- a/source/dom/dispatcher.js +++ b/source/dom/dispatcher.js @@ -1,4 +1,20 @@ (function (enyo, source) { + /** + * An [object]{@glossary Object} describing the the last known coordinates of the cursor or + * user-interaction point in touch environments. + * + * @typedef {Object} enyo.dispatcher~CursorCoordinates + * @property {Number} clientX - The horizontal coordinate within the application's client area. + * @property {Number} clientY - The vertical coordinate within the application's client area. + * @property {Number} pageX - The X coordinate of the cursor relative to the viewport, including any + * scroll offset. + * @property {Number} pageY - The Y coordinate of the cursor relative to the viewport, including any + * scroll offset. + * @property {Number} screenX - The X coordinate of the cursor relative to the screen, not including + * any scroll offset. + * @property {Number} screenY - The Y coordinate of the cursor relative to the screen, not including + * any scroll offset. + */ /** * @private @@ -315,6 +331,8 @@ * device pixels) and IE8 has no support for the `pageX` and `pageY` properties, * so they are facaded. * + * @returns {enyo.dispatcher~CursorCoordinates} An [object]{@glossary Object} describing the + * the last known coordinates of the cursor or user-interaction point in touch environments. * @public */ enyo.getPosition = function () { diff --git a/source/dom/dom.js b/source/dom/dom.js index 47390320a..92cc995fc 100644 --- a/source/dom/dom.js +++ b/source/dom/dom.js @@ -2,7 +2,7 @@ /** * Allows bootstrapping in environments that do not have a window object right away. * - * @param {Function} func The function to run + * @param {Function} func - The function to run * @public */ enyo.requiresWindow = function(func) { @@ -25,9 +25,10 @@ * var domNode = enyo.dom.byId(node); * ``` * - * @param {String} id The document element ID to get. - * @param {Node} [doc] A [node]{@glossary Node} to search in. Default is the whole + * @param {String} id - The document element ID to get. + * @param {Node} [doc] - A [node]{@glossary Node} to search in. Default is the whole * document. + * @returns {Element} A reference to a DOM element. * @public */ byId: function(id, doc){ @@ -45,7 +46,7 @@ * '&lt;code&gt;'This &amp; That'&lt;/code&gt;' * ``` * - * @param {String} text A string with entities you'd like to escape/convert. + * @param {String} text - A string with entities you'd like to escape/convert. * @returns {String} A string that is properly escaped (the above characters.) * @public */ @@ -56,7 +57,7 @@ /** * Returns an object describing the geometry of this node. * - * @param {Node} n The [node]{@glossary Node} to measure. + * @param {Node} n - The [node]{@glossary Node} to measure. * @returns {Object} An object containing the properties `top`, `left`, * `height`, and `width`. * @public @@ -281,8 +282,8 @@ /** * Gets the boundaries of a [node's]{@glossary Node} `margin` or `padding` box. * - * @param {Node} node The [node]{@glossary Node} to measure. - * @param {Node} box The boundary to measure from ('padding' or 'margin'). + * @param {Node} node - The [node]{@glossary Node} to measure. + * @param {Node} box - The boundary to measure from ('padding' or 'margin'). * @returns {Object} An object containing the properties `top`, `right`, `bottom`, and * `left`. * @public @@ -301,7 +302,7 @@ * Gets the calculated padding of a node. Shortcut for * [enyo.dom.calcBoxExtents()]{@link enyo.dom.calcBoxExtents}. * - * @param {Node} node The [node]{@glossary Node} to measure. + * @param {Node} node - The [node]{@glossary Node} to measure. * @returns {Object} An object containing the properties `top`, `right`, `bottom`, and * `left`. * @public @@ -314,7 +315,7 @@ * Gets the calculated margin of a node. Shortcut for * [enyo.dom.calcBoxExtents()]{@link enyo.dom.calcBoxExtents}. * - * @param {Node} node The [node]{@glossary Node} to measure. + * @param {Node} node - The [node]{@glossary Node} to measure. * @returns {Object} An object containing the properties `top`, `right`, `bottom`, and * `left`. * @public @@ -330,8 +331,8 @@ * the position will be relative to the viewport and suitable for absolute positioning in a * floating layer. * - * @param {Node} node The [node]{@glossary Node} to measure. - * @param {Node} relativeToNode The [node]{@glossary Node} to measure the distance from. + * @param {Node} node - The [node]{@glossary Node} to measure. + * @param {Node} relativeToNode - The [node]{@glossary Node} to measure the distance from. * @returns {Object} An object containing the properties `top`, `right`, `bottom`, `left`, * `height`, and `width`. * @public @@ -413,8 +414,8 @@ /** * Sets the `innerHTML` property of the specified `node` to `html`. * - * @param {Node} node The [node]{@glossary Node} to set. - * @param {String} html An HTML string. + * @param {Node} node - The [node]{@glossary Node} to set. + * @param {String} html - An HTML string. * @public */ setInnerHtml: function(node, html) { @@ -424,8 +425,8 @@ /** * Checks a [DOM]{@glossary Node} [node]{@glossary Node} for a specific CSS class. * - * @param {Node} node The [node]{@glossary Node} to set. - * @param {String} s The class name to check for. + * @param {Node} node - The [node]{@glossary Node} to set. + * @param {String} s - The class name to check for. * @returns {(Boolean|undefined)} `true` if `node` has the `s` class; `undefined` * if there is no `node` or it has no `className` property. * @public @@ -438,8 +439,8 @@ /** * Uniquely adds a CSS class to a DOM node. * - * @param {Node} node The [node]{@glossary Node} to set. - * @param {String} s The class name to add. + * @param {Node} node - The [node]{@glossary Node} to set. + * @param {String} s - The class name to add. * @public */ addClass: function(node, s) { @@ -452,8 +453,8 @@ /** * Removes a CSS class from a DOM node if it exists. * - * @param {Node} node The [node]{@glossary Node} from which to remove the class. - * @param {String} s The class name to remove from `node`. + * @param {Node} node - The [node]{@glossary Node} from which to remove the class. + * @param {String} s - The class name to remove from `node`. * @public */ removeClass: function(node, s) { @@ -467,7 +468,7 @@ * Adds a class to `document.body`. This defers the actual class change if nothing has been * rendered into `body` yet. * - * @param {String} s The class name to add to the document's `body`. + * @param {String} s - The class name to add to the document's `body`. * @public */ addBodyClass: function(s) { @@ -496,7 +497,7 @@ * Values returned are only valid if `hasNode()` is truthy. If there's no DOM node for the * object, this returns a bounds structure with `undefined` as the value of all fields. * - * @param {Node} n The [node]{@glossary Node} to measure. + * @param {Node} n - The [node]{@glossary Node} to measure. * @returns {Object} An object containing the properties `top`, `right`, `bottom`, `left`, * `height`, and `width`. * @public diff --git a/source/dom/gesture.js b/source/dom/gesture.js index 3b26b5569..741407620 100644 --- a/source/dom/gesture.js +++ b/source/dom/gesture.js @@ -26,8 +26,8 @@ * Creates an {@glossary event} of type `type` and returns it. * `evt` should be an event [object]{@glossary Object}. * - * @param {String} type The type of {@glossary event} to make. - * @param {(Event|Object)} evt The event you'd like to clone or an object that looks like it. + * @param {String} type - The type of {@glossary event} to make. + * @param {(Event|Object)} evt - The event you'd like to clone or an object that looks like it. * @returns {Object} The new event [object]{@glossary Object}. * @public */ @@ -79,7 +79,7 @@ * Handles "down" [events]{@glossary event}, including `mousedown` and `keydown`. This is * responsible for the press-and-hold key repeater. * - * @param {Event} evt The standard {@glossary event} [object]{glossary Object}. + * @param {Event} evt - The standard {@glossary event} [object]{glossary Object}. * @public */ down: function(evt) { @@ -103,7 +103,7 @@ /** * Handles `mousemove` [events]{@glossary event}. * - * @param {Event} evt The standard {@glossary event} [object]{glossary Object}. + * @param {Event} evt - The standard {@glossary event} [object]{glossary Object}. * @public */ move: function(evt) { @@ -122,7 +122,7 @@ /** * Handles "up" [events]{@glossary event}, including `mouseup` and `keyup`. * - * @param {Event} evt The standard {@glossary event} [object]{glossary Object}. + * @param {Event} evt - The standard {@glossary event} [object]{glossary Object}. * @public */ up: function(evt) { @@ -141,7 +141,7 @@ /** * Handles `mouseover` [events]{@glossary event}. * - * @param {Event} evt The standard {@glossary event} [object]{glossary Object}. + * @param {Event} evt - The standard {@glossary event} [object]{glossary Object}. * @public */ over: function(evt) { @@ -152,7 +152,7 @@ /** * Handles `mouseout` [events]{@glossary event}. * - * @param {Event} evt The standard {@glossary event} [object]{glossary Object}. + * @param {Event} evt - The standard {@glossary event} [object]{glossary Object}. * @public */ out: function(evt) { @@ -163,7 +163,7 @@ /** * Generates `tap` [events]{@glossary event}. * - * @param {Event} evt The standard {@glossary event} [object]{glossary Object}. + * @param {Event} evt - The standard {@glossary event} [object]{glossary Object}. * @public */ sendTap: function(evt) { @@ -181,8 +181,8 @@ * the hierarchic [DOM]{@glossary DOM} tree of [nodes]{@glossary Node}). The shared * ancestor node is returned. * - * @param {Node} controlA Control one. - * @param {Node} controlB Control two. + * @param {Node} controlA - Control one. + * @param {Node} controlB - Control two. * @returns {(Node|undefined)} The shared ancestor. * @public */ @@ -199,8 +199,8 @@ /** * Given two controls, returns `true` if the `child` is inside the `parent`. * - * @param {Node} child The child to search for. - * @param {Node} parent The expected parent. + * @param {Node} child - The child to search for. + * @param {Node} parent - The expected parent. * @returns {(Boolean|undefined)} `true` if the `child` is actually a child of `parent`. */ isTargetDescendantOf: function(child, parent) { diff --git a/source/dom/modal.js b/source/dom/modal.js index 0512a5b15..1b9d0197a 100644 --- a/source/dom/modal.js +++ b/source/dom/modal.js @@ -27,7 +27,7 @@ // // NOTE: This object is a plug-in; these methods should - // be called on _enyo.dispatcher_, and not on the plug-in itself. + // be called on `enyo.dispatcher`, and not on the plug-in itself. // enyo.mixin(enyo.dispatcher, { diff --git a/source/dom/transform.js b/source/dom/transform.js index 00a939fba..02b3e596f 100644 --- a/source/dom/transform.js +++ b/source/dom/transform.js @@ -136,8 +136,8 @@ * control.applyStyle('-moz-transform', 'translate(30px, 40px) scale(3) rotate(20deg) skewX(-30deg)'); * ``` * - * @param {enyo.Control} control The {@link enyo.Control} to transform. - * @param {Object} transforms The set of transforms to apply to `control`. + * @param {enyo.Control} control - The {@link enyo.Control} to transform. + * @param {Object} transforms - The set of transforms to apply to `control`. * @public */ enyo.dom.transform = function(control, transforms) { @@ -162,9 +162,9 @@ * * This will rotate the tapped control by 45 degrees clockwise. * - * @param {enyo.Control} control The {@link enyo.Control} to transform. - * @param {String} transform The name of the transform function. - * @param {(String|Number)} value The value to apply to the transform. + * @param {enyo.Control} control - The {@link enyo.Control} to transform. + * @param {String} transform - The name of the transform function. + * @param {(String|Number)} value - The value to apply to the transform. * @public */ enyo.dom.transformValue = function(control, transform, value) { @@ -179,8 +179,8 @@ * browser supports it. You may also optionally force-set `value` directly, to * be applied to `translateZ(value)`. * - * @param {enyo.Control} control The {@link enyo.Control} to accelerate. - * @param {(String|Number)} [value] An optional value to apply to the acceleration transform + * @param {enyo.Control} control - The {@link enyo.Control} to accelerate. + * @param {(String|Number)} [value] - An optional value to apply to the acceleration transform * property. * @public */ diff --git a/source/ext/hooks.js b/source/ext/hooks.js index 97bb28dac..4addb9165 100644 --- a/source/ext/hooks.js +++ b/source/ext/hooks.js @@ -14,7 +14,7 @@ * @name $L * @scope global * @type {Function} - * @param {String} str The {@glossary String} to translate. + * @param {String} str - The {@glossary String} to translate. * @returns {String} The translated {@glossary String}. * @public */ diff --git a/source/ext/macroize.js b/source/ext/macroize.js index b5f1fdec0..191a39d0c 100644 --- a/source/ext/macroize.js +++ b/source/ext/macroize.js @@ -26,10 +26,10 @@ * ``` * * @utility - * @param {String} text The template text in which to insert values via macro. - * @param {Object} map The {@glossary Object} containing the data to be inserted + * @param {String} text - The template text in which to insert values via macro. + * @param {Object} map - The {@glossary Object} containing the data to be inserted * into the `text`. - * @param {RegExp} [regex] The optional pattern to use to match the entries in + * @param {RegExp} [regex] - The optional pattern to use to match the entries in * the `text`. * @returns {String} The modified `text` value. * @public @@ -63,10 +63,10 @@ * * @utility * @see enyo.macroize - * @param {String} text The template text in which tokens will be replaced via macro. - * @param {Object} map The {@glossary Object} containing the data to be inserted into + * @param {String} text - The template text in which tokens will be replaced via macro. + * @param {Object} map - The {@glossary Object} containing the data to be inserted into * the `text`. - * @param {RegExp} [regex] The optional pattern to use to match the entries in the + * @param {RegExp} [regex] - The optional pattern to use to match the entries in the * `text`. * @returns {String} The modified `text` value. * @public @@ -87,10 +87,10 @@ * * @utility * @see enyo.macroize - * @param {String} text The template text in which tokens will be replaced via macro. - * @param {Object} map The {@glossary Object} containing the data to be inserted into + * @param {String} text - The template text in which tokens will be replaced via macro. + * @param {Object} map - The {@glossary Object} containing the data to be inserted into * the `text`. - * @param {RegExp} [regex] The optional pattern to use to match the entries in the `text`. + * @param {RegExp} [regex] - The optional pattern to use to match the entries in the `text`. * @returns {String} The modified `text` value. * @public */ diff --git a/source/kernel/Binding.js b/source/kernel/Binding.js index 6fec82a4d..313946ba5 100644 --- a/source/kernel/Binding.js +++ b/source/kernel/Binding.js @@ -37,7 +37,7 @@ if (!source) { - // the worst case scenario here is for backward compatability purposes + // the worst case scenario here is for backward compatibility purposes // we have to at least be able to derive the source via the from string if (from[0] == '^') { @@ -53,7 +53,7 @@ if (!target) { - // same worst case as above, for backwards compatability purposes + // same worst case as above, for backwards compatibility purposes // we have to at least be able to derive the target via the to string if (to[0] == '^') { @@ -98,10 +98,10 @@ * including the available parameters and how they can be used. * * @callback enyo.Binding~Transform - * @param {*} value The value being synchronized. - * @param {String} direction The direction (a string matching either "source" or "target", + * @param {*} value - The value being synchronized. + * @param {String} direction - The direction (a string matching either "source" or "target", * as in "going to the source"). - * @param {Object} binding A reference to the associated [binding]{@link enyo.Binding}. In cases + * @param {Object} binding - A reference to the associated [binding]{@link enyo.Binding}. In cases * where the binding should be interrupted and not propagate the synchronization at all, call * the `stop()` method on the passed-in binding reference. */ @@ -547,7 +547,7 @@ /** * Retrieves a [binding]{@link enyo.Binding} by its global id. * - * @param {String} euid The [Enyo global id]{@glossary EUID} by which to retrieve a + * @param {String} euid - The [Enyo global id]{@glossary EUID} by which to retrieve a * [binding]{@link enyo.Binding}. * @returns {enyo.Binding|undefined} A reference to the binding if the id * is found; otherwise, it will return [undefined]{@glossary undefined}. diff --git a/source/kernel/Component.js b/source/kernel/Component.js index 276e11b36..7e6d29dc5 100644 --- a/source/kernel/Component.js +++ b/source/kernel/Component.js @@ -10,9 +10,9 @@ /** * @callback enyo.Component~EventHandler - * @param {enyo.Component} sender The [component]{@link enyo.Component} that most recently + * @param {enyo.Component} sender - The [component]{@link enyo.Component} that most recently * propagated the {@glossary event}. - * @param {Object} event An [object]{@glossary Object} containing + * @param {Object} event - An [object]{@glossary Object} containing * event information. * @returns {Boolean} A value indicating whether the event has been * handled or not. If `true`, then bubbling is stopped. @@ -416,7 +416,7 @@ * Adds a [component]{@link enyo.Component} to the list of components * owned by the current component (i.e., [this.$]{@link enyo.Component#$}). * - * @param {enyo.Component} comp The [component]{@link enyo.Component} to add. + * @param {enyo.Component} comp - The [component]{@link enyo.Component} to add. * @returns {this} The callee for chaining. * @public */ @@ -456,7 +456,7 @@ * [$ hash]{@link enyo.Component#$}, and from the [owner]{@link enyo.Component#owner} * directly if [publish]{@link enyo.Component#publish} is set to `true`. * - * @param {enyo.Component} comp The component to remove. + * @param {enyo.Component} comp - The component to remove. * @returns {this} The callee for chaining. * @public */ @@ -528,8 +528,8 @@ * // (will be available as other.$.another). * this.createComponent({name: 'another'}, {owner: other}); * - * @param {Object} props The declarative [kind]{@glossary kind} definition. - * @param {Object} ext Additional properties to be applied (defaults). + * @param {Object} props - The declarative [kind]{@glossary kind} definition. + * @param {Object} ext - Additional properties to be applied (defaults). * @returns {enyo.Component} The instance created with the given parameters. * @public */ @@ -555,7 +555,7 @@ * ], {owner: this}); * * @param {Object[]} props The array of {@link enyo.Component} definitions to be created. - * @param {Object} ext Additional properties to be supplied as defaults for each. + * @param {Object} ext - Additional properties to be supplied as defaults for each. * @returns {enyo.Component[]} The array of [components]{@link enyo.Component} that were * created. * @public @@ -596,10 +596,10 @@ * A handler for an event may be specified. See {@link enyo.Component~EventHandler} * for complete details. * - * @param {String} nom The name of the {@glossary event} to bubble. - * @param {Object} [event] The event [object]{@glossary Object} to be passed along + * @param {String} nom - The name of the {@glossary event} to bubble. + * @param {Object} [event] - The event [object]{@glossary Object} to be passed along * while bubbling. - * @param {enyo.Component} [sender=this] The {@link enyo.Component} responsible for + * @param {enyo.Component} [sender=this] - The {@link enyo.Component} responsible for * bubbling the event. * @returns {Boolean} `false` if unhandled or uninterrupted; otherwise, `true`. * @public @@ -623,8 +623,8 @@ * A handler for an event may be specified. See {@link enyo.Component~EventHandler} * for complete details. * - * @param {String} nom The name of the {@glossary event}. - * @param {Object} [event] The event properties to pass along while bubbling. + * @param {String} nom - The name of the {@glossary event}. + * @param {Object} [event] - The event properties to pass along while bubbling. * @returns {Boolean} `false` if unhandled or uninterrupted; otherwise, `true`. * @public */ @@ -761,9 +761,9 @@ * If you need to handle these types of events differently, you may also need to * override [dispatchEvent()]{@link enyo.Component#dispatchEvent}. * - * @param {String} nom The method name to dispatch the {@glossary event}. - * @param {Object} [event] The event [object]{@glossary Object} to pass along. - * @param {enyo.Component} [sender=this] The originator of the event. + * @param {String} nom - The method name to dispatch the {@glossary event}. + * @param {Object} [event] - The event [object]{@glossary Object} to pass along. + * @param {enyo.Component} [sender=this] - The originator of the event. * @public */ dispatch: function (nom, event, sender) { @@ -786,9 +786,9 @@ * @example * myControl.triggerHandler('ontap'); * - * @param {String} nom The name of the {@glossary event} to trigger. - * @param {Object} [event] The event object to pass along. - * @param {enyo.Component} [sender=this] The originator of the event. + * @param {String} nom - The name of the {@glossary event} to trigger. + * @param {Object} [event] - The event object to pass along. + * @param {enyo.Component} [sender=this] - The originator of the event. * @returns {Boolean} `false` if unhandled or uninterrupted, `true` otherwise. * @public */ @@ -802,9 +802,9 @@ * by returning a truthy value from the {@glossary event} * [handler]{@link enyo.Component~EventHandler}. * - * @param {String} nom The name of the {@glossary event} to waterfall. - * @param {Object} [event] The event [object]{@glossary Object} to pass along. - * @param {enyo.Component} [sender=this] The originator of the event. + * @param {String} nom - The name of the {@glossary event} to waterfall. + * @param {Object} [event] - The event [object]{@glossary Object} to pass along. + * @param {enyo.Component} [sender=this] - The originator of the event. * @returns {this} The callee for chaining. * @public */ @@ -829,9 +829,9 @@ * owned by a receiving [object]{@glossary Object} by returning a truthy value from the * {@glossary event} [handler]{@link enyo.Component~EventHandler}. * - * @param {String} nom The name of the {@glossary event}. - * @param {Object} [event] The event [object]{@glossary Object} to pass along. - * @param {enyo.Component} [sender=this] The event originator. + * @param {String} nom - The name of the {@glossary event}. + * @param {Object} [event] - The event [object]{@glossary Object} to pass along. + * @param {enyo.Component} [sender=this] - The event originator. * @returns {this} The callee for chaining. * @public */ @@ -916,10 +916,10 @@ * the string `"low"`) will defer the job if an animation is in progress, * which can help to avoid stuttering. * - * @param {String} nom The name of the [job]{@link enyo.job} to start. - * @param {(Function|String)} job Either the name of a method or a + * @param {String} nom - The name of the [job]{@link enyo.job} to start. + * @param {(Function|String)} job - Either the name of a method or a * [function]{@glossary Function} to execute as the requested job. - * @param {Number} wait The number of milliseconds to wait before starting + * @param {Number} wait - The number of milliseconds to wait before starting * the job. * @param {Number} [priority=5] The priority value to be associated with this * job. @@ -944,7 +944,7 @@ * Stops a [component]{@link enyo.Component}-specific [job]{@link enyo.job} before it has * been activated. * - * @param {String} nom The name of the [job]{@link enyo.job} to be stopped. + * @param {String} nom - The name of the [job]{@link enyo.job} to be stopped. * @returns {this} The callee for chaining. * @public */ @@ -962,10 +962,10 @@ * any other calls to `throttleJob()` with the same job name from running for * the specified amount of time. * - * @param {String} nom The name of the [job]{@link enyo.job} to throttle. - * @param {(Function|String)} job Either the name of a method or a + * @param {String} nom - The name of the [job]{@link enyo.job} to throttle. + * @param {(Function|String)} job - Either the name of a method or a * [function]{@glossary Function} to execute as the requested job. - * @param {Number} wait The number of milliseconds to wait before executing the + * @param {Number} wait - The number of milliseconds to wait before executing the * job again. * @returns {this} The callee for chaining. * @public @@ -997,7 +997,7 @@ * attribute. * * @name enyo.create - * @param {Object} props The properties that define the [kind]{@glossary kind}. + * @param {Object} props - The properties that define the [kind]{@glossary kind}. * @returns {*} An instance of the requested [kind]{@glossary kind}. * @public */ diff --git a/source/kernel/Object.js b/source/kernel/Object.js index 332cacf00..1f97cb44e 100644 --- a/source/kernel/Object.js +++ b/source/kernel/Object.js @@ -84,7 +84,7 @@ * Imports the values from the given [object]{@glossary Object}. Automatically called * from the [constructor]{@link enyo.Object#constructor}. * - * @param {Object} props If provided, the [object]{@glossary Object} from which to + * @param {Object} props - If provided, the [object]{@glossary Object} from which to * retrieve [keys/values]{@glossary Object.keys} to mix in. * @returns {this} The callee for chaining. * @public @@ -116,7 +116,7 @@ * Calls the [destroy()]{@link enyo.Object#destroy} method for the named {@link enyo.Object} * property. * - * @param {String} name The name of the property to destroy, if possible. + * @param {String} name - The name of the property to destroy, if possible. * @returns {this} The callee for chaining. * @public */ @@ -183,7 +183,7 @@ * should use [computed properties]{@link enyo.ComputedSupport} instead of relying on the * getter naming convention.) * - * @param {String} path The path from which to retrieve a value. + * @param {String} path - The path from which to retrieve a value. * @returns {*} The value for the given path or [undefined]{@glossary undefined} if * the path could not be completely resolved. * @public @@ -195,9 +195,9 @@ * resolvable relative to the given {@link enyo.Object}. See {@link enyo.setPath} for * complete details. * - * @param {String} path The path for which to set the given value. - * @param {*} value The value to set. - * @param {Object} [opts] An options hash. + * @param {String} path - The path for which to set the given value. + * @param {*} value - The value to set. + * @param {Object} [opts] - An options hash. * @returns {this} The callee for chaining. * @public */ diff --git a/source/kernel/Oop.js b/source/kernel/Oop.js index d05ffbded..33938910b 100644 --- a/source/kernel/Oop.js +++ b/source/kernel/Oop.js @@ -23,7 +23,7 @@ * in the Enyo Developer Guide. * * @namespace enyo.kind - * @param {Object} props A [hash]{@glossary Object} of properties used to define and create + * @param {Object} props - A [hash]{@glossary Object} of properties used to define and create * the [kind]{@glossary kind} * @public */ @@ -335,10 +335,10 @@ * The older `this.inherited(arguments)` method still works, but this version results in much * faster code and is the only one supported for kind [mixins]{@glossary mixin}. * - * @param {Function} fn A [function]{@glossary Function} that takes a single - * argument (usually named `sup`) and returns a function where - * `sup.apply(this, arguments)` is used as a mechanism to make the - * super-call. + * @param {Function} fn - A [function]{@glossary Function} that takes a single + * argument (usually named `sup`) and returns a function where + * `sup.apply(this, arguments)` is used as a mechanism to make the + * super-call. * @public */ enyo.inherit = function (fn) { @@ -394,9 +394,9 @@ * it is subclassed, the constructor and properties will be passed through * this method for special handling of important features. * - * @param {Function} ctor The [constructor]{@glossary constructor} of the + * @param {Function} ctor - The [constructor]{@glossary constructor} of the * [kind]{@glossary kind} being subclassed. - * @param {Object} props The properties of the kind being subclassed. + * @param {Object} props - The properties of the kind being subclassed. * @memberof enyo.kind * @public */ @@ -418,7 +418,7 @@ * `this.inherited()` or be wrapped with `enyo.inherit()` to call * the original method (this chains multiple methods tied to a * single [kind]{@glossary kind}). - * @param {Object} [target] The instance to be extended. If this is not specified, then the + * @param {Object} [target] - The instance to be extended. If this is not specified, then the * [constructor]{@glossary constructor} of the * [object]{@glossary Object} this method is being called on will * be extended. diff --git a/source/kernel/Router.js b/source/kernel/Router.js index 2b727de65..aa5537e59 100644 --- a/source/kernel/Router.js +++ b/source/kernel/Router.js @@ -144,6 +144,7 @@ * matched. * * @type {Object} + * @default null * @public */ defaultRoute: null, @@ -312,7 +313,7 @@ * `path` being a string that will be evaluated against the routes owned by * this router. * - * @param {String} path A path to test against this router's + * @param {String} path - A path to test against this router's * [routes]{@linkcode enyo.Router#routes}. * @public */ @@ -356,8 +357,8 @@ * the lowest position (the same as if boolean `true` is passed as the second * parameter). Returns callee for chaining. * - * @param {String} location The location string to add to the history. - * @param {(Number|Boolean)} [idx] Position in the history stack where the + * @param {String} location - The location string to add to the history. + * @param {(Number|Boolean)} [idx] - Position in the history stack where the * new location should be added. Pass `true` for the first/oldest position, * or a number indicating the index where the location should be added. If no * value (or `undefined`) is specified, the location will be added at the @@ -400,7 +401,7 @@ * to the router. `route` is a hash as described by the * [routes]{@link enyo.Router#routes} array. Returns callee for chaining. * - * @param {Object} route The route to add. + * @param {Object} route - The route to add. * @returns {this} The callee for chaining. * @public */ diff --git a/source/kernel/Signals.js b/source/kernel/Signals.js index 8d89dac8f..3c7ff940c 100644 --- a/source/kernel/Signals.js +++ b/source/kernel/Signals.js @@ -90,9 +90,9 @@ /** * Broadcasts a global message to be consumed by subscribers. * - * @param {String} msg The message to send; usually the name of the + * @param {String} msg - The message to send; usually the name of the * {@glossary event}. - * @param {Object} load An [object]{@glossary Object} containing any + * @param {Object} load - An [object]{@glossary Object} containing any * associated event properties to be accessed by subscribers. * @public */ diff --git a/source/kernel/UiComponent.js b/source/kernel/UiComponent.js index 8dc79d5da..b2bab03f9 100644 --- a/source/kernel/UiComponent.js +++ b/source/kernel/UiComponent.js @@ -149,13 +149,14 @@ * additional property hashes are combined as described in * {@link enyo.Component#createComponent}. * - * @example + * ``` * // ask foo to create components 'bar' and 'zot', but set the owner of * // both components to 'this'. * this.$.foo.createComponents([ * {name: 'bar'}, * {name: 'zot'} * ], {owner: this}); + * ``` * * As implemented, [controlParentName]{@link enyo.UiComponent#controlParentName} only works * to identify an owned control created via `createComponents()` @@ -168,7 +169,7 @@ * cause a lot of useless checking. * * @param {Object[]} props The array of {@link enyo.Component} definitions to be created. - * @param {Object} ext Additional properties to be supplied as defaults for each. + * @param {Object} ext - Additional properties to be supplied as defaults for each. * @returns {enyo.Component[]} The array of components that were created. * @method * @public @@ -236,7 +237,7 @@ * * Note: Oddly, a control is considered to be a descendant of itself. * - * @param {enyo.Control} ancestor The [control]{@link enyo.Control} whose lineage + * @param {enyo.Control} ancestor - The [control]{@link enyo.Control} whose lineage * will be checked to determine whether the current control is a descendant. * @public */ @@ -462,9 +463,9 @@ * owned by a receiving [object]{@glossary Object} by returning a truthy value from the * {@glossary event} [handler]{@link enyo.Component~EventHandler}. * - * @param {String} nom The name of the {@glossary event}. - * @param {Object} [event] The event object to pass along. - * @param {enyo.Component} [sender=this] The event's originator. + * @param {String} nom - The name of the {@glossary event}. + * @param {Object} [event] - The event object to pass along. + * @param {enyo.Component} [sender=this] - The event's originator. * @returns {this} The callee for chaining. * @public */ diff --git a/source/kernel/ViewController.js b/source/kernel/ViewController.js index b52aa54e8..4e2ecc182 100644 --- a/source/kernel/ViewController.js +++ b/source/kernel/ViewController.js @@ -101,7 +101,7 @@ * controller's [renderTarget]{@link enyo.ViewController#renderTarget}. If * the view is already rendered, this method will do nothing. * - * @param {String} [target] When specified, this value will be used instead of + * @param {String} [target] - When specified, this value will be used instead of * [renderTarget]{@link enyo.ViewController#renderTarget}. * @public */ @@ -124,7 +124,7 @@ * [renderTarget]{@link enyo.ViewController#renderTarget} property to * `target`. * - * @param {String} target Where the view will be rendered into. + * @param {String} target - Where the view will be rendered into. * @public */ renderInto: function (target) { diff --git a/source/kernel/dev.js b/source/kernel/dev.js index 6209e92b9..a86f4bad0 100644 --- a/source/kernel/dev.js +++ b/source/kernel/dev.js @@ -103,7 +103,7 @@ * Creates a new [benchmark]{@link enyo.dev.Benchmark} test with the given * configuration options. * - * @param {enyo.dev.Benchmark~Options} opts The configuration + * @param {enyo.dev.Benchmark~Options} opts - The configuration * [options]{@link enyo.dev.Benchmark~Options} to apply to the * [benchmark]{@link enyo.dev.Benchmark}. * @returns {enyo.dev.Benchmark} A Benchmark instance with `start()` and @@ -121,7 +121,7 @@ /** * Shows a report for a given [benchmark]{@link enyo.dev.Benchmark} by name. * - * @param {String} name The name of the [benchmark]{@link enyo.dev.Benchmark} to report. + * @param {String} name - The name of the [benchmark]{@link enyo.dev.Benchmark} to report. * @public */ report: function (name) { @@ -151,7 +151,7 @@ /** * Removes all stored data related to the named [benchmark]{@link enyo.dev.Benchmark}. * - * @param {String} name The name of the [benchmark]{@link enyo.dev.Benchmark} from which to + * @param {String} name - The name of the [benchmark]{@link enyo.dev.Benchmark} from which to * remove stored data. * @public */ diff --git a/source/kernel/job.js b/source/kernel/job.js index 3968f394a..c2ea33a0d 100644 --- a/source/kernel/job.js +++ b/source/kernel/job.js @@ -14,10 +14,10 @@ * enyo.job("updateThumb", this.bindSafely("updateThumb"), 1000); * } * - * @param {String} nom The name of the [job]{@link enyo.job} to throttle. - * @param {(Function|String)} job Either the name of a method or a [function]{@glossary Function} + * @param {String} nom - The name of the [job]{@link enyo.job} to throttle. + * @param {(Function|String)} job - Either the name of a method or a [function]{@glossary Function} * to execute as the requested job. - * @param {Number} wait The number of milliseconds to wait before executing the job again. + * @param {Number} wait - The number of milliseconds to wait before executing the job again. * @static * @public */ @@ -32,7 +32,7 @@ /** * Cancels the named [job]{@link enyo.job}, if it has not already fired. * - * @param {String} nom The name of the [job]{@link enyo.job} to cancel. + * @param {String} nom - The name of the [job]{@link enyo.job} to cancel. * @static * @public */ @@ -52,10 +52,10 @@ * immediate response, but later invocations might just be noise if they arrive * too often. * - * @param {String} nom The name of the [job]{@link enyo.job} to throttle. - * @param {(Function|String)} job Either the name of a method or a [function]{@glossary Function} + * @param {String} nom - The name of the [job]{@link enyo.job} to throttle. + * @param {(Function|String)} job - Either the name of a method or a [function]{@glossary Function} * to execute as the requested job. - * @param {Number} wait The number of milliseconds to wait before executing the + * @param {Number} wait - The number of milliseconds to wait before executing the * job again. * @static * @public diff --git a/source/kernel/jobs.js b/source/kernel/jobs.js index 13c6a098b..fbe81baab 100644 --- a/source/kernel/jobs.js +++ b/source/kernel/jobs.js @@ -72,10 +72,10 @@ * level is higher than this job's priority, this job gets deferred until the * job level drops; if it is lower, this job is run immediately. * - * @param {Function} job The actual {@glossary Function} to execute as the + * @param {Function} job - The actual {@glossary Function} to execute as the * [job]{@link enyo.job}. - * @param {Number} priority The priority of the job. - * @param {String} nom The name of the job for later reference. + * @param {Number} priority - The priority of the job. + * @param {String} nom - The name of the job for later reference. * @public */ add: function (job, priority, nom) { @@ -102,7 +102,7 @@ /** * Will remove the named [job]{@link enyo.job} from the queue. * - * @param {String} nom The name of the [job]{@link enyo.job} to remove. + * @param {String} nom - The name of the [job]{@link enyo.job} to remove. * @returns {Array} An {@glossary Array} that will contain the removed job if * it was found, or empty if it was not found. * @public @@ -123,8 +123,8 @@ * highest current priority, the priority level rises. Newly added jobs below that priority * level are deferred until the priority is removed (i.e., unregistered). * - * @param {Number} priority The priority value to register. - * @param {String} id The name of the priority. + * @param {Number} priority - The priority value to register. + * @param {String} id - The name of the priority. * @public */ registerPriority: function(priority, id) { @@ -137,7 +137,7 @@ * highest priority, the priority level drops to the next highest priority * and queued jobs with a higher priority are executed. * - * @param {String} id The name of the priority level to remove. + * @param {String} id - The name of the priority level to remove. * @public */ unregisterPriority: function (id) { diff --git a/source/kernel/lang.js b/source/kernel/lang.js index 147e50d34..0ea724ede 100644 --- a/source/kernel/lang.js +++ b/source/kernel/lang.js @@ -94,7 +94,7 @@ /** * Determines whether a variable is defined. * - * @param {*} target Anything that can be compared to `undefined`. + * @param {*} target - Anything that can be compared to `undefined`. * @returns {Boolean} `true` if defined, `false` otherwise. * @public */ @@ -107,7 +107,7 @@ /** * Creates a unique identifier (with an optional prefix) and returns the identifier as a string. * - * @param {String} [prefix] The prefix to prepend to the generated unique id. + * @param {String} [prefix] - The prefix to prepend to the generated unique id. * @returns {String} An optionally-prefixed identifier. * @public */ @@ -137,7 +137,7 @@ /** * Generates a random number using [Math.random]{@glossary Math.random}. * - * @param {Number} bound The multiplier used to generate the product. + * @param {Number} bound - The multiplier used to generate the product. * @returns {Number} A random number. * @public */ @@ -150,7 +150,7 @@ /** * Determines whether a given variable is a [String]{@glossary String}. * - * @param {*} it The variable to be tested. + * @param {*} it - The variable to be tested. * @returns {Boolean} `true` if variable is a [String]{@glossary String}; * otherwise, `false`. * @public @@ -162,7 +162,7 @@ /** * Determines whether a given variable is a [Function]{@glossary Function}. * - * @param {*} it The variable to be tested. + * @param {*} it - The variable to be tested. * @returns {Boolean} `true` if variable is a [Function]{@glossary Function}; * otherwise, `false`. * @public @@ -174,7 +174,7 @@ /** * Determines whether a given variable is an [Array]{@glossary Array}. * - * @param {*} it The variable to be tested. + * @param {*} it - The variable to be tested. * @returns {Boolean} `true` if variable is an [Array]{@glossary Array}; * otherwise, `false`. * @method @@ -187,7 +187,7 @@ /** * Determines whether a given variable is an [Object]{@glossary Object}. * - * @param {*} it The variable to be tested. + * @param {*} it - The variable to be tested. * @returns {Boolean} `true` if variable is an [Object]{@glossary Object}; * otherwise, `false`. * @method @@ -201,7 +201,7 @@ /** * Determines whether a given variable is an explicit boolean `true`. * - * @param {*} it The variable to be tested. + * @param {*} it - The variable to be tested. * @returns {Boolean} `true` if variable is an explicit `true`; otherwise, * `false`. * @public @@ -214,8 +214,8 @@ * Binds the `this` context of any method to a scope and a variable number of provided initial * parameters. * - * @param {Object} scope The `this` context for the method. - * @param {(Function|String)} method A Function or the name of a method to bind. + * @param {Object} scope - The `this` context for the method. + * @param {(Function|String)} method - A Function or the name of a method to bind. * @param {...*} [args] Any arguments that will be provided as the initial arguments to the * enclosed method. * @returns {Function} The bound method/closure. @@ -256,8 +256,8 @@ * {@link enyo.Object.bindSafely} and {@link enyo.Object}-like objects like * {@link enyo.Model} and {@link enyo.Collection}. * - * @param {Object} scope The `this` context for the method. - * @param {(Function|String)} method A Function or the name of a method to bind. + * @param {Object} scope - The `this` context for the method. + * @param {(Function|String)} method - A Function or the name of a method to bind. * @param {...*} [args] Any arguments that will be provided as the initial arguments to the * enclosed method. * @returns {Function} The bound method/closure. @@ -296,8 +296,8 @@ * If only a single argument is supplied, will just call that function asynchronously without * doing any additional binding. * - * @param {Object} scope The `this` context for the method. - * @param {(Function|String)} method A Function or the name of a method to bind. + * @param {Object} scope - The `this` context for the method. + * @param {(Function|String)} method - A Function or the name of a method to bind. * @param {...*} [args] Any arguments that will be provided as the initial arguments to the * enclosed method. * @returns {Number} The `setTimeout` id. @@ -319,9 +319,9 @@ * @example * enyo.call(myWorkObject, 'doWork', [3, 'foo']); * - * @param {Object} scope The `this` context for the method. - * @param {(Function|String)} method A Function or the name of a method to bind. - * @param {Array} [args] An array of arguments to pass to the method. + * @param {Object} scope - The `this` context for the method. + * @param {(Function|String)} method - A Function or the name of a method to bind. + * @param {Array} [args] - An array of arguments to pass to the method. * @returns {*} The return value of the method. * @public */ @@ -380,7 +380,7 @@ * computed properties. Returns `undefined` if the object at the given path cannot be found. May * safely be called on non-existent paths. * - * @param {String} path The path from which to retrieve a value. + * @param {String} path - The path from which to retrieve a value. * @returns {*} The value for the given path, or `undefined` if the path could not be * completely resolved. * @method enyo.getPath @@ -450,9 +450,9 @@ * triggered by default. If the third parameter is present and is an explicit boolean true, the * observers will be triggered regardless. Returns the context from which the method was executed. * - * @param {String} path The path for which to set the given value. - * @param {*} is The value to set. - * @param {Object} [opts] An options hash. + * @param {String} path - The path for which to set the given value. + * @param {*} is - The value to set. + * @param {Object} [opts] - An options hash. * @returns {this} Whatever the given context was when executed. * @method enyo.setPath * @public @@ -565,7 +565,7 @@ * Uppercases a given string. Will coerce to a [String]{@glossary String} * if possible/necessary. * - * @param {String} str The string to uppercase. + * @param {String} str - The string to uppercase. * @returns {String} The uppercased string. * @public */ @@ -580,7 +580,7 @@ * Lowercases a given string. Will coerce to a [String]{@glossary String} * if possible/necessary. * - * @param {String} str The string to lowercase. + * @param {String} str - The string to lowercase. * @returns {String} The lowercased string. * @public */ @@ -594,7 +594,7 @@ /** * Capitalizes a given string. * - * @param {String} str The string to capitalize. + * @param {String} str - The string to capitalize. * @returns {String} The capitalized string. * @public */ @@ -605,7 +605,7 @@ /** * Un-capitalizes a given string. * - * @param {String} str The string to un-capitalize. + * @param {String} str - The string to un-capitalize. * @returns {String} The un-capitalized string. * @public */ @@ -617,7 +617,7 @@ * Injects an arbitrary number of values, in order, into a template string at * positions marked by `"%."`. * - * @param {String} template The string template to inject with values. + * @param {String} template - The string template to inject with values. * @param {...String} val The values to inject into the template. * @returns {String} A copy of the template populated with values. * @public @@ -647,7 +647,7 @@ * Takes a string and trims leading and trailing spaces. Strings with no length, * non-strings, and falsy values will be returned without modification. * - * @param {String} str The string from which to remove whitespace. + * @param {String} str - The string from which to remove whitespace. * @returns {String} The trimmed string. * @public */ @@ -722,7 +722,7 @@ * base object. If the third parameter is `true`, falsy values will be ignored. * * @param {String[]} properties The properties to include on the returned object. - * @param {Object} object The object from which to retrieve values for the requested properties. + * @param {Object} object - The object from which to retrieve values for the requested properties. * @param {Boolean} [ignore=false] Whether or not to ignore copying falsy values. * @returns {Object} A new object populated with the requested properties and values from * the given object. @@ -754,8 +754,8 @@ * designating whether to pass unknown key/value pairs through to the new object. * If `true`, those keys will exist on the returned object. * - * @param {Object} map The object with key/value pairs. - * @param {Object} obj The object whose values will be used. + * @param {Object} map - The object with key/value pairs. + * @param {Object} obj - The object whose values will be used. * @param {Boolean} [pass=false] Whether or not to pass unnamed properties through * from the given object. * @returns {Object} A new object whose properties have been mapped. @@ -779,9 +779,9 @@ * reference, and an immutable copy of the original array of objects for * comparison. * - * @param {String} property The property to index the array by. - * @param {Array} array An array of property objects. - * @param {Function} [filter] The filter function to use; accepts four arguments. + * @param {String} property - The property to index the array by. + * @param {Array} array - An array of property objects. + * @param {Function} [filter] - The filter function to use; accepts four arguments. * @returns {Object} A hash (object) indexed by the `property` argument * @public */ @@ -831,9 +831,9 @@ * required. In this case, the optional second parameter may be used to allow a more efficient * [copy]{@link Object.create} to be made. * - * @param {(Object|Array)} base The [Object]{@glossary Object} or + * @param {(Object|Array)} base - The [Object]{@glossary Object} or * [Array]{@glossary Array} to be cloned. - * @param {Boolean} [quick] If `true`, when cloning objects, a faster [copy]{@link Object.create} + * @param {Boolean} [quick] - If `true`, when cloning objects, a faster [copy]{@link Object.create} * method will be used. This parameter has no meaning when cloning arrays. * @returns {*} A clone of the provided `base` if `base` is of the correct type; otherwise, * returns `base` as it was passed in. @@ -933,7 +933,7 @@ * Returns an [array]{@glossary Array} of the values of all properties in an * [object]{@glossary Object}. * - * @param {Object} obj The [Object]{@glossary Object} to read the values from. + * @param {Object} obj - The [Object]{@glossary Object} to read the values from. * @returns {Array} An [array]{@glossary Array} with the values from the `obj`. * @public */ @@ -1178,9 +1178,9 @@ * an `undefined` placeholder element is added to the result array, such that the * returned result array has the same length as the passed-in `array` parameter. * - * @param {Array} array The [array]{@glossary Array} of [objects]{@glossary Object} + * @param {Array} array - The [array]{@glossary Array} of [objects]{@glossary Object} * in which the `prop` will be searched for. - * @param {String} prop A string containing the name of the property to search for. + * @param {String} prop - A string containing the name of the property to search for. * @returns {Array} An array of all the values of the named property from * objects contained in the `array`. * @public @@ -1256,8 +1256,8 @@ * [strictly equal to]{@glossary ===} occurrence of `el`. * Note that `array` is modified directly. * - * @param {Array} array The [Array]{@glossary Array} to look through. - * @param {*} el The element to search for and remove. + * @param {Array} array - The [Array]{@glossary Array} to look through. + * @param {*} el - The element to search for and remove. * @public */ enyo.remove = function (array, el) { @@ -1285,7 +1285,7 @@ /** * Takes content `str` and determines whether or not it is [RTL]{@glossary RTL}. * - * @param {String} str A [String]{@glossary String} to check the [RTL]{@glossary RTL}-ness of. + * @param {String} str - A [String]{@glossary String} to check the [RTL]{@glossary RTL}-ness of. * @return {Boolean} `true` if `str` should be RTL; `false` if not. * @public */ diff --git a/source/kernel/log.js b/source/kernel/log.js index 8f10af864..4d999b0e6 100644 --- a/source/kernel/log.js +++ b/source/kernel/log.js @@ -107,7 +107,7 @@ * @see enyo.log * @see enyo.warn * @see enyo.error - * @param {Number} level The level to set logging to. + * @param {Number} level - The level to set logging to. */ enyo.setLogLevel = function (level) { var ll = parseInt(level, 0); diff --git a/source/kernel/mixins/BindingSupport.js b/source/kernel/mixins/BindingSupport.js index f4b587b7d..286c03ceb 100644 --- a/source/kernel/mixins/BindingSupport.js +++ b/source/kernel/mixins/BindingSupport.js @@ -66,7 +66,7 @@ * Removes and [destroys]{@link enyo.Binding#destroy} all of, or a subset of, * the [bindings]{@link enyo.Binding} belonging to the callee. * - * @param {enyo.Binding[]} [subset] The optional [array]{@glossary Array} of + * @param {enyo.Binding[]} [subset] - The optional [array]{@glossary Array} of * [bindings]{@link enyo.Binding} to remove. * @returns {this} The callee for chaining. * @public @@ -88,7 +88,7 @@ * It should be noted that when a binding is destroyed, it is automatically * removed from its owner. * - * @param {enyo.Binding} binding The {@link enyo.Binding} instance to remove. + * @param {enyo.Binding} binding - The {@link enyo.Binding} instance to remove. * @returns {this} The callee for chaining. * @public */ diff --git a/source/kernel/mixins/ComputedSupport.js b/source/kernel/mixins/ComputedSupport.js index 7c27ab3da..dfdac479d 100644 --- a/source/kernel/mixins/ComputedSupport.js +++ b/source/kernel/mixins/ComputedSupport.js @@ -79,7 +79,7 @@ * Primarily intended for internal use, this method determines whether the * given path is a known [computed property]{@glossary "computed property"}. * - * @param {String} path The property or path to test. + * @param {String} path - The property or path to test. * @returns {Boolean} Whether or not the `path` is a * [computed property]{@glossary "computed property"}. * @public @@ -94,7 +94,7 @@ * given path is a known dependency of a * [computed property]{@glossary "computed property"}. * - * @param {String} path The property or path to test. + * @param {String} path - The property or path to test. * @returns {Boolean} Whether or not the `path` is a dependency of a * [computed property]{@glossary "computed property"}. * @public diff --git a/source/kernel/mixins/EventEmitter.js b/source/kernel/mixins/EventEmitter.js index 5f351fb35..4ffaf9f58 100644 --- a/source/kernel/mixins/EventEmitter.js +++ b/source/kernel/mixins/EventEmitter.js @@ -149,9 +149,9 @@ * this listener will fire every time the event is * [emitted]{@link enyo.EventEmitter#emit}. * - * @param {String} e The {@glossary event} name to register for. - * @param {Function} fn The listener. - * @param {Object} [ctx] The optional context under which to execute the listener. + * @param {String} e - The {@glossary event} name to register for. + * @param {Function} fn - The listener. + * @param {Object} [ctx] - The optional context under which to execute the listener. * @returns {this} The callee for chaining. * @public */ @@ -171,9 +171,9 @@ /** * Removes an {@glossary event} listener. * - * @param {String} e The {@glossary event} name. - * @param {Function} fn The listener to unregister. - * @param {Object} [ctx] If the listener was registered with a context, it + * @param {String} e - The {@glossary event} name. + * @param {Function} fn - The listener to unregister. + * @param {Object} [ctx] - If the listener was registered with a context, it * should be provided when unregistering as well. * @returns {this} The callee for chaining. * @public @@ -185,7 +185,7 @@ /** * Removes all listeners, or all listeners for a given {@glossary event}. * - * @param {String} [e] The optional target {@glossary event}. + * @param {String} [e] - The optional target {@glossary event}. * @returns {this} The callee for chaining. */ removeAllListeners: function (e) { @@ -209,7 +209,7 @@ * Primarily intended for internal use, this method returns an immutable copy * of all listeners, or all listeners for a particular {@glossary event} (if any). * - * @param {String} [e] The targeted {@glossary event}. + * @param {String} [e] - The targeted {@glossary event}. * @returns {Object[]} Event listeners are stored in [hashes]{@glossary Object}. * The return value will be an [array]{@glossary Array} of these hashes * if any listeners exist. @@ -237,7 +237,7 @@ * Emits the named {@glossary event}. All subsequent arguments will be passed * to the event listeners. * - * @param {String} e The {@glossary event} to emit. + * @param {String} e - The {@glossary event} to emit. * @param {...*} args All subsequent arguments will be passed to the event listeners. * @returns {Boolean} Whether or not any listeners were notified. * @public diff --git a/source/kernel/mixins/MixinSupport.js b/source/kernel/mixins/MixinSupport.js index d73ff8dc8..19707871a 100644 --- a/source/kernel/mixins/MixinSupport.js +++ b/source/kernel/mixins/MixinSupport.js @@ -96,7 +96,7 @@ /** * Extends the instance with the given properties. * - * @param {Object} props The property [hash]{@glossary Object} from which to extend + * @param {Object} props - The property [hash]{@glossary Object} from which to extend * the callee. */ extend: function (props) { diff --git a/source/kernel/mixins/MultipleDispatchSupport.js b/source/kernel/mixins/MultipleDispatchSupport.js index 3c837b15f..4e6f97069 100644 --- a/source/kernel/mixins/MultipleDispatchSupport.js +++ b/source/kernel/mixins/MultipleDispatchSupport.js @@ -21,7 +21,7 @@ /** * Adds a target for dispatching. * - * @param {enyo.Component} component The {@link enyo.Component} to add as a dispatch target. + * @param {enyo.Component} component - The {@link enyo.Component} to add as a dispatch target. * @public */ addDispatchTarget: function (component) { @@ -33,7 +33,7 @@ /** * Removes a target from dispatching. * - * @param {enyo.Component} component The {@link enyo.Component} to remove as a dispatch + * @param {enyo.Component} component - The {@link enyo.Component} to remove as a dispatch * target. * @public */ diff --git a/source/kernel/mixins/ObserverSupport.js b/source/kernel/mixins/ObserverSupport.js index 573f42c6c..724ecd149 100644 --- a/source/kernel/mixins/ObserverSupport.js +++ b/source/kernel/mixins/ObserverSupport.js @@ -18,9 +18,9 @@ * @see enyo.ObserverSupport * @see enyo.ObserverSupport.observe * @callback enyo.ObserverSupport~Observer - * @param {*} was The previous value of the property that has changed. - * @param {*} is The current value of the property that has changed. - * @param {String} prop The name of the property that has changed. + * @param {*} was - The previous value of the property that has changed. + * @param {*} is - The current value of the property that has changed. + * @param {String} prop - The name of the property that has changed. * @public */ @@ -259,7 +259,7 @@ * Returns an immutable list of [observers]{@link enyo.ObserverSupport~Observer} * for the given `path`, or all observers for the callee. * - * @param {String} [path] Path or property path for which + * @param {String} [path] - Path or property path for which * [observers]{@link enyo.ObserverSupport~Observer} will be returned. If not * specified, all observers for the callee will be returned. * @@ -314,10 +314,10 @@ * registering, it should also be used when unregistering.** * * @see enyo.ObserverSupport.unobserve - * @param {String} path The property or property path to observe. - * @param {enyo.ObserverSupport~Observer} fn The + * @param {String} path - The property or property path to observe. + * @param {enyo.ObserverSupport~Observer} fn - The * [observer]{@link enyo.ObserverSupport~Observer} method that responds to changes. - * @param {*} [ctx] The `this` (context) under which to execute the observer. + * @param {*} [ctx] - The `this` (context) under which to execute the observer. * * @returns {this} The callee for chaining. * @public @@ -342,10 +342,10 @@ * then it should also be supplied to this method. * * @see enyo.ObserverSupport.observe - * @param {String} path The property or property path to unobserve. - * @param {enyo.ObserverSupport~Observer} fn The + * @param {String} path - The property or property path to unobserve. + * @param {enyo.ObserverSupport~Observer} fn - The * [observer]{@link enyo.ObserverSupport~Observer} method that responds to changes. - * @param {*} [ctx] The `this` (context) under which to execute the observer. + * @param {*} [ctx] - The `this` (context) under which to execute the observer. * * @returns {this} The callee for chaining. * @public @@ -359,7 +359,7 @@ * callee. If a `path` parameter is provided, observers will only be removed * from that path (or property). * - * @param {String} [path] A property or property path from which to remove all + * @param {String} [path] - A property or property path from which to remove all * [observers]{@link enyo.ObserverSupport~Observer}. * @returns {this} The callee for chaining. */ @@ -394,9 +394,9 @@ * forcibly by [setting]{@link enyo.Object#set} a value with the * `force` option. * - * @param {String} path The property or property path to notify. - * @param {*} was The previous value. - * @param {*} is The current value. + * @param {String} path - The property or property path to notify. + * @param {*} was - The previous value. + * @param {*} is - The current value. * @returns {this} The callee for chaining. */ notify: function (path, was, is, opts) { @@ -417,7 +417,7 @@ * @see enyo.ObserverSupport.startNotifications * @see enyo.ObserverSupport.disableNotificationQueue * @see enyo.ObserverSupport.enableNotificationQueue - * @param {Boolean} [noQueue] If `true`, this will also disable the notification queue. + * @param {Boolean} [noQueue] - If `true`, this will also disable the notification queue. * @returns {this} The callee for chaining. */ stopNotifications: function (noQueue) { @@ -439,7 +439,7 @@ * @see enyo.ObserverSupport.stopNotifications * @see enyo.ObserverSupport.disableNotificationQueue * @see enyo.ObserverSupport.enableNotificationQueue - * @param {Boolean} [queue] If `true` and the notification queue is disabled, + * @param {Boolean} [queue] - If `true` and the notification queue is disabled, * the queue will be re-enabled. * @returns {this} The callee for chaining. */ diff --git a/source/kernel/mixins/ProxyObject.js b/source/kernel/mixins/ProxyObject.js index d5aacfaa1..c9a32a086 100644 --- a/source/kernel/mixins/ProxyObject.js +++ b/source/kernel/mixins/ProxyObject.js @@ -27,14 +27,14 @@ proxyObjectKey: 'data', /** - * The overloaded [getter]{@link enyo.Object#get}. Acccepts the same + * The overloaded [getter]{@link enyo.Object#get}. Accepts the same * parameters and attempts to call the same method on the * [proxy]{@link enyo.ProxyObject.proxyObjectKey}. Returns `undefined` if it * cannot find a proxy. * * @see enyo.Object.get * @see enyo.getPath - * @param {String} path The path from which to retrieve a value. + * @param {String} path - The path from which to retrieve a value. * @returns {this} The value for the given path, or `undefined` if the path * could not be completely resolved. * @method @@ -58,9 +58,9 @@ * [proxy]{@link enyo.ProxyObject~proxyObjectKey}. Returns the callee for * chaining if it cannot find the proxy. * - * @param {String} path The path for which to set the given value. - * @param {*} is The value to set. - * @param {Object} [opts] An options hash. + * @param {String} path - The path for which to set the given value. + * @param {*} is - The value to set. + * @param {Object} [opts] - An options hash. * @returns {this} The callee for chaining. * @method * @public diff --git a/source/touch/ScrollMath.js b/source/touch/ScrollMath.js index fdaa8fbf6..f5ed3a04b 100644 --- a/source/touch/ScrollMath.js +++ b/source/touch/ScrollMath.js @@ -328,7 +328,7 @@ }, /** - * @fires enyo.ScrollMath#event:onScrollStop + * @fires enyo.ScrollMath#onScrollStop * @private */ animate: function () { @@ -522,7 +522,7 @@ }, /** - * @fires enyo.ScrollMath#event:onScroll + * @fires enyo.ScrollMath#onScroll * @private */ scroll: function () { @@ -536,8 +536,8 @@ /** * Animates a scroll to the specified position. * - * @param {Number} x The `x` position in pixels. - * @param {Number} y The `y` position in pixels. + * @param {Number} x - The `x` position in pixels. + * @param {Number} y - The `y` position in pixels. * @private */ scrollTo: function (x, y) { @@ -556,7 +556,7 @@ /** * Sets the scroll position along the x-axis. * - * @param {Number} x The x-axis scroll position in pixels. + * @param {Number} x - The x-axis scroll position in pixels. * @method * @private */ @@ -567,7 +567,7 @@ /** * Sets the scroll position along the y-axis. * - * @param {Number} y The y-axis scroll position in pixels. + * @param {Number} y - The y-axis scroll position in pixels. * @method * @private */ @@ -578,7 +578,7 @@ /** * Sets the scroll position; defaults to setting this position along the y-axis. * - * @param {Number} pos The scroll position in pixels. + * @param {Number} pos - The scroll position in pixels. * @method * @private */ diff --git a/source/touch/ScrollStrategy.js b/source/touch/ScrollStrategy.js index 064ab7b2e..2c03bfdeb 100644 --- a/source/touch/ScrollStrategy.js +++ b/source/touch/ScrollStrategy.js @@ -166,8 +166,8 @@ /** * Scrolls to the specified position. * - * @param {Number} x The `x` position in pixels. - * @param {Number} y The `y` position in pixels. + * @param {Number} x - The `x` position in pixels. + * @param {Number} y - The `y` position in pixels. * @public */ scrollTo: function (x, y) { @@ -180,9 +180,9 @@ /** * Ensures that the given node is visible in the [scroller's]{@link enyo.Scroller} viewport. * - * @param {Node} node The node to make visible in the [scroller's]{@link enyo.Scroller} + * @param {Node} node - The node to make visible in the [scroller's]{@link enyo.Scroller} * viewport. - * @param {Boolean} alignWithTop If `true`, the node is aligned with the top of the + * @param {Boolean} alignWithTop - If `true`, the node is aligned with the top of the * scroller. * @public */ @@ -205,9 +205,9 @@ /** * Scrolls the given [control]{@link enyo.Control} into view. * - * @param {enyo.Control} ctl The [control]{@link enyo.Control} to make visible in the + * @param {enyo.Control} ctl - The [control]{@link enyo.Control} to make visible in the * [scroller's]{@link enyo.Scroller} viewport. - * @param {Boolean} alignWithTop If `true`, the node is aligned with the top of the + * @param {Boolean} alignWithTop - If `true`, the node is aligned with the top of the * scroller. * @public */ @@ -228,7 +228,7 @@ /** * Sets the vertical scroll position. * - * @param {Number} top The vertical scroll position in pixels. + * @param {Number} top - The vertical scroll position in pixels. * @public */ setScrollTop: function (top) { @@ -241,7 +241,7 @@ /** * Sets the horizontal scroll position. * - * @param {Number} left The horizontal scroll position in pixels. + * @param {Number} left - The horizontal scroll position in pixels. * @public */ setScrollLeft: function (left) { diff --git a/source/touch/Scroller.js b/source/touch/Scroller.js index 78775e407..835c36e9b 100644 --- a/source/touch/Scroller.js +++ b/source/touch/Scroller.js @@ -3,19 +3,19 @@ * An [object]{@glossary Object} representing the scroll boundaries. * * @typedef {Object} enyo.Scroller~BoundaryObject - * @property {Number} left The left scroll position. - * @property {Number} top The top scroll position. - * @property {Number} maxLeft Maximum value for the left scroll position (minimum is always 0). - * @property {Number} maxTop Maximum value for the top scroll position (minimum is always 0). - * @property {Number} clientHeight The vertical size of the [scroller]{@link enyo.Scroller} on + * @property {Number} left - The left scroll position. + * @property {Number} top - The top scroll position. + * @property {Number} maxLeft - Maximum value for the left scroll position (minimum is always 0). + * @property {Number} maxTop - Maximum value for the top scroll position (minimum is always 0). + * @property {Number} clientHeight - The vertical size of the [scroller]{@link enyo.Scroller} on * screen. - * @property {Number} clientWidth The horizontal size of the [scroller]{@link enyo.Scroller} on + * @property {Number} clientWidth - The horizontal size of the [scroller]{@link enyo.Scroller} on * screen. - * @property {Number} width The horizontal size of the full area of the scrolled region. - * @property {Number} height The vertical size of the full area of the scrolled region. - * @property {Number} xDir Either 1, -1, or 0, indicating positive movement along the + * @property {Number} width - The horizontal size of the full area of the scrolled region. + * @property {Number} height - The vertical size of the full area of the scrolled region. + * @property {Number} xDir - Either 1, -1, or 0, indicating positive movement along the * x-axis, negative movement, or no movement, respectively. - * @property {Number} yDir Either 1, -1, or 0, indicating positive movement along the + * @property {Number} yDir - Either 1, -1, or 0, indicating positive movement along the * y-axis, negative movement, or no movement, respectively. */ @@ -24,8 +24,8 @@ * An [object]{@glossary Object} representing the overscroll boundaries. * * @typedef {Object} enyo.Scroller~OverscrollBoundaryObject - * @property {Number} overleft The left overscroll position. - * @property {Number} overtop The top overscroll position. + * @property {Number} overleft - The left overscroll position. + * @property {Number} overtop - The top overscroll position. */ /** @@ -498,7 +498,7 @@ /** * Sets the horizontal scroll position. * - * @param {Number} left The horizontal scroll position in pixels. + * @param {Number} left - The horizontal scroll position in pixels. * @public */ setScrollLeft: function (left) { @@ -512,7 +512,7 @@ /** * Sets the vertical scroll position. * - * @param {Number} top The vertical scroll position in pixels. + * @param {Number} top - The vertical scroll position in pixels. * @public */ setScrollTop: function (top) { @@ -571,9 +571,9 @@ /** * Scrolls the given [control]{@link enyo.Control} into view. * - * @param {enyo.Control} ctl The control to make visible in the + * @param {enyo.Control} ctl - The control to make visible in the * [scroller's]{@link enyo.Scroller} viewport. - * @param {Boolean} alignWithTop If `true`, the node is aligned with the top + * @param {Boolean} alignWithTop - If `true`, the node is aligned with the top * of the scroller. * @public */ @@ -584,8 +584,8 @@ /** * Scrolls to the specified position. * - * @param {Number} x The `x` position in pixels. - * @param {Number} y The `y` position in pixels. + * @param {Number} x - The `x` position in pixels. + * @param {Number} y - The `y` position in pixels. * @public */ scrollTo: function (x, y) { @@ -599,9 +599,9 @@ * [scrollIntoView()]{@glossary scrollIntoView}, this only affects the current * scroller. * - * @param {enyo.Control} ctl The [control]{@link enyo.Control} to make visible in the + * @param {enyo.Control} ctl - The [control]{@link enyo.Control} to make visible in the * [scroller's]{@link enyo.Scroller} viewport. - * @param {Boolean} alignWithTop If `true`, the node is aligned with the top of the + * @param {Boolean} alignWithTop - If `true`, the node is aligned with the top of the * scroller. * @public */ @@ -612,9 +612,9 @@ /** * Ensures that the given node is visible in the [scroller's]{@link enyo.Scroller} viewport. * - * @param {Node} node The node to make visible in the [scroller's]{@link enyo.Scroller} + * @param {Node} node - The node to make visible in the [scroller's]{@link enyo.Scroller} * viewport. - * @param {Boolean} alignWithTop If `true`, the node is aligned with the top of the + * @param {Boolean} alignWithTop - If `true`, the node is aligned with the top of the * scroller. * @public */ @@ -659,7 +659,7 @@ /** * Normalizes scroll {@glossary event} to `onScroll`. * - * @fires enyo.Scroller#event:onScroll + * @fires enyo.Scroller#onScroll * @private */ domScroll: function (sender, e) { diff --git a/source/touch/Thumb.js b/source/touch/Thumb.js index 8de2e3150..6868db961 100644 --- a/source/touch/Thumb.js +++ b/source/touch/Thumb.js @@ -70,7 +70,7 @@ * Syncs the scroll indicator bar to the [scroller]{@link enyo.Scroller} size and position, * as determined by the passed-in scroll strategy. * - * @param {enyo.ScrollStrategy} strategy The scroll strategy to be synced with. + * @param {enyo.ScrollStrategy} strategy - The scroll strategy to be synced with. * @public */ sync: function (strategy) { @@ -83,7 +83,7 @@ * scroll area, and whether there is overscrolling. If the scroll indicator bar is not * needed, it will be not be displayed. * - * @param {enyo.ScrollStrategy} strategy The scroll strategy to update from. + * @param {enyo.ScrollStrategy} strategy - The scroll strategy to update from. * @public */ update: function (strategy) { @@ -138,7 +138,7 @@ * because [showing]{@link enyo.Control#showing} is not changed while we execute * `delayHide()`. * - * @param {Boolean} showing If `true`, displays the {@link enyo.ScrollThumb} if appropriate; + * @param {Boolean} showing - If `true`, displays the {@link enyo.ScrollThumb} if appropriate; * otherwise, hides the ScrollThumb. * @public */ @@ -161,7 +161,7 @@ /** * Delays automatic hiding of the {@link enyo.ScrollThumb}. * - * @param {Number} delay The number of milliseconds to delay hiding of the + * @param {Number} delay - The number of milliseconds to delay hiding of the * {@link enyo.ScrollThumb}. * @public */ diff --git a/source/touch/TouchScrollStrategy.js b/source/touch/TouchScrollStrategy.js index 15033f8ab..85e1c9860 100644 --- a/source/touch/TouchScrollStrategy.js +++ b/source/touch/TouchScrollStrategy.js @@ -390,7 +390,7 @@ * * @todo Doc update made while merging, need official documentation update! * - * @param {Boolean} emit Whether or not to fire the `onScrollStop` event. + * @param {Boolean} emit - Whether or not to fire the `onScrollStop` event. * @public */ stop: function (emit) { @@ -414,8 +414,8 @@ /** * Scrolls to a specific position within the scroll area. * - * @param {Number} x The `x` position in pixels. - * @param {Number} y The `y` position in pixels. + * @param {Number} x - The `x` position in pixels. + * @param {Number} y - The `y` position in pixels. * @public */ scrollTo: function (x, y) { @@ -426,9 +426,9 @@ /** * Scrolls the given [control]{@link enyo.Control} into view. * - * @param {enyo.Control} ctl The [control]{@link enyo.Control} to make visible in the + * @param {enyo.Control} ctl - The [control]{@link enyo.Control} to make visible in the * [scroller's]{@link enyo.Scroller} viewport. - * @param {Boolean} alignWithTop If `true`, the node is aligned with the top of the + * @param {Boolean} alignWithTop - If `true`, the node is aligned with the top of the * scroller. * @method * @public @@ -443,7 +443,7 @@ /** * Sets the horizontal scroll position. * - * @param {Number} left The horizontal scroll position in pixels. + * @param {Number} left - The horizontal scroll position in pixels. * @method * @public */ @@ -457,7 +457,7 @@ /** * Sets the vertical scroll position. * - * @param {Number} top The vertical scroll position in pixels. + * @param {Number} top - The vertical scroll position in pixels. * @method * @public */ diff --git a/source/touch/TransitionScrollStrategy.js b/source/touch/TransitionScrollStrategy.js index b3836d6d4..830f72f3c 100644 --- a/source/touch/TransitionScrollStrategy.js +++ b/source/touch/TransitionScrollStrategy.js @@ -207,7 +207,7 @@ /** * Sets the horizontal scroll position. * - * @param {Number} left The horizontal scroll position in pixels. + * @param {Number} left - The horizontal scroll position in pixels. * @method * @public */ @@ -224,7 +224,7 @@ /** * Sets the vertical scroll position. * - * @param {Number} top The vertical scroll position in pixels. + * @param {Number} top - The vertical scroll position in pixels. * @method * @public */ @@ -241,7 +241,7 @@ /** * Sets the scroll position along the x-axis. * - * @param {Number} x The x-axis scroll position in pixels. + * @param {Number} x - The x-axis scroll position in pixels. * @method * @public */ @@ -252,7 +252,7 @@ /** * Sets the scroll position along the y-axis. * - * @param {Number} y The y-axis scroll position in pixels. + * @param {Number} y - The y-axis scroll position in pixels. * @method * @public */ @@ -438,7 +438,7 @@ }, /** - * @fires enyo.TransitionScrollStrategy#event:onScroll + * @fires enyo.TransitionScrollStrategy#onScroll * @private */ mousewheel: function (sender, e) { @@ -459,7 +459,7 @@ /** * Updates thumbs, recalculates boundaries, and bubbles `scroll` {@glossary event}. * - * @fires enyo.TransitionScrollStrategy#event:onScroll + * @fires enyo.TransitionScrollStrategy#onScroll * @private */ scroll: function () { @@ -474,7 +474,7 @@ * Scrolls to current `x` and `y` coordinates and bubbles `scrollstart` * {@glossary event}. * - * @fires enyo.TransitionScrollStrategy#event:onScrollStart + * @fires enyo.TransitionScrollStrategy#onScrollStart * @private */ start: function () { @@ -486,7 +486,7 @@ * If currently scrolling, stops scrolling. Hides thumbs and bubbles `scrollstop` * {@glossary event}. * - * @fires enyo.TransitionScrollStrategy#event:onScrollStop + * @fires enyo.TransitionScrollStrategy#onScrollStop * @private */ stop: function () { @@ -1049,8 +1049,8 @@ /** * Scrolls to a specific position within the scroll area. * - * @param {Number} x The `x` position in pixels. - * @param {Number} y The `y` position in pixels. + * @param {Number} x - The `x` position in pixels. + * @param {Number} y - The `y` position in pixels. * @public */ scrollTo: function (x, y) { diff --git a/source/touch/TranslateScrollStrategy.js b/source/touch/TranslateScrollStrategy.js index c1f3a6cc0..b8256feea 100644 --- a/source/touch/TranslateScrollStrategy.js +++ b/source/touch/TranslateScrollStrategy.js @@ -123,7 +123,7 @@ /** * Sets the horizontal scroll position. * - * @param {Number} left The horizontal scroll position in pixels. + * @param {Number} left - The horizontal scroll position in pixels. * @method * @public */ @@ -143,7 +143,7 @@ /** * Sets the vertical scroll position. * - * @param {Number} top The vertical scroll position in pixels. + * @param {Number} top - The vertical scroll position in pixels. * @method * @public */ diff --git a/source/touch/gesture.js b/source/touch/gesture.js index 99fdb6dc0..002cb1f4c 100644 --- a/source/touch/gesture.js +++ b/source/touch/gesture.js @@ -5,10 +5,10 @@ * emulate iOS gesture events on non-iOS devices. * * @typedef {Object} enyo.gesture~EmulatedGestureEvent - * @property {Number} pageX The x-coordinate of the center point between fingers. - * @property {Number} pageY The y-coordinate of the center point between fingers. - * @property {Number} rotation The degrees of rotation from the beginning of the gesture. - * @property {Number} scale The percent change of distance between fingers. + * @property {Number} pageX - The x-coordinate of the center point between fingers. + * @property {Number} pageY - The y-coordinate of the center point between fingers. + * @property {Number} rotation - The degrees of rotation from the beginning of the gesture. + * @property {Number} scale - The percent change of distance between fingers. */ /** diff --git a/source/ui/Animator.js b/source/ui/Animator.js index 63070320e..f5237b887 100644 --- a/source/ui/Animator.js +++ b/source/ui/Animator.js @@ -2,7 +2,7 @@ /** * Fires when an animation step occurs. * - * @event enyo.Animator#event:onStep + * @event enyo.Animator#onStep * @type {Object} * @property {Object} sender - The [component]{@link enyo.Component} that most recently * propagated the {@glossary event}. @@ -13,7 +13,7 @@ /** * Fires when the animation finishes normally. * - * @event enyo.Animator#event:onEnd + * @event enyo.Animator#onEnd * @type {Object} * @property {Object} sender - The [component]{@link enyo.Component} that most recently * propagated the {@glossary event}. @@ -24,7 +24,7 @@ /** * Fires when the animation is prematurely stopped. * - * @event enyo.Animator#event:onStop + * @event enyo.Animator#onStop * @type {Object} * @property {Object} sender - The [component]{@link enyo.Component} that most recently * propagated the {@glossary event}. @@ -36,10 +36,10 @@ * {@link enyo.Animator} is a basic animation [component]{@link enyo.Component}. Call * [play()]{@link enyo.Animator#play} to start the animation. The animation will run for * the period (in milliseconds) specified by its [duration]{@link enyo.Animator#duration} - * property. [onStep]{@link enyo.Animator#event:onStep} [events]{@glossary event} will + * property. [onStep]{@link enyo.Animator#onStep} [events]{@glossary event} will * fire in quick succession and should be handled to do something based on the * [value]{@link enyo.Animator#value} property. - * + * * The `value` property will progress from [startValue]{@link enyo.Animator#startValue} * to [endValue]{@link enyo.Animator#endValue} during the animation, based on the * [function]{@glossary Function} referenced by the @@ -169,7 +169,7 @@ /** * Plays the animation. * - * @param {Object} props As a convenience, this [hash]{@glossary Object} will be mixed + * @param {Object} props - As a convenience, this [hash]{@glossary Object} will be mixed * directly into this [object]{@glossary Object}. * @public */ @@ -193,7 +193,7 @@ /** * Stops the animation and fires the associated {@glossary event}. * - * @fires enyo.Animator#event:onStop + * @fires enyo.Animator#onStop * @returns {this} The callee for chaining. * @public */ @@ -265,8 +265,8 @@ /** * Runs the next step of the animation. * - * @fires enyo.Animator#event:onStep - * @fires enyo.Animator#event:onEnd + * @fires enyo.Animator#onStep + * @fires enyo.Animator#onEnd * @private */ next: function() { diff --git a/source/ui/Audio.js b/source/ui/Audio.js index 29f69d497..658445427 100644 --- a/source/ui/Audio.js +++ b/source/ui/Audio.js @@ -3,7 +3,7 @@ * {@link enyo.Audio} extends {@link enyo.Media} to implement an * [HTML 5 Media element]{@glossary HTML5MediaElement} that allows you to play * audio data. - * + * * Initialize an audio component as follows: * * ``` diff --git a/source/ui/Checkbox.js b/source/ui/Checkbox.js index 252c3c4e7..9f33316f3 100644 --- a/source/ui/Checkbox.js +++ b/source/ui/Checkbox.js @@ -2,7 +2,7 @@ /** * Fires when checkbox is tapped. * - * @event enyo.Checkbox#event:onActivate + * @event enyo.Checkbox#onActivate * @type {Object} * @property {Object} sender - The [component]{@link enyo.Component} that most recently * propagated the @glossary event}. @@ -129,7 +129,7 @@ * All [input]{@link enyo.Input} type [controls]{@link enyo.Control} support the * [value]{@link enyo.Input#value} property. * - * @param {Boolean} val Whether or not the [checkbox]{@link enyo.Checkbox} should + * @param {Boolean} val - Whether or not the [checkbox]{@link enyo.Checkbox} should * be checked. The value will be treated as `true` if it is truthy; otherwise, * `false`. * @public diff --git a/source/ui/DragAvatar.js b/source/ui/DragAvatar.js index 15e4c24f7..1ab3b6a3e 100644 --- a/source/ui/DragAvatar.js +++ b/source/ui/DragAvatar.js @@ -130,7 +130,7 @@ * Instantiates the avatar control (if necessary), determines correct position, and calls * [show()]{@link enyo.DragAvatar#show} to make it visible. * - * @param {Object} e An [object]{@glossary Object} containing {@glossary event} + * @param {Object} e - An [object]{@glossary Object} containing {@glossary event} * information. * @public */ diff --git a/source/ui/Drawer.js b/source/ui/Drawer.js index efc4cc706..41addf72b 100644 --- a/source/ui/Drawer.js +++ b/source/ui/Drawer.js @@ -5,7 +5,7 @@ * [open]{@link enyo.Drawer#open} property. If `this.getOpen()` returns `true`, * the drawer was opened; if not, it was closed. * - * @event enyo.Drawer#event:onDrawerAnimationStep + * @event enyo.Drawer#onDrawerAnimationStep * @type {Object} * @property {Object} sender - The [component]{@link enyo.Component} that most recently * propagated the {@glossary event}. @@ -19,7 +19,7 @@ * [open]{@link enyo.Drawer#open} property. If `this.getOpen()` returns `true`, * the drawer was opened; if not, it was closed. * - * @event enyo.Drawer#event:onDrawerAnimationEnd + * @event enyo.Drawer#onDrawerAnimationEnd * @type {Object} * @property {Object} sender - The [component]{@link enyo.Component} that most recently * propagated the {@glossary event}. diff --git a/source/ui/Group.js b/source/ui/Group.js index 7a6fd0e6d..d84fe0f52 100644 --- a/source/ui/Group.js +++ b/source/ui/Group.js @@ -1,17 +1,17 @@ (function (enyo, scope) { /** - * The extended {@glossary event} [object]{@glossary Object} that is provided when the - * [onActiveChanged]{@link enyo.Group#event:onActiveChanged} event is fired. + * The extended {@glossary event} [object]{@glossary Object} that is provided when the + * [onActiveChanged]{@link enyo.Group#onActiveChanged} event is fired. * * @typedef {Object} enyo.Group~ActiveChangedEvent - * @property {enyo.Control} active The active [control]{@link enyo.Control} for the + * @property {enyo.Control} active - The active [control]{@link enyo.Control} for the * [group]{@link enyo.Group}. */ /** * Fires when the active control is changed. * - * @event enyo.Group#event:onActiveChanged + * @event enyo.Group#onActiveChanged * @type {Object} * @property {Object} sender - The [component]{@link enyo.Component} that most recently * propagated the {@glossary event}. @@ -21,7 +21,7 @@ */ /** - * {@link enyo.Group} provides a wrapper around multiple elements. It enables the creation of + * {@link enyo.Group} provides a wrapper around multiple elements. It enables the creation of * radio groups from arbitrary [components]{@link enyo.Component} that support the * {@link enyo.GroupItem} API. * @@ -131,7 +131,7 @@ }, /** - * @fires enyo.Group#event:onActiveChanged + * @fires enyo.Group#onActiveChanged * @private */ activeChanged: function(inOld) { diff --git a/source/ui/GroupItem.js b/source/ui/GroupItem.js index 94b73c2d5..8167ecba1 100644 --- a/source/ui/GroupItem.js +++ b/source/ui/GroupItem.js @@ -2,7 +2,7 @@ /** * Fires when the [active state]{@link enyo.GroupItem#active} has changed. * - * @event enyo.GroupItem#event:onActivate + * @event enyo.GroupItem#onActivate * @type {Object} * @property {Object} sender - The [component]{@link enyo.Component} that most recently * propagated the {@glossary event}. @@ -17,10 +17,10 @@ * (or the [inheriting]{@glossary subkind} component). A subkind may call `setActive()` * to set the [active]{@link enyo.GroupItem#active} property to the desired state; this * will additionally [bubble]{@link enyo.Component#bubble} an - * [onActivate]{@link enyo.GroupItem#event:onActivate} {@glossary event}, which may + * [onActivate]{@link enyo.GroupItem#onActivate} {@glossary event}, which may * be handled as needed by the containing components. This is useful for creating * groups of items whose state should be managed collectively. - * + * * For an example of how this works, see the {@link enyo.Group} kind, which enables the * creation of radio groups from arbitrary components that support the Grouping API. * @@ -64,7 +64,7 @@ }), /** - * @fires enyo.GroupItem#event:onActivate + * @fires enyo.GroupItem#onActivate * @private */ activeChanged: function() { diff --git a/source/ui/Image.js b/source/ui/Image.js index 204afd9ed..a665b7dec 100644 --- a/source/ui/Image.js +++ b/source/ui/Image.js @@ -2,7 +2,7 @@ /** * Fires when the [image]{@link enyo.Image} has loaded. * - * @event enyo.Image#event:onload + * @event enyo.Image#onload * @type {Object} * @property {Object} sender - The [component]{@link enyo.Component} that most recently * propagated the {@glossary event}. @@ -13,7 +13,7 @@ /** * Fires when there has been an error while loading the [image]{@link enyo.Image}. * - * @event enyo.Image#event:onerror + * @event enyo.Image#onerror * @type {Object} * @property {Object} sender - The [component]{@link enyo.Component} that most recently * propagated the {@glossary event}. @@ -24,7 +24,7 @@ /** * {@link enyo.Image} implements an HTML [<img>]{@glossary img} element and, * optionally, [bubbles]{@link enyo.Component#bubble} the - * [onload]{@link enyo.Image#event:onload} and [onerror]{@link enyo.Image#event:onerror} + * [onload]{@link enyo.Image#onload} and [onerror]{@link enyo.Image#onerror} * [events]{@glossary event}. Image dragging is suppressed by default, so as not to * interfere with touch interfaces. * @@ -41,8 +41,8 @@ name: 'enyo.Image', /** - * When `true`, no [onload]{@link enyo.Image#event:onload} or - * [onerror]{@link enyo.Image#event:onerror} {@glossary event} handlers will be + * When `true`, no [onload]{@link enyo.Image#onload} or + * [onerror]{@link enyo.Image#event:onerror} {@glossary event} handlers will be * created. * * @type {Boolean} @@ -106,7 +106,7 @@ /** * @type {Object} - * @property {Boolean} draggable This attribute will take one of the following + * @property {Boolean} draggable - This attribute will take one of the following * [String]{@glossary String} values: 'true', 'false' (the default), or 'auto'. * Setting Boolean `false` will remove the attribute. * @public @@ -200,8 +200,8 @@ }, /** - * @fires enyo.Image#event:onload - * @fires enyo.Image#event:onerror + * @fires enyo.Image#onload + * @fires enyo.Image#onerror * @private */ rendered: enyo.inherit(function (sup) { diff --git a/source/ui/Input.js b/source/ui/Input.js index 427f29835..7953efb05 100644 --- a/source/ui/Input.js +++ b/source/ui/Input.js @@ -2,7 +2,7 @@ /** * Fires immediately when the text changes. * - * @event enyo.Input#event:oninput + * @event enyo.Input#oninput * @type {Object} * @property {Object} sender - The [component]{@link enyo.Component} that most recently * propagated the {@glossary event}. @@ -14,7 +14,7 @@ * Fires when the text has changed and the [input]{@link enyo.Input} subsequently loses * focus. * - * @event enyo.Input#event:onchange + * @event enyo.Input#onchange * @type {Object} * @property {Object} sender - The [component]{@link enyo.Component} that most recently * propagated the {@glossary event}. @@ -25,7 +25,7 @@ /** * Fires when the [input]{@link enyo.Input} is disabled or enabled. * - * @event enyo.Input#event:onDisabledChange + * @event enyo.Input#onDisabledChange * @type {Object} * @property {Object} sender - The [component]{@link enyo.Component} that most recently * propagated the {@glossary event}. @@ -36,9 +36,9 @@ /** * {@link enyo.Input} implements an HTML [<input>]{@glossary input} element * with cross-platform support for change [events]{@glossary event}. - * - * You may listen for [oninput]{@link enyo.Input#event:oninput} and - * [onchange]{@link enyo.Input#event:onchange} [DOM events]{@glossary DOMEvent} from this + * + * You may listen for [oninput]{@link enyo.Input#oninput} and + * [onchange]{@link enyo.Input#onchange} [DOM events]{@glossary DOMEvent} from this * [control]{@link enyo.Control} to know when the text inside has been modified. * * For more information, see the documentation on @@ -209,7 +209,7 @@ }, /** - * @fires enyo.Input#event:onDisabledChange + * @fires enyo.Input#onDisabledChange * @private */ disabledChanged: function() { diff --git a/source/ui/Media.js b/source/ui/Media.js index a9d965657..8d9a1508d 100644 --- a/source/ui/Media.js +++ b/source/ui/Media.js @@ -3,7 +3,7 @@ * Fires when element stops fetching [media]{@link enyo.Media} data before it is * completely downloaded, but not due to an error. * - * @event enyo.Media#event:onAbort + * @event enyo.Media#onAbort * @type {Object} * @property {Object} sender - The [component]{@link enyo.Component} that most recently * propagated the {@glossary event}. @@ -15,7 +15,7 @@ * Fires when element can resume playback of the [media]{@link enyo.Media} data, but may * need to stop for further buffering of content. * - * @event enyo.Media#event:onCanPlay + * @event enyo.Media#onCanPlay * @type {Object} * @property {Object} sender - The [component]{@link enyo.Component} that most recently * propagated the {@glossary event}. @@ -27,7 +27,7 @@ * Fires when element can resume playback of the [media]{@link enyo.Media} data without * needing to stop for further buffering of content. * - * @event enyo.Media#event:onCanPlayThrough + * @event enyo.Media#onCanPlayThrough * @type {Object} * @property {Object} sender - The [component]{@link enyo.Component} that most recently * propagated the {@glossary event}. @@ -38,7 +38,7 @@ /** * Fires when the [duration]{@link enyo.Media#duration} attribute has been changed. * - * @event enyo.Media#event:onDurationChange + * @event enyo.Media#onDurationChange * @type {Object} * @property {Object} sender - The [component]{@link enyo.Component} that most recently * propagated the {@glossary event}. @@ -50,7 +50,7 @@ * Fires when [networkState]{@glossary networkState} switches to `NETWORK_EMPTY` * from another state. * - * @event enyo.Media#event:onEmptied + * @event enyo.Media#onEmptied * @type {Object} * @property {Object} sender - The [component]{@link enyo.Component} that most recently * propagated the {@glossary event}. @@ -61,7 +61,7 @@ /** * Fires when [media]{@link enyo.Media} playback finishes normally. * - * @event enyo.Media#event:onEnded + * @event enyo.Media#onEnded * @type {Object} * @property {Object} sender - The [component]{@link enyo.Component} that most recently * propagated the {@glossary event}. @@ -72,7 +72,7 @@ /** * Fires when an error occurs while fetching [media]{@link enyo.Media} data. * - * @event enyo.Media#event:onError + * @event enyo.Media#onError * @type {Object} * @property {Object} sender - The [component]{@link enyo.Component} that most recently * propagated the {@glossary event}. @@ -84,7 +84,7 @@ * Fires when the [media]{@link enyo.Media} data at the current playback position * can be rendered for the first time. * - * @event enyo.Media#event:onLoadedData + * @event enyo.Media#onLoadedData * @type {Object} * @property {Object} sender - The [component]{@link enyo.Component} that most recently * propagated the {@glossary event}. @@ -96,7 +96,7 @@ * Fires when the duration and dimensions of the [media]{@link enyo.Media} * resource/text tracks are ready. * - * @event enyo.Media#event:onLoadedMetaData + * @event enyo.Media#onLoadedMetaData * @type {Object} * @property {Object} sender - The [component]{@link enyo.Component} that most recently * propagated the {@glossary event}. @@ -107,7 +107,7 @@ /** * Fires when the [media]{@link enyo.Media} element begins looking for media data. * - * @event enyo.Media#event:onLoadStart + * @event enyo.Media#onLoadStart * @type {Object} * @property {Object} sender - The [component]{@link enyo.Component} that most recently * propagated the {@glossary event}. @@ -118,7 +118,7 @@ /** * Fires when playback is paused. * - * @event enyo.Media#event:onPause + * @event enyo.Media#onPause * @type {Object} * @property {Object} sender - The [component]{@link enyo.Component} that most recently * propagated the {@glossary event}. @@ -129,7 +129,7 @@ /** * Fires when playback is no longer paused. * - * @event enyo.Media#event:onPlay + * @event enyo.Media#onPlay * @type {Object} * @property {Object} sender - The [component]{@link enyo.Component} that most recently * propagated the {@glossary event}. @@ -141,7 +141,7 @@ * Fires when playback is ready to start after having been paused or delayed due to lack * of [media]{@link enyo.Media} data. * - * @event enyo.Media#event:onPlaying + * @event enyo.Media#onPlaying * @type {Object} * @property {Object} sender - The [component]{@link enyo.Component} that most recently * propagated the {@glossary event}. @@ -152,7 +152,7 @@ /** * Fires when fetching [media]{@link enyo.Media} data. * - * @event enyo.Media#event:onProgress + * @event enyo.Media#onProgress * @type {Object} * @property {Object} sender - The [component]{@link enyo.Component} that most recently * propagated the {@glossary event}. @@ -164,7 +164,7 @@ * Fires when either [defaultPlaybackRate]{@link enyo.Media#defaultPlaybackRate} or * [playbackRate]{@link enyo.Media#playbackRate} is updated. * - * @event enyo.Media#event:onRateChange + * @event enyo.Media#onRateChange * @type {Object} * @property {Object} sender - The [component]{@link enyo.Component} that most recently * propagated the {@glossary event}. @@ -175,7 +175,7 @@ /** * Fires when the seeking IDL attribute changes to `false`. * - * @event enyo.Media#event:onSeeked + * @event enyo.Media#onSeeked * @type {Object} * @property {Object} sender - The [component]{@link enyo.Component} that most recently * propagated the {@glossary event}. @@ -186,7 +186,7 @@ /** * Fires when the seeking IDL attribute changes to `true`. * - * @event enyo.Media#event:onSeeking + * @event enyo.Media#onSeeking * @type {Object} * @property {Object} sender - The [component]{@link enyo.Component} that most recently * propagated the {@glossary event}. @@ -197,7 +197,7 @@ /** * Fires when [media]{@link enyo.Media} fetching is interrupted. * - * @event enyo.Media#event:onStalled + * @event enyo.Media#onStalled * @type {Object} * @property {Object} sender - The [component]{@link enyo.Component} that most recently * propagated the {@glossary event}. @@ -208,7 +208,7 @@ /** * Fires when the [media]{@link enyo.Media} controller position changes. * - * @event enyo.Media#event:onTimeUpdate + * @event enyo.Media#onTimeUpdate * @type {Object} * @property {Object} sender - The [component]{@link enyo.Component} that most recently * propagated the {@glossary event}. @@ -220,7 +220,7 @@ * Fires when either [volume]{@link enyo.Media#volume} or [muted]{@link enyo.Media#muted} * is updated. * - * @event enyo.Media#event:onVolumeChange + * @event enyo.Media#onVolumeChange * @type {Object} * @property {Object} sender - The [component]{@link enyo.Component} that most recently * propagated the {@glossary event}. @@ -232,7 +232,7 @@ * Fires when playback has stopped because the next frame is not available, but is * expected to be. * - * @event enyo.Media#event:onWaiting + * @event enyo.Media#onWaiting * @type {Object} * @property {Object} sender - The [component]{@link enyo.Component} that most recently * propagated the {@glossary event}. @@ -243,7 +243,7 @@ /** * Fires when the playback rate has changed to a value > 1. * - * @event enyo.Media#event:onFastforward + * @event enyo.Media#onFastforward * @type {Object} * @property {Object} sender - The [component]{@link enyo.Component} that most recently * propagated the {@glossary event}. @@ -254,7 +254,7 @@ /** * Fires when the playback rate has changed to a positive value < 1. * - * @event enyo.Media#event:onSlowforward + * @event enyo.Media#onSlowforward * @type {Object} * @property {Object} sender - The [component]{@link enyo.Component} that most recently * propagated the {@glossary event}. @@ -265,7 +265,7 @@ /** * Fires when the playback rate has changed to a value < -1. * - * @event enyo.Media#event:onRewind + * @event enyo.Media#onRewind * @type {Object} * @property {Object} sender - The [component]{@link enyo.Component} that most recently * propagated the {@glossary event}. @@ -276,7 +276,7 @@ /** * Fires when the playback rate has changed to a negative value > -1. * - * @event enyo.Media#event:onSlowrewind + * @event enyo.Media#onSlowrewind * @type {Object} * @property {Object} sender - The [component]{@link enyo.Component} that most recently * propagated the {@glossary event}. @@ -288,7 +288,7 @@ * Fires when the playback has jumped forward by the number of seconds specified by the * [jumpSec property]{@link enyo.Media#jumpSec}. * - * @event enyo.Media#event:onJumpForward + * @event enyo.Media#onJumpForward * @type {Object} * @property {Object} sender - The [component]{@link enyo.Component} that most recently * propagated the {@glossary event}. @@ -300,7 +300,7 @@ * Fires when the playback has jumped backward by the number of seconds specified by the * [jumpSec property]{@link enyo.Media#jumpSec}. * - * @event enyo.Media#event:onJumpBackward + * @event enyo.Media#onJumpBackward * @type {Object} * @property {Object} sender - The [component]{@link enyo.Component} that most recently * propagated the {@glossary event}. @@ -311,7 +311,7 @@ /** * Fires when playback has started. * - * @event enyo.Media#event:onStart + * @event enyo.Media#onStart * @type {Object} * @property {Object} sender - The [component]{@link enyo.Component} that most recently * propagated the {@glossary event}. @@ -683,7 +683,7 @@ * Called when element stops fetching media data before it has been completely downloaded, * but not due to an error. * - * @fires enyo.Media#event:onEnded + * @fires enyo.Media#onEnded * @private */ _abort: function() { @@ -694,7 +694,7 @@ * Called when element can resume playback of media data, but may need to stop for further * buffering of content. * - * @fires enyo.Media#event:onCanPlay + * @fires enyo.Media#onCanPlay * @private */ _canPlay: function() { @@ -704,7 +704,7 @@ * Called when element can resume playback of the media data without needing to stop for * further buffering of content. * - * @fires enyo.Media#event:onCanPlayThrough + * @fires enyo.Media#onCanPlayThrough * @private */ _canPlayThrough: function() { @@ -714,7 +714,7 @@ /** * Called when the [duration]{@link enyo.Media#duration} attribute has been changed. * - * @fires enyo.Media#event:onDurationChange + * @fires enyo.Media#onDurationChange * @private */ _durationChange: function() { @@ -725,7 +725,7 @@ * Called when [networkState]{@glossary networkState} switches to `NETWORK_EMPTY` from * another state. * - * @fires enyo.Media#event:onEmptied + * @fires enyo.Media#onEmptied * @private */ _emptied: function() { @@ -735,7 +735,7 @@ /** * Called when playback reaches the end of the media data. * - * @fires enyo.Media#event:onEnded + * @fires enyo.Media#onEnded * @private */ _ended: function() { @@ -754,7 +754,7 @@ * Called when we can render the media data at the current playback position for the first * time. * - * @fires enyo.Media#event:onLoadedData + * @fires enyo.Media#onLoadedData * @private */ _loadedData: function() { @@ -772,7 +772,7 @@ /** * Called when the media element begins looking for media data. * - * @fires enyo.Media#event:onLoadStart + * @fires enyo.Media#onLoadStart * @private */ _loadStart: function() { @@ -782,7 +782,7 @@ /** * Called when playback is paused. * - * @fires enyo.Media#event:onPause + * @fires enyo.Media#onPause * @private */ _pause: function() { @@ -792,7 +792,7 @@ /** * Called when playback is no longer paused. * - * @fires enyo.Media#event:onPlay + * @fires enyo.Media#onPlay * @private */ _play: function() { @@ -803,7 +803,7 @@ * Called when playback is ready to start after having been paused or delayed due to lack of * media data. * - * @fires enyo.Media#event:onPlaying + * @fires enyo.Media#onPlaying * @private */ _playing: function() { @@ -813,7 +813,7 @@ /** * Called when the media element is fetching media data. * - * @fires enyo.Media#event:onProgress + * @fires enyo.Media#onProgress * @private */ _progress: function() { @@ -821,7 +821,7 @@ }, /** - * @fires enyo.Media#event:onStart + * @fires enyo.Media#onStart * @private */ createEventData: function() { @@ -844,7 +844,7 @@ /** * Calculates the number value of the given playback rate (with support for fractions). * - * @param {String} rate The playback rate, which may be a fraction, that will be converted to + * @param {String} rate - The playback rate, which may be a fraction, that will be converted to * a numerical value. * @returns {Number} The numerical representation of the playback rate. * @private @@ -857,11 +857,11 @@ * Called when either [defaultPlaybackRate]{@link enyo.Media#defaultPlaybackRate} or * [playbackRate]{@link enyo.Media#playbackRate} has been updated. * - * @fires enyo.Media#event:onSlowforward - * @fires enyo.Media#event:onFastforward - * @fires enyo.Media#event:onSlowrewind - * @fires enyo.Media#event:onRewind - * @fires enyo.Media#event:onPlay + * @fires enyo.Media#onSlowforward + * @fires enyo.Media#onFastforward + * @fires enyo.Media#onSlowrewind + * @fires enyo.Media#onRewind + * @fires enyo.Media#onPlay * @private */ _rateChange: function(sender, e) { @@ -893,7 +893,7 @@ /** * Called when fetching of media data is interrupted. * - * @fires enyo.Media#event:onStalled + * @fires enyo.Media#onStalled * @private */ _stalled: function() { @@ -902,7 +902,7 @@ /** * Called when the seeking IDL attribute changes to `false`. * - * @fires enyo.Media#event:onSeeked + * @fires enyo.Media#onSeeked * @private */ _seeked: function() { @@ -912,7 +912,7 @@ /** * Called when the seeking IDL attribute changes to `true`. * - * @fires enyo.Media#event:onSeeking + * @fires enyo.Media#onSeeking * @private */ _seeking: function() { @@ -937,7 +937,7 @@ * Called when either [volume]{@link enyo.Media#volume} or [muted]{@link enyo.Media#muted} is * updated. * - * @fires enyo.Media#event:onVolumeChange + * @fires enyo.Media#onVolumeChange * @private */ _volumeChange: function() { @@ -948,7 +948,7 @@ * Called when playback has stopped because the next frame is not available, but is expected * to be. * - * @fires enyo.Media#event:onWaiting + * @fires enyo.Media#onWaiting * @private */ _waiting: function() { @@ -985,7 +985,7 @@ /** * Seeks to the specified time. * - * @param {Number} time The time, in seconds, to seek to. + * @param {Number} time - The time, in seconds, to seek to. * @public */ seekTo: function(time) { @@ -1091,7 +1091,7 @@ /** * Sets current player position in the [media]{@link enyo.Media} element. * - * @param {Number} time The player position, in seconds. + * @param {Number} time - The player position, in seconds. * @public */ setCurrentTime: function(time) { @@ -1302,7 +1302,7 @@ * Jumps backward by an amount specified by the [jumpSec]{@link enyo.Media#jumpSec} * property. * - * @fires enyo.Media#event:onJumpBackward + * @fires enyo.Media#onJumpBackward * @public */ jumpBackward: function() { @@ -1323,7 +1323,7 @@ * Jumps forward by an amount specified by the [jumpSec]{@link enyo.Media#jumpSec} * property. * - * @fires enyo.Media#event:onJumpForward + * @fires enyo.Media#onJumpForward * @public */ jumpForward: function() { diff --git a/source/ui/Popup.js b/source/ui/Popup.js index 03d187a32..8009224b0 100644 --- a/source/ui/Popup.js +++ b/source/ui/Popup.js @@ -2,7 +2,7 @@ /** * Fires after the [popup]{@link enyo.Popup} is shown. * - * @event enyo.Popup#event:onShow + * @event enyo.Popup#onShow * @type {Object} * @property {Object} sender - The [component]{@link enyo.Component} that most recently * propagated the {@glossary event}. @@ -13,7 +13,7 @@ /** * Fires after the [popup]{@link enyo.Popup} is hidden. * - * @event enyo.Popup#event:onHide + * @event enyo.Popup#onHide * @type {Object} * @property {Object} sender - The [component]{@link enyo.Component} that most recently * propagated the {@glossary event}. @@ -24,7 +24,7 @@ /** * {@link enyo.Popup} is a [control]{@link enyo.Control} used to display certain content * on top of other content. - * + * * Popups are initially hidden on creation; they may be shown by calling the * [show()]{@link enyo.Control#show} method and re-hidden by calling * [hide()]{@link enyo.Control#hide}. Popups may be centered using the @@ -345,8 +345,8 @@ /** * @method - * @fires enyo.Popup#event:onShow - * @fires enyo.Popup#event:onHide + * @fires enyo.Popup#onShow + * @fires enyo.Popup#onHide * @private */ showingChanged: enyo.inherit(function (sup) { @@ -499,8 +499,8 @@ * that it does not display outside the viewport, and defaults to anchoring * the top left corner of the popup to the position of the mouse event. * - * @param {Object} e The mouse {@glossary event} that initiated this call. - * @param {Object} [offset] An optional [object]{@glossary Object} that may + * @param {Object} e - The mouse {@glossary event} that initiated this call. + * @param {Object} [offset] - An optional [object]{@glossary Object} that may * contain `left` and `top` properties to specify an offset relative to the * location where the [popup]{@link enyo.Popup} would otherwise be positioned. * @public diff --git a/source/ui/Repeater.js b/source/ui/Repeater.js index 3215cfd6b..1acc793db 100644 --- a/source/ui/Repeater.js +++ b/source/ui/Repeater.js @@ -1,17 +1,17 @@ (function (enyo, scope) { /** - * The extended {@glossary event} [object]{@glossary Object} that is provided - * when the [onSetupItem]{@link enyo.Repeater#event:onSetupItem} event is fired. + * The extended {@glossary event} [object]{@glossary Object} that is provided + * when the [onSetupItem]{@link enyo.Repeater#onSetupItem} event is fired. * * @typedef {Object} enyo.Repeater~SetupItemEvent - * @property {Number} index The item's index. - * @property {Object} item The item control, for decoration. + * @property {Number} index - The item's index. + * @property {Object} item - The item control, for decoration. */ /** * Fires when each item is created. * - * @event enyo.Repeater#event:onSetupItem + * @event enyo.Repeater#onSetupItem * @type {Object} * @property {Object} sender - The [component]{@link enyo.Component} that most recently * propagated the {@glossary event}. @@ -22,7 +22,7 @@ /** * {@link enyo.Repeater} is a simple [control]{@link enyo.Control} for making lists of items. - * + * * The [components]{@link enyo.Component} of a repeater are copied for each item created, * and are wrapped in a control that keeps the state of the item index. * @@ -120,13 +120,13 @@ /** * Renders the [collection]{@link enyo.Collection} of items. This will delete any * existing items and recreate the [repeater]{@link enyo.Repeater} if called after - * the repeater has been rendered. This is called automatically when the + * the repeater has been rendered. This is called automatically when the * [count]{@link enyo.Repeater#count} property changes. To set the `count` property * and force a re-render, such as when a [data model]{@link enyo.Model} changes, * use `set('count', newCount, true)`, where the last parameter forces the change * handler to be called, even if the `count` remains the same. * - * @fires enyo.Repeater#event:onSetupItem + * @fires enyo.Repeater#onSetupItem * @public */ build: function() { @@ -145,8 +145,8 @@ * destroy the item, but just calls the `onSetupItem` {@glossary event} handler again * for it, so any state stored in the item is preserved. * - * @param {Number} idx The index of the item to render. - * @fires enyo.Repeater#event:onSetupItem + * @param {Number} idx - The index of the item to render. + * @fires enyo.Repeater#onSetupItem * @public */ renderRow: function(idx) { diff --git a/source/ui/RichText.js b/source/ui/RichText.js index a60f5fd0e..f02c7dd6e 100644 --- a/source/ui/RichText.js +++ b/source/ui/RichText.js @@ -162,10 +162,10 @@ this._value = this.get('value'); }, /** - * Simulates [onchange]{@link enyo.Input#event:onchange} {@glossary event} + * Simulates [onchange]{@link enyo.Input#onchange} {@glossary event} * exposed by [inputs]{@link enyo.Input}. * - * @fires enyo.Input#event:onchange + * @fires enyo.Input#onchange * @private */ blurHandler: function() { @@ -238,7 +238,7 @@ /** * Removes the [selection]{@glossary Selection} [object]{@glossary Object}. * - * @param {Boolean} start If `true`, the [selection]{@glossary Selection} is + * @param {Boolean} start - If `true`, the [selection]{@glossary Selection} is * [collapsed to the start]{@glossary Selection.collapseToStart} of the * [range]{@glossary Range}; otherwise, it is * [collapsed to the end]{@glossary Selection.collapseToEnd} of the range. @@ -255,9 +255,9 @@ * Modifies the [selection]{@glossary Selection} [object]{@glossary Object}. Please * see the [Selection.modify]{@glossary Selection.modify} API for more information. * - * @param {enyo.RichText~ModifyType} type The type of change to apply. - * @param {enyo.RichText~ModifyDirection} dir The direction in which to apply the change. - * @param {enyo.RichText~ModifyAmount} amount The granularity of the change. + * @param {enyo.RichText~ModifyType} type - The type of change to apply. + * @param {enyo.RichText~ModifyDirection} dir - The direction in which to apply the change. + * @param {enyo.RichText~ModifyAmount} amount - The granularity of the change. * @public */ modifySelection: function(type, dir, amount) { @@ -270,8 +270,8 @@ /** * Moves the cursor according to the [Editing API]{@glossary Selection.modify}. * - * @param {enyo.RichText~ModifyDirection} dir The direction in which to apply the change. - * @param {enyo.RichText~ModifyAmount} amount The granularity of the change. + * @param {enyo.RichText~ModifyDirection} dir - The direction in which to apply the change. + * @param {enyo.RichText~ModifyAmount} amount - The granularity of the change. * @public */ moveCursor: function(dir, amount) { @@ -311,7 +311,7 @@ * Inserts HTML at the cursor position. HTML will be escaped unless the * [allowHtml]{@link enyo.RichText#allowHtml} property is `true`. * - * @param {String} val The HTML to insert at the current cursor position. + * @param {String} val - The HTML to insert at the current cursor position. * @public */ insertAtCursor: function(val) { diff --git a/source/ui/Select.js b/source/ui/Select.js index 8a0f5a9eb..14d58a88f 100644 --- a/source/ui/Select.js +++ b/source/ui/Select.js @@ -1,6 +1,6 @@ (function (enyo, scope) { /** - * {@link enyo.Select} implements an HTML [selection]{@glossary select} widget, using + * {@link enyo.Select} implements an HTML [selection]{@glossary select} widget, using * {@link enyo.Option} instances by default. * * ``` diff --git a/source/ui/Selection.js b/source/ui/Selection.js index dc37cdf2d..31da98cf4 100644 --- a/source/ui/Selection.js +++ b/source/ui/Selection.js @@ -1,13 +1,13 @@ (function (enyo, scope) { /** * The extended {@glossary event} [object]{@glossary Object} that is provided - * when the [onSelect]{@link enyo.Selection#event:onSelect} and - * [onDeselect]{@link enyo.Selection#event:onDeselect} events are fired. + * when the [onSelect]{@link enyo.Selection#onSelect} and + * [onDeselect]{@link enyo.Selection#onDeselect} events are fired. * * @typedef {Object} enyo.Selection~SelectionEvent * @property {Number|String} key The key that was used to register the * [selection]{@link enyo.Selection} (usually a row index). - * @property {Object} data References data registered with the key by the code + * @property {Object} data - References data registered with the key by the code * that made the original selection. */ @@ -21,7 +21,7 @@ * ... * ``` * - * @event enyo.Selection#event:onSelect + * @event enyo.Selection#onSelect * @type {Object} * @property {Object} sender - The [component]{@link enyo.Component} that most recently * propagated the {@glossary event}. @@ -40,7 +40,7 @@ * ... * ``` * - * @event enyo.Selection#event:onDeselect + * @event enyo.Selection#onDeselect * @type {Object} * @property {Object} sender - The [component]{@link enyo.Component} that most recently * propagated the {@glossary event}. @@ -52,7 +52,7 @@ /** * Fires when selection changes (but not when selection is cleared). * - * @event enyo.Selection#event:onChange + * @event enyo.Selection#onChange * @type {Object} * @property {Object} sender - The [component]{@link enyo.Component} that most recently * propagated the {@glossary event}. @@ -172,7 +172,7 @@ /** * Determines whether a particular row is selected. * - * @param {Number|String} key The unique identifier of the row. + * @param {Number|String} key - The unique identifier of the row. * @returns {Boolean} `true` if the specified row is selected; otherwise, `false`. * @public */ @@ -183,15 +183,15 @@ /** * Manually sets a row's state to selected or unselected. * - * @param {Number|String} key The unique identifier of the row. - * @param {Boolean} sel `true` if the row should be selected; `false` if the row + * @param {Number|String} key - The unique identifier of the row. + * @param {Boolean} sel - `true` if the row should be selected; `false` if the row * should be unselected. - * @param {Object} [data] An optional data [object]{@glossary Object} to store + * @param {Object} [data] - An optional data [object]{@glossary Object} to store * in the selection for the key that will be sent with the - * [onSelect]{@link enyo.Selection#event:onSelect} or - * [onDeselect]{@link enyo.Selection#event:onDeselect} {@glossary event}. If + * [onSelect]{@link enyo.Selection#onSelect} or + * [onDeselect]{@link enyo.Selection#onDeselect} {@glossary event}. If * not used, the `data` will be set to `true`. - * @fires enyo.Selection#event:onChange + * @fires enyo.Selection#onChange * @public */ setByKey: function(key, sel, data) { @@ -210,7 +210,7 @@ /** * Deselects a row. * - * @param {Number|String} key The unique identifier of the row. + * @param {Number|String} key - The unique identifier of the row. * @public */ deselect: function(key) { @@ -223,11 +223,11 @@ * Selects a row. If the [multi]{@link enyo.Selection#multi} property is set to `false`, * this will also deselect the previous [selection]{@link enyo.Selection}. * - * @param {Number|String} key The unique identifier of the row. - * @param {Object} [data] An optional data [object]{@glossary Object} to store + * @param {Number|String} key - The unique identifier of the row. + * @param {Object} [data] - An optional data [object]{@glossary Object} to store * in the selection for the key that will be sent with the - * [onSelect]{@link enyo.Selection#event:onSelect} or - * [onDeselect]{@link enyo.Selection#event:onDeselect} {@glossary event}. If + * [onSelect]{@link enyo.Selection#onSelect} or + * [onDeselect]{@link enyo.Selection#onDeselect} {@glossary event}. If * not used, the `data` will be set to `true`. * @public */ @@ -245,11 +245,11 @@ * [multi]{@link enyo.Selection#multi} property is set to `false`, toggling a * selection "on" will deselect the previous selection. * - * @param {Number|String} key The unique identifier of the row. - * @param {Object} [data] An optional data [object]{@glossary Object} to store + * @param {Number|String} key - The unique identifier of the row. + * @param {Object} [data] - An optional data [object]{@glossary Object} to store * in the selection for the key that will be sent with the - * [onSelect]{@link enyo.Selection#event:onSelect} or - * [onDeselect]{@link enyo.Selection#event:onDeselect} {@glossary event}. If + * [onSelect]{@link enyo.Selection#onSelect} or + * [onDeselect]{@link enyo.Selection#onDeselect} {@glossary event}. If * not used, the `data` will be set to `true`. * @public */ @@ -270,15 +270,13 @@ getSelected: function() { return this.selected; }, - /** - - */ + /** * Removes a row that's included in the [selection]{@link enyo.Selection} set. * If this row is selected, it will be unselected. Any rows above this row * will have their keys value reduced by one. * - * @param {Number|String} key The unique identifier of the row. + * @param {Number|String} key - The unique identifier of the row. * @public */ remove: function(key) { diff --git a/source/ui/TextArea.js b/source/ui/TextArea.js index 13ce01321..b6e3ddbae 100644 --- a/source/ui/TextArea.js +++ b/source/ui/TextArea.js @@ -2,7 +2,7 @@ /** * {@link enyo.TextArea} implements an HTML [<textarea>]{@glossary textarea} * element with cross-platform support for change [events]{@glossary event}. - * + * * For more information, see the documentation on * [Text Fields]{@link building-apps/controls/text-fields.html} in the Enyo Developer Guide. * diff --git a/source/ui/Video.js b/source/ui/Video.js index c58512b00..fd7a86fd5 100644 --- a/source/ui/Video.js +++ b/source/ui/Video.js @@ -1,9 +1,8 @@ (function (enyo, scope) { /** - * Fires when [playbackRate]{@link enyo.Video#playbackRate} is changed to an integer greater than - * `1`. + * Fires when [playbackRate]{@link enyo.Video#playbackRate} is changed to an integer greater than `1`. * - * @event enyo.Video#event:onFastforward + * @event enyo.Video#onFastforward * @type {Object} * @property {Object} sender - The [component]{@link enyo.Component} that most recently * propagated the {@glossary event}. @@ -12,10 +11,9 @@ */ /** - * Fires when [playbackRate]{@link enyo.Video#playbackRate} is changed to a value between `0` and - * `1`. + * Fires when [playbackRate]{@link enyo.Video#playbackRate} is changed to a value between `0` and `1`. * - * @event enyo.Video#event:onSlowforward + * @event enyo.Video#onSlowforward * @type {Object} * @property {Object} sender - The [component]{@link enyo.Component} that most recently * propagated the {@glossary event}. @@ -24,10 +22,9 @@ */ /** - * Fires when [playbackRate]{@link enyo.Video#playbackRate} is changed to an integer less than - * `-1`. + * Fires when [playbackRate]{@link enyo.Video#playbackRate} is changed to an integer less than `-1`. * - * @event enyo.Video#event:onRewind + * @event enyo.Video#onRewind * @type {Object} * @property {Object} sender - The [component]{@link enyo.Component} that most recently * propagated the {@glossary event}. @@ -39,7 +36,7 @@ * Fires when [playbackRate]{@link enyo.Video#playbackRate} is changed to a value less than `0` * but greater than or equal to `-1`. * - * @event enyo.Video#event:onSlowrewind + * @event enyo.Video#onSlowrewind * @type {Object} * @property {Object} sender - The [component]{@link enyo.Component} that most recently * propagated the {@glossary event}. @@ -50,7 +47,7 @@ /** * Fires when [jumpForward()]{@link enyo.Video#jumpForward} is called. * - * @event enyo.Video#event:onJumpForward + * @event enyo.Video#onJumpForward * @type {Object} * @property {Object} sender - The [component]{@link enyo.Component} that most recently * propagated the {@glossary event}. @@ -61,7 +58,7 @@ /** * Fires when [jumpBackward()]{@link enyo.Video#jumpBackward} is called. * - * @event enyo.Video#event:onJumpBackward + * @event enyo.Video#onJumpBackward * @type {Object} * @property {Object} sender - The [component]{@link enyo.Component} that most recently * propagated the {@glossary event}. @@ -72,7 +69,7 @@ /** * Fires when EventData is changed. * - * @event enyo.Video#event:onPlay + * @event enyo.Video#onPlay * @type {Object} * @property {Object} sender - The [component]{@link enyo.Component} that most recently * propagated the {@glossary event}. @@ -83,7 +80,7 @@ /** * Fires when the [image]{@link enyo.Image} has loaded. * - * @event enyo.Video#event:onStart + * @event enyo.Video#onStart * @type {Object} * @property {Object} sender - The [component]{@link enyo.Component} that most recently * propagated the {@glossary event}. @@ -94,7 +91,7 @@ /** * {@link enyo.Video} is a [control]{@link enyo.Control} that allows you to play video. * It is an abstraction of HTML 5 [Video]{@glossary video}. - * + * * Initialize a video [component]{@link enyo.Component} as follows: * * ``` @@ -603,7 +600,7 @@ /** * Jumps backward [jumpSec]{@link enyo.Video#jumpSec} seconds from the current time. * - * @fires enyo.Video#event:doJumpBackward + * @fires enyo.Video#doJumpBackward * @public */ jumpBackward: function() { @@ -623,7 +620,7 @@ /** * Jumps forward [jumpSec]{@link enyo.Video#jumpSec} seconds from the current time. * - * @fires enyo.Video#event:doJumpForward + * @fires enyo.Video#doJumpForward * @public */ jumpForward: function() { @@ -682,7 +679,7 @@ * Sets the playback rate type (from the [keys]{@glossary Object.keys} of * [playbackRateHash]{@link enyo.Video#playbackRateHash}). * - * @param {String} cmd Key of the playback rate type. + * @param {String} cmd - Key of the playback rate type. * @public */ selectPlaybackRateArray: function(cmd) { @@ -693,7 +690,7 @@ * Changes [playbackRate]{@link enyo.Video#playbackRate} to a valid value when initiating * fast forward or rewind. * - * @param {Number} idx The index of the desired playback rate. + * @param {Number} idx - The index of the desired playback rate. * @public */ clampPlaybackRate: function(idx) { @@ -707,7 +704,7 @@ /** * Retrieves the playback rate name. * - * @param {Number} idx The index of the desired playback rate. + * @param {Number} idx - The index of the desired playback rate. * @returns {String} The playback rate name. * @public */ @@ -718,7 +715,7 @@ /** * Sets [playbackRate]{@link enyo.Video#playbackRate}. * - * @param {String} rate The desired playback rate. + * @param {String} rate - The desired playback rate. * @public */ setPlaybackRate: function(rate) { @@ -781,7 +778,7 @@ /** * Sets the current player position in the [video]{@link enyo.Video}. * - * @param {Number} time The position (in seconds) to which the player should be set. + * @param {Number} time - The position (in seconds) to which the player should be set. * @public */ setCurrentTime: function(time) { @@ -906,11 +903,11 @@ }, /** - * @fires enyo.Video#event:doSlowforward - * @fires enyo.Video#event:doFastforward - * @fires enyo.Video#event:doSlowrewind - * @fires enyo.Video#event:doRewind - * @fires enyo.Video#event:doPlay + * @fires enyo.Video#doSlowforward + * @fires enyo.Video#doFastforward + * @fires enyo.Video#doSlowrewind + * @fires enyo.Video#doRewind + * @fires enyo.Video#doPlay * @private */ ratechange: function(sender, e) { @@ -940,7 +937,7 @@ }, /** - * @fires enyo.Video#event:doStart + * @fires enyo.Video#doStart * @private */ createEventData: function() { @@ -963,7 +960,7 @@ /** * Normalizes Enyo-generated `onPlay` [events]{@glossary event}. * - * @fires enyo.Video#event:doPlay + * @fires enyo.Video#doPlay * @private */ _play: function(sender, e) { diff --git a/source/ui/data/DataGridList.js b/source/ui/data/DataGridList.js index ff0e11abd..e49292fc4 100644 --- a/source/ui/data/DataGridList.js +++ b/source/ui/data/DataGridList.js @@ -3,7 +3,7 @@ * {@link enyo.DataGridList} is a paginated {@link enyo.DataList} designed to lay out * its children in a grid. Like `enyo.DataList`, it links its children directly to the * underlying records in the collection specified as its collection. - * + * * Because the layout is arbitrarily handled, spacing of children must be set using * the kind's available API (e.g., with the [spacing]{@link enyo.DataGridList#spacing}, * [minWidth]{@link enyo.DataGridList#minWidth}, and @@ -112,7 +112,7 @@ var len = this.collection? this.collection.length: 0; if (this.$.scroller.generated && len && this.showing) { // avoid the default handler and call the event handler method - // designated by _enyo.DataList_ + // designated by `enyo.DataList` this.didResize(); } }; diff --git a/source/ui/data/DataList.js b/source/ui/data/DataList.js index 989ce6dbb..3e2952479 100644 --- a/source/ui/data/DataList.js +++ b/source/ui/data/DataList.js @@ -4,21 +4,21 @@ * [paging]{@link enyo.DataList#event:paging} event is fired. * * @typedef {Object} enyo.DataList~PagingEvent - * @property {Number} start The lowest active index in the dataset. - * @property {Number} end The highest active index. - * @property {String} action The action that triggered the paging, either `'scroll'` + * @property {Number} start - The lowest active index in the dataset. + * @property {Number} end - The highest active index. + * @property {String} action - The action that triggered the paging, either `'scroll'` * or `'reset'`. */ /** * Fires each time data is paged, on a per-page basis. * - * @event enyo.DataList#event:paging + * @event enyo.DataList#paging * @type {Object} * @property {Object} sender - A reference to the {@link enyo.DataList}. - * @property {String} nom The name of the {@glossary event}. + * @property {String} nom - The name of the {@glossary event}. * @property {enyo.DataList~PagingEvent} event - A [hash]{@glossary Object} with properties - * specific to the [paging]{@link enyo.DataList#event:paging} event. + * specific to the [paging]{@link enyo.DataList#paging} event. * @public */ @@ -37,7 +37,7 @@ * scrolling scheme to enhance performance with larger datasets. The data is provided to * the DataList by an {@link enyo.Collection} set as the value of its * [collection]{@link enyo.DataRepeater#data} property. - * + * * Note that care should be taken when deciding how to lay out the list's children. When * there are a large number of child [elements]{@link enyo.Control}, the layout process * can be taxing and non-performant for the browser. Avoid dynamically-updated @@ -82,7 +82,7 @@ scrollerOptions: null, /** - * The paging orientation. Valid values are `'vertical'` and `'horizontal'`. This property + * The paging orientation. Valid values are `'vertical'` and `'horizontal'`. This property * will be mapped to a particular strategy governing how the list will flow. * * @type {String} @@ -184,11 +184,11 @@ }, /** - * Pass in an integer within the bounds of the [list's]{@link enyo.DataList} + * Pass in an integer within the bounds of the [list's]{@link enyo.DataList} * [collection]{@link enyo.DataRepeater#data} to scroll to the position of that * index in the list. * - * @param {Number} idx The index in the [list's]{@link enyo.DataList} + * @param {Number} idx - The index in the [list's]{@link enyo.DataList} * [collection]{@link enyo.DataRepeater#data} to scroll to. * @public */ @@ -471,7 +471,7 @@ * requested index if its page is currently active. Returns `undefined` if the index is out * of bounds or if the [control]{@link enyo.Control} is not currently available. * - * Also see [getChildForIndex()]{@link enyo.Repeater#getChildForIndex}, which calls this + * Also see [getChildForIndex()]{@link enyo.Repeater#getChildForIndex}, which calls this * method. * * @private @@ -538,7 +538,7 @@ */ containerName: 'scroller', /** - * We have to trap the Enyo-generated [onScroll]{@link enyo.Scroller#event:onScroll} + * We have to trap the Enyo-generated [onScroll]{@link enyo.Scroller#onScroll} * {@glossary event} and let the [delegate]{@glossary delegate} handle it. We also * need to catch the `onresize` events so we know when to update our cached sizing. * We overload the default handler so that we don't @@ -558,9 +558,9 @@ /** * Adds the [RegisteredEventSupport]{@link enyo.RegisteredEventSupport} - * [mixin]{@glossary mixin} for the [paging]{@link enyo.DataList#event:paging} + * [mixin]{@glossary mixin} for the [paging]{@link enyo.DataList#paging} * {@glossary event}. - * + * * @private */ mixins: [enyo.RegisteredEventSupport], diff --git a/source/ui/data/DataRepeater.js b/source/ui/data/DataRepeater.js index f77399c0a..3282987ed 100644 --- a/source/ui/data/DataRepeater.js +++ b/source/ui/data/DataRepeater.js @@ -237,7 +237,7 @@ /** * Refreshes each [control]{@link enyo.Control} in the dataset. * - * @param {Boolean} immediate If `true`, refresh will occur immediately; otherwise, + * @param {Boolean} immediate - If `true`, refresh will occur immediately; otherwise, * it will be queued up as a job. * @public */ @@ -284,8 +284,8 @@ /** * Adds a [record]{@link enyo.Model} at a particular index. * - * @param {enyo.Model} rec The [record]{@link enyo.Model} to add. - * @param {Number} idx The index at which the record should be added. + * @param {enyo.Model} rec - The [record]{@link enyo.Model} to add. + * @param {Number} idx - The index at which the record should be added. * @public */ add: function (rec, idx) { @@ -298,7 +298,7 @@ /** * Removes the [record]{@link enyo.Model} at a particular index. * - * @param {Number} idx The index of the [record]{@link enyo.Model} to be removed. + * @param {Number} idx - The index of the [record]{@link enyo.Model} to be removed. * @public */ remove: function (idx) { @@ -450,7 +450,7 @@ /** * Calls [childForIndex()]{@link enyo.DataRepeater#getChildForIndex}. Leaving for posterity. * - * @param {Number} idx The index of the child to retrieve. + * @param {Number} idx - The index of the child to retrieve. * @returns {enyo.Control|undefined} The [control]{@link enyo.Control} at the specified * index, or `undefined` if it could not be found or the index is out of bounds. * @public @@ -462,7 +462,7 @@ /** * Attempts to return the [control]{@link enyo.Control} representation at a particular index. * - * @param {Number} idx The index of the child to retrieve. + * @param {Number} idx - The index of the child to retrieve. * @returns {enyo.Control|undefined} The [control]{@link enyo.Control} at the specified * index, or `undefined` if it could not be found or the index is out of bounds. * @public @@ -525,7 +525,7 @@ /** * Selects the item at the given index. * - * @param {Number} idx The index of the item to select. + * @param {Number} idx - The index of the item to select. * @public */ select: function (idx) { @@ -535,7 +535,7 @@ /** * Deselects the item at the given index. * - * @param {Number} idx The index of the item to deselect. + * @param {Number} idx - The index of the item to deselect. * @public */ deselect: function (idx) { @@ -545,7 +545,7 @@ /** * Determines whether a [model]{@link enyo.Model} is currently selected. * - * @param {enyo.Model} model The [model]{@link enyo.Model} whose selection status + * @param {enyo.Model} model - The [model]{@link enyo.Model} whose selection status * is to be determined. * @returns {Boolean} `true` if the given model is selected; otherwise, `false`. * @public diff --git a/source/ui/data/DataTable.js b/source/ui/data/DataTable.js index 8f54dd16d..f6789c908 100644 --- a/source/ui/data/DataTable.js +++ b/source/ui/data/DataTable.js @@ -1,6 +1,6 @@ (function (enyo, scope) { /** - * {@link enyo.DataTable} enables the creation of data-driven tables. + * {@link enyo.DataTable} enables the creation of data-driven tables. * Along with {@link enyo.Table}, this is a work in progress. * * @ui diff --git a/source/ui/data/VerticalDelegate.js b/source/ui/data/VerticalDelegate.js index 0c7b4075a..6242743a3 100644 --- a/source/ui/data/VerticalDelegate.js +++ b/source/ui/data/VerticalDelegate.js @@ -24,7 +24,7 @@ * Sets the priority properties for this orientation, which can then be customized by * other [delegates]{@glossary delegate} that wish to share basic functionality. * - * @param {enyo.DataList} list The [list]{@link enyo.DataList} to perform this action on. + * @param {enyo.DataList} list - The [list]{@link enyo.DataList} to perform this action on. * @private */ initList: function (list) { @@ -48,7 +48,7 @@ * Performs a hard reset of the [list's]{@link enyo.DataList} pages and children. * Scrolls to the top and resets each page's children to have the correct indices. * - * @param {enyo.DataList} list The [list]{@link enyo.DataList} to perform this action on. + * @param {enyo.DataList} list - The [list]{@link enyo.DataList} to perform this action on. * @private */ reset: function (list) { @@ -70,7 +70,7 @@ /** * Retrieves [list]{@link enyo.DataList} pages, indexed by their position. * - * @param {enyo.DataList} list The [list]{@link enyo.DataList} to perform this action on. + * @param {enyo.DataList} list - The [list]{@link enyo.DataList} to perform this action on. * @returns {Object} Returns a [hash]{@glossary Object} of the pages marked by their * position as either 'firstPage' or 'lastPage'. * @private @@ -94,7 +94,7 @@ * Refreshes each page in the given [list]{@link enyo.DataList}, adjusting its position * and adjusting the buffer accordingly. * - * @param {enyo.DataList} list The [list]{@link enyo.DataList} to perform this action on. + * @param {enyo.DataList} list - The [list]{@link enyo.DataList} to perform this action on. * @private */ refresh: function (list) { @@ -129,7 +129,7 @@ * [scroller]{@link enyo.Scroller} (so we know that is available). Now we need to * cache our initial size values and apply them to our pages individually. * - * @param {enyo.DataList} list The [list]{@link enyo.DataList} to perform this action on. + * @param {enyo.DataList} list - The [list]{@link enyo.DataList} to perform this action on. * @private */ rendered: function (list) { @@ -272,8 +272,8 @@ /** * Attempts to scroll to the given index. * - * @param {enyo.DataList} list The [list]{@link enyo.DataList} to perform this action on. - * @param {Number} i The index to scroll to. + * @param {enyo.DataList} list - The [list]{@link enyo.DataList} to perform this action on. + * @param {Number} i - The index to scroll to. * @private */ scrollToIndex: function (list, i) {