coding standards fixes - comments

6 files changed, 25 insertions, 22 deletions

diff --git a/engine/classes/ElggCache.php b/engine/classes/ElggCache.php
index dd53525b8..4317f4be9 100644
--- a/engine/classes/ElggCache.php
+++ b/engine/classes/ElggCache.php
@@ -191,8 +191,8 @@ abstract class ElggCache implements ArrayAccess {
 	 *
 	 * @see ArrayAccess::offsetSet()
 	 *
-	 * @param mixed $key    The key (offset) to assign the value to.
-	 * @param mixed $value  The value to set.
+	 * @param mixed $key   The key (offset) to assign the value to.
+	 * @param mixed $value The value to set.
 	 *
 	 * @return void
 	 */
@@ -205,7 +205,7 @@ abstract class ElggCache implements ArrayAccess {
 	 *
 	 * @see ArrayAccess::offsetGet()
 	 *
-	 * @param mixed $offset The key (offset) to retrieve.
+	 * @param mixed $key The key (offset) to retrieve.
 	 *
 	 * @return mixed
 	 */
diff --git a/engine/classes/ElggMenuBuilder.php b/engine/classes/ElggMenuBuilder.php
index cadfee7f5..6f4ac702e 100644
--- a/engine/classes/ElggMenuBuilder.php
+++ b/engine/classes/ElggMenuBuilder.php
@@ -16,16 +16,16 @@ class ElggMenuBuilder {
 	/**
 	 * ElggMenuBuilder constructor
 	 *
-	 * @param string $name  Identifier of the menu
+	 * @param array $menu Array of ElggMenuItem objects
 	 */
-	public function __construct($menu) {
+	public function __construct(array $menu) {
 		$this->menu = $menu;
 	}
 
 	/**
 	 * Get a prepared menu array
 	 *
-	 * @param mixed $sort_by
+	 * @param mixed $sort_by Method to sort the menu by. @see ElggMenuBuilder::sort()
 	 * @return array
 	 */
 	public function getMenu($sort_by = 'text') {
@@ -80,6 +80,7 @@ class ElggMenuBuilder {
 
 	/**
 	 * Group the menu items into sections
+	 * 
 	 * @return void
 	 */
 	protected function setupSections() {
diff --git a/engine/classes/ElggMenuItem.php b/engine/classes/ElggMenuItem.php
index 62547134a..2512392ad 100644
--- a/engine/classes/ElggMenuItem.php
+++ b/engine/classes/ElggMenuItem.php
@@ -2,12 +2,12 @@
 /**
  * Elgg Menu Item
  *
- * @package    Elgg.Core
- * @subpackage Navigation
- *
  * To create a menu item that is not a link, pass false for $href.
  *
  * @since 1.8.0
+ *
+ * @package    Elgg.Core
+ * @subpackage Navigation
  */
 class ElggMenuItem {
 
@@ -70,9 +70,9 @@ class ElggMenuItem {
 	/**
 	 * ElggMenuItem constructor
 	 *
-	 * @param string $name  Identifier of the menu item
-	 * @param string $text  Display text of the menu item
-	 * @param string $href  URL of the menu item (false if not a link)
+	 * @param string $name Identifier of the menu item
+	 * @param string $text Display text of the menu item
+	 * @param string $href URL of the menu item (false if not a link)
 	 */
 	public function __construct($name, $text, $href) {
 		//$this->name = $name;
@@ -182,7 +182,7 @@ class ElggMenuItem {
 	/**
 	 * Set the identifier of the menu item
 	 *
-	 * @param string Unique identifier
+	 * @param string $name Unique identifier
 	 * @return void
 	 */
 	public function setName($name) {
@@ -491,7 +491,7 @@ class ElggMenuItem {
 	/**
 	 * Set the parent menu item
 	 *
-	 * @param ElggMenuItem $parent
+	 * @param ElggMenuItem $parent The parent of this menu item
 	 * @return void
 	 */
 	public function setParent($parent) {
@@ -510,7 +510,7 @@ class ElggMenuItem {
 	/**
 	 * Add a child menu item
 	 *
-	 * @param ElggMenuItem $item
+	 * @param ElggMenuItem $item A child menu item
 	 * @return void
 	 */
 	public function addChild($item) {
@@ -549,10 +549,10 @@ class ElggMenuItem {
 	/**
 	 * Get the menu item content (usually a link)
 	 *
+	 * @todo View code in a model.  How do we feel about that?
+	 *
 	 * @params array $vars Options to pass to output/url if a link
 	 * @return string
-	 *
-	 * @todo View code in a model.  How do we feel about that?
 	 */
 	public function getContent(array $vars = array()) {
 
diff --git a/engine/classes/ElggPlugin.php b/engine/classes/ElggPlugin.php
index c4d6ec034..33f14ae37 100644
--- a/engine/classes/ElggPlugin.php
+++ b/engine/classes/ElggPlugin.php
@@ -707,9 +707,9 @@ class ElggPlugin extends ElggObject {
 	 * @throws PluginException
 	 */
 	public function start($flags) {
-//		if (!$this->canActivate()) {
-//			return false;
-//		}
+		//if (!$this->canActivate()) {
+		//	return false;
+		//}
 
 		// include classes
 		if ($flags & ELGG_PLUGIN_REGISTER_CLASSES) {
diff --git a/engine/classes/ElggPluginPackage.php b/engine/classes/ElggPluginPackage.php
index d240af477..2dc4bdb3d 100644
--- a/engine/classes/ElggPluginPackage.php
+++ b/engine/classes/ElggPluginPackage.php
@@ -303,6 +303,8 @@ class ElggPluginPackage {
 
 	/**
 	 * Returns an array of present and readable text files
+	 *
+	 * @return array
 	 */
 	public function getTextFilenames() {
 		return $this->textFiles;
diff --git a/engine/classes/ElggSite.php b/engine/classes/ElggSite.php
index 7ea52a195..b13683a56 100644
--- a/engine/classes/ElggSite.php
+++ b/engine/classes/ElggSite.php
@@ -196,7 +196,7 @@ class ElggSite extends ElggEntity {
 	 *
 	 * @note You cannot disable the current site.
 	 *
-	 * @param string $reason Optional reason for disabling
+	 * @param string $reason    Optional reason for disabling
 	 * @param bool   $recursive Recursively disable all contained entities?
 	 *
 	 * @return bool
@@ -219,7 +219,7 @@ class ElggSite extends ElggEntity {
 	 *                       accepted by elgg_get_entities(). Common parameters
 	 *                       include 'limit', and 'offset'.
 	 *                       Note: this was $limit before version 1.8
-	 * @param int $offset Offset @deprecated parameter
+	 * @param int   $offset  Offset @deprecated parameter
 	 *
 	 * @todo remove $offset in 2.0
 	 *