From 6c70ca11be3ce8026c69cfc9b7887efcd591acf3 Mon Sep 17 00:00:00 2001
From: Ray Greenwell <ray@threerings.net>
Date: Mon, 4 Feb 2008 21:02:42 +0000
Subject: [PATCH] Commenting improvements.

git-svn-id: svn+ssh://src.earth.threerings.net/narya/trunk@4930 542714f4-19e9-0310-aa3c-eee0fc999fb1
---
 src/as/com/threerings/util/ArrayUtil.as | 16 +++++++++++++++-
 1 file changed, 15 insertions(+), 1 deletion(-)

diff --git a/src/as/com/threerings/util/ArrayUtil.as b/src/as/com/threerings/util/ArrayUtil.as
index af840f122..5e153fa4e 100644
--- a/src/as/com/threerings/util/ArrayUtil.as
+++ b/src/as/com/threerings/util/ArrayUtil.as
@@ -26,7 +26,7 @@ package com.threerings.util {
  * contains methods that understand the interfaces in this package.
  * So, for example, removeFirst() understands Equalable and will remove
  * an element that is equals() to the specified element, rather than just
- * ===.
+ * === (strictly equals) to the specified element.
  */
 public class ArrayUtil
 {
@@ -75,6 +75,8 @@ public class ArrayUtil
      * Returns the index of the first item in the array for which the predicate function
      * returns true, or -1 if no such item was found. The predicate function should be of type:
      *   function (element :*) :Boolean { }
+     *
+     * @return the zero-based index of the matching element, or -1 if none found.
      */
     public static function indexIf (arr :Array, predicate :Function) :int
     {
@@ -88,6 +90,14 @@ public class ArrayUtil
         return -1; // never found
     }
 
+    /**
+     * Returns the first index of the supplied element in the array. Note that if the element
+     * implements Equalable, an element that is equals() will have its index returned, instead
+     * of requiring the search element to be === (strictly equal) to an element in the array
+     * like Array.indexOf().
+     *
+     * @return the zero-based index of the matching element, or -1 if none found.
+     */
     public static function indexOf (arr :Array, element :Object) :int
     {
         if (arr != null) {
@@ -100,6 +110,10 @@ public class ArrayUtil
         return -1; // never found
     }
 
+    /**
+     * @return true if the specified element, or one that is Equalable.equals() to it, is
+     * contained in the array.
+     */
     public static function contains (arr :Array, element :Object) :Boolean
     {
         return (indexOf(arr, element) != -1);