coding standards fixes - comments

7 files changed, 21 insertions, 21 deletions

diff --git a/engine/lib/access.php b/engine/lib/access.php
index 7be92fbfc..dba1e1ec6 100644
--- a/engine/lib/access.php
+++ b/engine/lib/access.php
@@ -984,9 +984,9 @@ function elgg_override_permissions($hook, $type, $value, $params) {
 	}
 
 	// don't do this so ignore access still works with no one logged in
-//	if (!$user instanceof ElggUser) {
-//		return false;
-//	}
+	//if (!$user instanceof ElggUser) {
+	//	return false;
+	//}
 
 	// check for admin
 	if ($user_guid && elgg_is_admin_user($user_guid)) {
diff --git a/engine/lib/admin.php b/engine/lib/admin.php
index 1f085eee4..a573e79d6 100644
--- a/engine/lib/admin.php
+++ b/engine/lib/admin.php
@@ -179,10 +179,10 @@ function elgg_admin_notice_exists($id) {
  *
  * This function handles registering the parent if it has not been registered.
  *
- * @param string $section    The menu section to add to
- * @param string $menu_id    The unique ID of section
- * @param string $parent_id  If a child section, the parent section id
- * @param int    $priority   The menu item priority
+ * @param string $section   The menu section to add to
+ * @param string $menu_id   The unique ID of section
+ * @param string $parent_id If a child section, the parent section id
+ * @param int    $priority  The menu item priority
  *
  * @return bool
  * @since 1.8.0
diff --git a/engine/lib/database.php b/engine/lib/database.php
index c44fdf1fd..444bb7cc4 100644
--- a/engine/lib/database.php
+++ b/engine/lib/database.php
@@ -728,9 +728,9 @@ function sanitize_string($string) {
 /**
  * Sanitises an integer for database use.
  *
- * @param int $int Integer
- * @param bool[optional] $signed Whether negative values should be allowed (true)
- * @return int Sanitised integer
+ * @param int  $int    Value to be sanitized
+ * @param bool $signed Whether negative values should be allowed (true)
+ * @return int
  */
 function sanitise_int($int, $signed = true) {
 	$int = (int) $int;
@@ -745,12 +745,12 @@ function sanitise_int($int, $signed = true) {
 }
 
 /**
- * Sanitises an integer for database use.
+ * Sanitizes an integer for database use.
  * Wrapper function for alternate English spelling (@see sanitise_int)
  *
- * @param int $int Integer
- * @param bool[optional] $signed Whether negative values should be allowed (true)
- * @return int Sanitised integer
+ * @param int  $int    Value to be sanitized
+ * @param bool $signed Whether negative values should be allowed (true)
+ * @return int
  */
 function sanitize_int($int, $signed = true) {
 	return sanitise_int($int, $signed);
diff --git a/engine/lib/extender.php b/engine/lib/extender.php
index 51fc62c30..ffd3c1357 100644
--- a/engine/lib/extender.php
+++ b/engine/lib/extender.php
@@ -164,9 +164,9 @@ function can_edit_extender($extender_id, $type, $user_guid = 0) {
  * It is recommended that you do not call this directly, instead use
  * one of the wrapper functions such as elgg_register_annotation_url_handler().
  *
- * @param string $function_name The function to register
  * @param string $extender_type Extender type ('annotation', 'metadata')
  * @param string $extender_name The name of the extender
+ * @param string $function_name The function to register
  *
  * @return bool
  */
diff --git a/engine/lib/input.php b/engine/lib/input.php
index 57e35786f..dda8211b6 100644
--- a/engine/lib/input.php
+++ b/engine/lib/input.php
@@ -188,8 +188,8 @@ function elgg_get_sticky_value($form_name, $variable = '', $default = NULL, $fil
 /**
  * Get all the values in a sticky form in an array
  *
- * @param string $form_name    The name of the form
- * @param bool $filter_result  Filter for bad input if true
+ * @param string $form_name     The name of the form
+ * @param bool   $filter_result Filter for bad input if true
  *
  * @return array
  * @since 1.8.0
diff --git a/engine/lib/relationships.php b/engine/lib/relationships.php
index 5b7080b56..fabe2d2d6 100644
--- a/engine/lib/relationships.php
+++ b/engine/lib/relationships.php
@@ -399,8 +399,8 @@ function elgg_list_entities_from_relationship_count($options) {
 /**
  * Sets the URL handler for a particular relationship type
  *
- * @param string $function_name     The function to register
  * @param string $relationship_type The relationship type.
+ * @param string $function_name     The function to register
  *
  * @return bool Depending on success
  */
diff --git a/engine/lib/river.php b/engine/lib/river.php
index 63625878f..547d9495e 100644
--- a/engine/lib/river.php
+++ b/engine/lib/river.php
@@ -108,7 +108,7 @@ $posted = 0, $annotation_id = 0) {
  *
  * @warning not checking access (should we?)
  *
- * @param array $options
+ * @param array $options Parameters:
  *   ids                  => INT|ARR River item id(s)
  *   subject_guids        => INT|ARR Subject guid(s)
  *   object_guids         => INT|ARR Object guid(s)
@@ -215,7 +215,7 @@ function elgg_delete_river(array $options = array()) {
  *
  * @note If using types and subtypes in a query, they are joined with an AND.
  *
- * @param array $options
+ * @param array $options Parameters:
  *   ids                  => INT|ARR River item id(s)
  *   subject_guids        => INT|ARR Subject guid(s)
  *   object_guids         => INT|ARR Object guid(s)
@@ -548,7 +548,7 @@ function elgg_river_get_action_where_sql($types) {
 /**
  * Get the where clause based on river view strings
  *
- * @param array $types Array of view strings
+ * @param array $views Array of view strings
  *
  * @return string
  * @since 1.8.0