Added/corrected some PDoc.

This commit is contained in:
Andrew Dupont 2009-02-23 20:21:02 -06:00
parent 043653a282
commit c9df079839
4 changed files with 22 additions and 18 deletions

View File

@ -5,7 +5,8 @@
/**
* Date#toJSON -> String
*
* TODO: Date#toJSON
* Produces a string representation of the date in ISO 8601 format.
*
**/
Date.prototype.toJSON = function() {
return '"' + this.getUTCFullYear() + '-' +

View File

@ -29,8 +29,10 @@ var Enumerable = (function() {
/**
* Enumerable#eachSlice(number[, iterator = Prototype.K[, context]]) -> Enumerable
*
* TODO: Enumerable#eachSlice
* http://prototypejs.org/api/enumerable#method-eachslice
* Groups items into chunks of the given size.
* The final "slice" may have fewer than `number` items; it won't "pad" the
* last group with empty values. For that behavior, use
* [[Enumerable#inGroupsOf]].
**/
function eachSlice(number, iterator, context) {
var index = -number, slices = [], array = this.toArray();
@ -343,7 +345,7 @@ var Enumerable = (function() {
/** related to: Object.inspect
* Enumerable#inspect() -> String
*
* TODO: Enumerable#inspect
* Returns the debug-oriented string representation of the object.
**/
function inspect() {
return '#<Enumerable:' + this.toArray().inspect() + '>';

View File

@ -16,7 +16,8 @@ var Hash = Class.create(Enumerable, (function() {
/**
* new Hash([object])
*
* TODO: new Hash
* Creates a new `Hash`. If `object` is given, the new hash will be populated
* with all the object's properties. See [[$H]].
**/
function initialize(object) {
this._object = Object.isHash(object) ? object.toObject() : Object.clone(object);
@ -92,7 +93,8 @@ var Hash = Class.create(Enumerable, (function() {
/**
* Hash#index(value) -> String
*
* TODO: Hash#index
* Returns the first key in the hash whose value matches `value`.
* Returns `false` if there is no such key.
**/
function index(value) {
var match = this.detect(function(pair) {
@ -104,9 +106,9 @@ var Hash = Class.create(Enumerable, (function() {
/**
* Hash#merge(object) -> Hash
*
* Merges `object` to hash and returns the result of that merge.
* Prior to v1.6.0: This was destructive (object's values were added to hash).
* Since v1.6.0: This is no longer destructive (hash is cloned before the operation).
* Returns a new hash with `object`'s key/value pairs merged in.
* To modify the original hash in place, use [[Hash#update]].
*
**/
function merge(object) {
return this.clone().update(object);
@ -116,7 +118,8 @@ var Hash = Class.create(Enumerable, (function() {
* Hash#update(object) -> Hash
*
* Updates hash with the key/value pairs of `object`.
* The original hash will be modified.
* The original hash will be modified. To return a new hash instead, use
* [[Hash#merge]].
**/
function update(object) {
return new Hash(object).inject(this, function(result, pair) {
@ -125,11 +128,7 @@ var Hash = Class.create(Enumerable, (function() {
});
}
/**
* Hash#toQueryPair(key, value) -> String
*
* TODO: Hash#toQueryPair
**/
// Private. No PDoc necessary.
function toQueryPair(key, value) {
if (Object.isUndefined(value)) return key;
return key + '=' + encodeURIComponent(String.interpret(value));
@ -173,7 +172,7 @@ var Hash = Class.create(Enumerable, (function() {
}
/**
* Hash#clone() -> newHash
* Hash#clone() -> Hash
*
* Returns a clone of hash.
**/

View File

@ -26,7 +26,9 @@ Object.extend(Number.prototype, (function() {
/**
* Number#times(iterator) -> Number
*
* Encapsulates a regular [0..n[ loop, Ruby-style.
* Calls `iterator` the specified number of times.
* The function takes an integer as the first parameter; it will start at 0
* and be incremented after each invocation.
**/
function times(iterator, context) {
$R(0, this, true).each(iterator, context);
@ -48,7 +50,7 @@ Object.extend(Number.prototype, (function() {
/** related to: Object.toJSON
* Number#toJSON() -> String
*
* Returns a JSON string.
* Returns a JSON string representation of the number.
**/
function toJSON() {
return isFinite(this) ? this.toString() : 'null';