From dbebcadbc14737ccd151e3225b0a2deede14b5ff Mon Sep 17 00:00:00 2001
From: brettp <brettp@36083f99-b078-4883-b0ff-0f9b5a30f544>
Date: Tue, 15 Mar 2011 04:40:37 +0000
Subject: Refs #2538: Added documentation to most of the JS methods missing it.

git-svn-id: http://code.elgg.org/elgg/trunk@8717 36083f99-b078-4883-b0ff-0f9b5a30f544
---
 js/lib/prototypes.js | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

(limited to 'js/lib/prototypes.js')

diff --git a/js/lib/prototypes.js b/js/lib/prototypes.js
index 0f0014818..cb6184097 100644
--- a/js/lib/prototypes.js
+++ b/js/lib/prototypes.js
@@ -1,5 +1,14 @@
 /**
+ * Interates through each element of an array and calls a callback function.
+ * The callback should accept the following arguments:
+ *	element - The current element
+ *	index	- The current index
  *
+ * This is different to Array.forEach in that if the callback returns false, the loop returns
+ * immediately without processing the remaining elements.
+ *
+ *	@param {Function} callback
+ *	@return {Bool}
  */
 if (!Array.prototype.every) {
 	Array.prototype.every = function(callback) {
@@ -16,7 +25,16 @@ if (!Array.prototype.every) {
 }
 
 /**
+ * Interates through each element of an array and calls callback a function.
+ * The callback should accept the following arguments:
+ *	element - The current element
+ *	index	- The current index
+ *
+ * This is different to Array.every in that the callback's return value is ignored and every
+ * element of the array will be parsed.
  *
+ *	@param {Function} callback
+ *	@return {Void}
  */
 if (!Array.prototype.forEach) {
 	Array.prototype.forEach = function(callback) {
@@ -31,7 +49,11 @@ if (!Array.prototype.forEach) {
 }
 
 /**
+ * Left trim
  *
+ * Removes a character from the left side of a string.
+ * @param {String} str The character to remove
+ * @return {String}
  */
 if (!String.prototype.ltrim) {
 	String.prototype.ltrim = function(str) {
-- 
cgit v1.2.3