antville/helma
antville/helma
1
1
Fork 0
Code Issues 5 Pull requests 7 Projects Releases 5 Activity Actions

* Add @fileoverview JSDoc comment

Browse source 
* Move static methods down to the bottom of the file to circumvent
  a strange bug that prevents documentation from being generated.
* Some JSDoc comment fixes
This commit is contained in:
hns 2007-02-09 10:04:48 +00:00
parent fc7f7bab1a
commit da7bdcfba0
1 changed files with 56 additions and 55 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

111
core/Array.js
View file

@ -10,15 +10,63 @@
* *
* $RCSfile: Array.js,v $ * $RCSfile: Array.js,v $
* $Author: czv $ * $Author: czv $
* $Revision: 1.5 $ * $Revision: 1.2 $
* $Date: 2006/04/18 13:06:58 $ * $Date: 2006/04/24 07:02:17 $
*/ */
/**
* @fileoverview Adds useful methods to the JavaScript Array type.
* @addon
*/
/**
* Return the first index position of a value
* contained in an array, or -1 if it isn't contained.
* @param {Object} val the value to check
* @return {int} the index of the first occurence of val, or -1
*/
Array.prototype.indexOf = function(val) {
var i = -1;
while (i++ < this.length -1) {
if (this[i] == val)
return i;
}
return -1;
};
/** /**
* retrieve the union set of a bunch of arrays * return the last index position of a value
* @param Array (Array2, ...) the arrays to unify * contained in an array, or -1 if it isn't contained.
* @return Array the union set * @param {Object} val the value to check
* @return {int} the index of the first occurence of val, or -1
*/
Array.prototype.lastIndexOf = function(val) {
var i = 1;
while (this.length - i++ >= 0) {
if (this[i] == val)
return i;
}
return -1;
};
/**
* check if an array passed as argument contains
* a specific value (start from end of array)
* @param {Object} val the value to check
* @return {boolean} true if the value is contained
*/
Array.prototype.contains = function(val) {
if (this.indexOf(val) > -1)
return true;
return false;
};
/**
* Retrieve the union set of a bunch of arrays
* @param {Array} array1,... the arrays to unify
* @return {Array} the union set
*/ */
Array.union = function() { Array.union = function() {
var result = []; var result = [];
@ -35,11 +83,10 @@ Array.union = function() {
return result; return result;
}; };
/** /**
* retrieve the intersection set of a bunch of arrays * Retrieve the intersection set of a bunch of arrays
* @param Array (Array2, ...) the arrays to intersect * @param {Array} array1,... the arrays to intersect
* @return Array the intersection set * @return {Array} the intersection set
*/ */
Array.intersection = function() { Array.intersection = function() {
var all = Array.union.apply(this, arguments); var all = Array.union.apply(this, arguments);
@ -59,52 +106,6 @@ Array.intersection = function() {
return result; return result;
}; };
/**
* return the first index position of a value
* contained in an array
* @param Object Array to use for checking
* @param String|Object the String or Object to check
*/
Array.prototype.indexOf = function(val) {
var i = -1;
while (i++ < this.length -1) {
if (this[i] == val)
return i;
}
return -1;
};
/**
* return the last index position of a value
* contained in an array
* @param Object Array to use for checking
* @param String|Object the String or Object to check
*/
Array.prototype.lastIndexOf = function(val) {
var i = 1;
while (this.length - i++ >= 0) {
if (this[i] == val)
return i;
}
return -1;
};
/**
* check if an array passed as argument contains
* a specific value (start from end of array)
* @param Object Array to use for checking
* @param String|Object the String or Object to check
*/
Array.prototype.contains = function(val) {
if (this.indexOf(val) > -1)
return true;
return false;
};
// prevent any newly added properties from being enumerated // prevent any newly added properties from being enumerated
for (var i in Array) for (var i in Array)
Array.dontEnum(i); Array.dontEnum(i);