From b5644ed952a23c47cd20ff3765a042f83a5a80a4 Mon Sep 17 00:00:00 2001 From: Ryan Grove Date: Wed, 27 Jul 2011 21:28:56 -0700 Subject: [PATCH] API doc and metadata fixes. No code changes. --- src/app/js/view.js | 6 +++--- src/dump/js/dump.js | 18 +++++------------- src/get/docs/component.json | 2 +- src/oop/js/oop.js | 20 ++++++-------------- src/yui/docs/component.json | 2 +- src/yui/js/yui-lang.js | 3 ++- 6 files changed, 18 insertions(+), 33 deletions(-) diff --git a/src/app/js/view.js b/src/app/js/view.js index 6c573912782..e8920187424 100644 --- a/src/app/js/view.js +++ b/src/app/js/view.js @@ -53,7 +53,7 @@ Y.View = Y.extend(View, Y.Base, { @property container @type HTMLElement|Node|String - @default `"
"` + @default "
" **/ container: '
', @@ -94,7 +94,7 @@ Y.View = Y.extend(View, Y.Base, { @property events @type Object - @default `{}` + @default {} **/ events: {}, @@ -137,7 +137,7 @@ Y.View = Y.extend(View, Y.Base, { @property template @type any - @default `''` + @default '' **/ template: '', diff --git a/src/dump/js/dump.js b/src/dump/js/dump.js index 54992bfcda1..d67996b255a 100644 --- a/src/dump/js/dump.js +++ b/src/dump/js/dump.js @@ -15,24 +15,16 @@ COMMA = ', ', ARROW = ' => ', - /** - * The following methods are added to the YUI instance - * @class YUI~dump - */ - /** * Returns a simple string representation of the object or array. * Other types of objects will be returned unprocessed. Arrays - * are expected to be indexed. Use object notation for - * associative arrays. - * - * This method is in the 'dump' module, which is not bundled with - * the core YUI object + * are expected to be indexed. * * @method dump - * @param {object} o The object to dump. - * @param {int} d How deep to recurse child objects, default 3. - * @return {string} the dump result. + * @param {Object} o The object to dump. + * @param {Number} d How deep to recurse child objects, default 3. + * @return {String} the dump result. + * @for YUI */ dump = function(o, d) { var i, len, s = [], type = L.type(o); diff --git a/src/get/docs/component.json b/src/get/docs/component.json index 1648dbd3987..915a3a36766 100644 --- a/src/get/docs/component.json +++ b/src/get/docs/component.json @@ -1,6 +1,6 @@ { "name" : "get", - "displayName": "Get Utility", + "displayName": "Get", "description": "Asynchronous JavaScript and CSS file loader.", "author" : ["adam", "rgrove"], diff --git a/src/oop/js/oop.js b/src/oop/js/oop.js index 13e19f0fb47..9bd09360d6a 100644 --- a/src/oop/js/oop.js +++ b/src/oop/js/oop.js @@ -1,19 +1,10 @@ /** -Supplies object inheritance and manipulation utilities. - -This adds additional functionaity to what is provided in `yui-base`, and the -methods are applied directly to the YUI instance. This module is required for -most YUI components. +Adds object inheritance and manipulation utilities to the YUI instance. This +module is required by most YUI components. @module oop **/ -/** -These methods are added to the YUI instance by the `oop` module. - -@class YUI~oop -**/ - var L = Y.Lang, A = Y.Array, OP = Object.prototype, @@ -71,6 +62,7 @@ hit of calling the _supplier_'s constructor. @param {Array|any} [args] Argument or array of arguments to pass to the supplier's constructor when initializing. @return {Function} Augmented object. +@for YUI **/ Y.augment = function (receiver, supplier, overwrite, whitelist, args) { var rProto = receiver.prototype, @@ -204,7 +196,7 @@ Y.extend = function(r, s, px, sx) { /** * Executes the supplied function for each item in * a collection. Supports arrays, objects, and - * Y.NodeLists + * NodeLists * @method each * @param {object} o the object to iterate. * @param {function} f the function to execute. This function @@ -222,7 +214,7 @@ Y.each = function(o, f, c, proto) { * Executes the supplied function for each item in * a collection. The operation stops if the function * returns true. Supports arrays, objects, and - * Y.NodeLists. + * NodeLists. * @method some * @param {object} o the object to iterate. * @param {function} f the function to execute. This function @@ -238,7 +230,7 @@ Y.some = function(o, f, c, proto) { }; /** - * Deep obj/array copy. Function clones are actually + * Deep object/array copy. Function clones are actually * wrappers around the original function. * Array-like objects are treated as arrays. * Primitives are returned untouched. Optionally, a diff --git a/src/yui/docs/component.json b/src/yui/docs/component.json index 78c9c919b16..c8b81eec95c 100644 --- a/src/yui/docs/component.json +++ b/src/yui/docs/component.json @@ -4,7 +4,7 @@ "description": "The YUI module is the single core dependency for all YUI 3.x implementations. It must be included on all pages that use YUI — and it is the only dependency required to start writing YUI code. The YUI module contains loader functionality and a dependency calculator, allowing it to serve as a `seed` for your implementation. You provide the YUI module list you're using and the code that makes use of those modules; YUI will fetch all necessary components in a single, optimized HTTP request before executing your dependent code. While you may use some of the script- and CSS-loading facilities of the YUI module in your own implementation, this module's core purpose is to serve as a small seed from which complex, highly modular implementations can grow.", "author" : [ "davglass", "rgrove" ], - "tags": ["utility", "core"], + "tags": ["core"], "examples": [ { diff --git a/src/yui/js/yui-lang.js b/src/yui/js/yui-lang.js index ff8c46d5b8c..ed11408452e 100644 --- a/src/yui/js/yui-lang.js +++ b/src/yui/js/yui-lang.js @@ -283,7 +283,8 @@ L.sub = function(s, o) { * Returns the current time in milliseconds. * * @method now - * @return {int} Current time in milliseconds. + * @return {Number} Current time in milliseconds. + * @static * @since 3.3.0 */ L.now = Date.now || function () {