1 files changed, 21 insertions, 13 deletions

diff --git a/engine/classes/ElggPriorityList.php b/engine/classes/ElggPriorityList.php
index 17ce228bc..416df885c 100644
--- a/engine/classes/ElggPriorityList.php
+++ b/engine/classes/ElggPriorityList.php
@@ -89,7 +89,7 @@
  *	return true;
  * }
  *
- * @package Elgg.Core
+ * @package    Elgg.Core
  * @subpackage Helpers
  */
 class ElggPriorityList
@@ -126,7 +126,9 @@ class ElggPriorityList
 	 *                        maintains its priority and the new element is to the next available
 	 *                        slot, taking into consideration all previously registered elements.
 	 *                        Negative elements are accepted.
+	 * @param bool  $exact    unused
 	 * @return int            The priority of the added element.
+	 * @todo remove $exact or implement it. Note we use variable name strict below.
 	 */
 	public function add($element, $priority = null, $exact = false) {
 		if ($priority !== null && !is_numeric($priority)) {
@@ -146,7 +148,8 @@ class ElggPriorityList
 	 * @warning The element must have the same attributes / values. If using $strict, it must have
 	 *          the same types. array(10) will fail in strict against array('10') (str vs int).
 	 *
-	 * @param type $element
+	 * @param mixed $element The element to remove from the list
+	 * @param bool  $strict  Whether to check the type of the element match
 	 * @return bool
 	 */
 	public function remove($element, $strict = false) {
@@ -162,16 +165,16 @@ class ElggPriorityList
 	/**
 	 * Move an existing element to a new priority.
 	 *
-	 * @param mixed  $current_priority
-	 * @param int    $new_priority
-	 *
-	 * @return int The new priority.
+	 * @param mixed $element      The element to move
+	 * @param int   $new_priority The new priority for the element
+	 * @param bool  $strict       Whether to check the type of the element match
+	 * @return bool
 	 */
 	public function move($element, $new_priority, $strict = false) {
 		$new_priority = (int) $new_priority;
 		
 		$current_priority = $this->getPriority($element, $strict);
-		if (!$current_priority) {
+		if ($current_priority === false) {
 			return false;
 		}
 
@@ -200,12 +203,12 @@ class ElggPriorityList
 	 *
 	 * If no user function is provided the elements are sorted by priority registered.
 	 *
-	 * The callback function should accept the array of elements as the first argument and should
-	 * return a sorted array.
+	 * The callback function should accept the array of elements as the first 
+	 * argument and should return a sorted array.
 	 *
 	 * This function can be called multiple times.
 	 *
-	 * @param type $callback
+	 * @param callback $callback The callback for sorting. Numeric sorting is the default.
 	 * @return bool
 	 */
 	public function sort($callback = null) {
@@ -268,7 +271,7 @@ class ElggPriorityList
 	/**
 	 * Returns the element at $priority.
 	 *
-	 * @param int $priority
+	 * @param int $priority The priority
 	 * @return mixed The element or false on fail.
 	 */
 	public function getElement($priority) {
@@ -303,7 +306,7 @@ class ElggPriorityList
 	 */
 	public function rewind() {
 		$this->sortIfUnsorted();
-		return rewind($this->elements);
+		return reset($this->elements);
 	}
 
 	/**
@@ -351,7 +354,12 @@ class ElggPriorityList
 		return ($key !== NULL && $key !== FALSE);
 	}
 
-	// Countable
+	/**
+	 * Countable interface
+	 *
+	 * @see Countable::count()
+	 * @return int
+	 */
 	public function count() {
 		return count($this->elements);
 	}