From a9a7c39540e196a4673775b6ec277a54b8436552 Mon Sep 17 00:00:00 2001
From: cash <cash.costello@gmail.com>
Date: Sat, 9 Feb 2013 12:10:19 -0500
Subject: cleaned up some coding standard issues

---
 engine/classes/ElggBatch.php        |  3 ++-
 engine/classes/ElggPriorityList.php | 23 +++++++++++++----------
 2 files changed, 15 insertions(+), 11 deletions(-)

(limited to 'engine/classes')

diff --git a/engine/classes/ElggBatch.php b/engine/classes/ElggBatch.php
index c1a77a0d9..5d59425d0 100644
--- a/engine/classes/ElggBatch.php
+++ b/engine/classes/ElggBatch.php
@@ -296,7 +296,8 @@ class ElggBatch
 	 * Increment the offset from the original options array? Setting to
 	 * false is required for callbacks that delete rows.
 	 *
-	 * @param bool $increment
+	 * @param bool $increment Set to false when deleting data
+	 * @return void
 	 */
 	public function setIncrementOffset($increment = true) {
 		$this->incrementOffset = (bool) $increment;
diff --git a/engine/classes/ElggPriorityList.php b/engine/classes/ElggPriorityList.php
index 8a3b836a8..b5f8fe163 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,10 +165,10 @@ 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;
@@ -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) {
-- 
cgit v1.2.3