most of the comments in the engine now past the sniffer

6 files changed, 31 insertions, 21 deletions

diff --git a/engine/classes/ElggExtender.php b/engine/classes/ElggExtender.php
index bc2d67ae2..d94bad837 100644
--- a/engine/classes/ElggExtender.php
+++ b/engine/classes/ElggExtender.php
@@ -24,8 +24,15 @@
  * @property mixed  $value        The value of the extender (int or string)
  * @property int    $time_created A UNIX timestamp of when the extender was created (read-only, set on first save)
  */
-abstract class ElggExtender extends ElggData
-{
+abstract class ElggExtender extends ElggData {
+
+	/**
+	 * (non-PHPdoc)
+	 *
+	 * @see ElggData::initializeAttributes()
+	 *
+	 * @return void
+	 */
 	protected function initializeAttributes() {
 		parent::initializeAttributes();
 
diff --git a/engine/classes/ElggMenuBuilder.php b/engine/classes/ElggMenuBuilder.php
index 6f4ac702e..de0017599 100644
--- a/engine/classes/ElggMenuBuilder.php
+++ b/engine/classes/ElggMenuBuilder.php
@@ -4,8 +4,7 @@
  *
  * @package    Elgg.Core
  * @subpackage Navigation
- *
- * @since 1.8.0
+ * @since      1.8.0
  */
 class ElggMenuBuilder {
 
diff --git a/engine/classes/ElggMenuItem.php b/engine/classes/ElggMenuItem.php
index 2512392ad..4bc9144d4 100644
--- a/engine/classes/ElggMenuItem.php
+++ b/engine/classes/ElggMenuItem.php
@@ -4,10 +4,9 @@
  *
  * To create a menu item that is not a link, pass false for $href.
  *
- * @since 1.8.0
- *
  * @package    Elgg.Core
  * @subpackage Navigation
+ * @since      1.8.0
  */
 class ElggMenuItem {
 
@@ -549,10 +548,9 @@ 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
+	 * @param 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/ElggMetadata.php b/engine/classes/ElggMetadata.php
index 32e7b32f1..634a122e5 100644
--- a/engine/classes/ElggMetadata.php
+++ b/engine/classes/ElggMetadata.php
@@ -9,6 +9,13 @@
  */
 class ElggMetadata extends ElggExtender {
 
+	/**
+	 * (non-PHPdoc)
+	 *
+	 * @see ElggData::initializeAttributes()
+	 *
+	 * @return void
+	 */
 	protected function initializeAttributes() {
 		parent::initializeAttributes();
 
diff --git a/engine/classes/ElggUser.php b/engine/classes/ElggUser.php
index ab0610ac0..bdf57c2c3 100644
--- a/engine/classes/ElggUser.php
+++ b/engine/classes/ElggUser.php
@@ -105,7 +105,7 @@ class ElggUser extends ElggEntity
 	 *
 	 * @param int $guid ElggUser GUID
 	 *
-	 * @return true|false
+	 * @return bool
 	 */
 	protected function load($guid) {
 		// Test to see if we have the generic stuff
@@ -141,7 +141,7 @@ class ElggUser extends ElggEntity
 	/**
 	 * Saves this user to the database.
 	 *
-	 * @return true|false
+	 * @return bool
 	 */
 	public function save() {
 		// Save generic stuff
@@ -261,7 +261,7 @@ class ElggUser extends ElggEntity
 	 * @param int    $limit   The number of results to return
 	 * @param int    $offset  Any indexing offset
 	 *
-	 * @return bool
+	 * @return array
 	 */
 	function getSites($subtype = "", $limit = 10, $offset = 0) {
 		return get_user_sites($this->getGUID(), $subtype, $limit, $offset);
@@ -272,7 +272,7 @@ class ElggUser extends ElggEntity
 	 *
 	 * @param int $site_guid The guid of the site to add it to
 	 *
-	 * @return true|false
+	 * @return bool
 	 */
 	function addToSite($site_guid) {
 		return add_site_user($site_guid, $this->getGUID());
@@ -283,7 +283,7 @@ class ElggUser extends ElggEntity
 	 *
 	 * @param int $site_guid The guid of the site to remove it from
 	 *
-	 * @return true|false
+	 * @return bool
 	 */
 	function removeFromSite($site_guid) {
 		return remove_site_user($site_guid, $this->getGUID());
@@ -294,7 +294,7 @@ class ElggUser extends ElggEntity
 	 *
 	 * @param int $friend_guid The GUID of the user to add
 	 *
-	 * @return true|false Depending on success
+	 * @return bool
 	 */
 	function addFriend($friend_guid) {
 		return user_add_friend($this->getGUID(), $friend_guid);
@@ -305,7 +305,7 @@ class ElggUser extends ElggEntity
 	 *
 	 * @param int $friend_guid The GUID of the user to remove
 	 *
-	 * @return true|false Depending on success
+	 * @return bool
 	 */
 	function removeFriend($friend_guid) {
 		return user_remove_friend($this->getGUID(), $friend_guid);
@@ -314,8 +314,7 @@ class ElggUser extends ElggEntity
 	/**
 	 * Determines whether or not this user is a friend of the currently logged in user
 	 *
-	 *
-	 * @return true|false
+	 * @return bool
 	 */
 	function isFriend() {
 		return $this->isFriendOf(elgg_get_logged_in_user_guid());
@@ -326,7 +325,7 @@ class ElggUser extends ElggEntity
 	 *
 	 * @param int $user_guid The GUID of the user to check against
 	 *
-	 * @return true|false
+	 * @return bool
 	 */
 	function isFriendsWith($user_guid) {
 		return user_is_friend($this->getGUID(), $user_guid);
@@ -337,7 +336,7 @@ class ElggUser extends ElggEntity
 	 *
 	 * @param int $user_guid The GUID of the user to check against
 	 *
-	 * @return true|false
+	 * @return bool
 	 */
 	function isFriendOf($user_guid) {
 		return user_is_friend($user_guid, $this->getGUID());
diff --git a/engine/classes/SuccessResult.php b/engine/classes/SuccessResult.php
index c8578a2cf..ab5468ad8 100644
--- a/engine/classes/SuccessResult.php
+++ b/engine/classes/SuccessResult.php
@@ -15,7 +15,7 @@ class SuccessResult extends GenericResult {
 	 *
 	 * @param string $result The result
 	 */
-	public function SuccessResult($result) {
+	public function __construct($result) {
 		$this->setResult($result);
 		$this->setStatusCode(SuccessResult::$RESULT_SUCCESS);
 	}