Skip to content

Commit

Permalink
API doc and metadata fixes. No code changes.
Browse files Browse the repository at this point in the history
  • Loading branch information
rgrove committed Jul 28, 2011
1 parent 77c61f4 commit b5644ed
Show file tree
Hide file tree
Showing 6 changed files with 18 additions and 33 deletions.
6 changes: 3 additions & 3 deletions src/app/js/view.js
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ Y.View = Y.extend(View, Y.Base, {
@property container
@type HTMLElement|Node|String
@default `"<div/>"`
@default "<div/>"
**/
container: '<div/>',

Expand Down Expand Up @@ -94,7 +94,7 @@ Y.View = Y.extend(View, Y.Base, {
@property events
@type Object
@default `{}`
@default {}
**/
events: {},

Expand Down Expand Up @@ -137,7 +137,7 @@ Y.View = Y.extend(View, Y.Base, {
@property template
@type any
@default `''`
@default ''
**/
template: '',

Expand Down
18 changes: 5 additions & 13 deletions src/dump/js/dump.js
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand Down
2 changes: 1 addition & 1 deletion src/get/docs/component.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name" : "get",
"displayName": "Get Utility",
"displayName": "Get",
"description": "Asynchronous JavaScript and CSS file loader.",
"author" : ["adam", "rgrove"],

Expand Down
20 changes: 6 additions & 14 deletions src/oop/js/oop.js
Original file line number Diff line number Diff line change
@@ -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,
Expand Down Expand Up @@ -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,
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/yui/docs/component.json
Original file line number Diff line number Diff line change
Expand Up @@ -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 &mdash; 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": [
{
Expand Down
3 changes: 2 additions & 1 deletion src/yui/js/yui-lang.js
Original file line number Diff line number Diff line change
Expand Up @@ -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 () {
Expand Down

0 comments on commit b5644ed

Please sign in to comment.