From da7bdcfba09e4fef4ebee8f77773d7a188049c4e Mon Sep 17 00:00:00 2001
From: hns <hannesw@gmail.com>
Date: Fri, 9 Feb 2007 10:04:48 +0000
Subject: [PATCH] * Add @fileoverview JSDoc comment * 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

---
 core/Array.js | 111 +++++++++++++++++++++++++-------------------------
 1 file changed, 56 insertions(+), 55 deletions(-)

diff --git a/core/Array.js b/core/Array.js
index cefc2e15..41b30f7f 100644
--- a/core/Array.js
+++ b/core/Array.js
@@ -10,15 +10,63 @@
  *
  * $RCSfile: Array.js,v $
  * $Author: czv $
- * $Revision: 1.5 $
- * $Date: 2006/04/18 13:06:58 $
+ * $Revision: 1.2 $
+ * $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
- * @param Array (Array2, ...) the arrays to unify
- * @return Array the union set
+ * return the last 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.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() {
    var result = [];
@@ -35,11 +83,10 @@ Array.union = function() {
    return result;
 };
 
-
 /**
- * retrieve the intersection set of a bunch of arrays
- * @param Array (Array2, ...) the arrays to intersect
- * @return Array the intersection set
+ * Retrieve the intersection set of a bunch of arrays
+ * @param {Array} array1,... the arrays to intersect
+ * @return {Array} the intersection set
  */
 Array.intersection = function() {
    var all = Array.union.apply(this, arguments);
@@ -59,52 +106,6 @@ Array.intersection = function() {
    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
 for (var i in Array)
    Array.dontEnum(i);