From 7ddd9521b3f3a397da3b0a6b56238d31414eb4be Mon Sep 17 00:00:00 2001
From: brettp <brettp@36083f99-b078-4883-b0ff-0f9b5a30f544>
Date: Thu, 28 Oct 2010 19:17:36 +0000
Subject: Standardized code in all of core, not including language files,
 tests, or core mods.

git-svn-id: http://code.elgg.org/elgg/trunk@7124 36083f99-b078-4883-b0ff-0f9b5a30f544
---
 engine/classes/SuccessResult.php | 19 ++++++++++++++++---
 1 file changed, 16 insertions(+), 3 deletions(-)

(limited to 'engine/classes/SuccessResult.php')

diff --git a/engine/classes/SuccessResult.php b/engine/classes/SuccessResult.php
index a554d9b1b..f68ddd39e 100644
--- a/engine/classes/SuccessResult.php
+++ b/engine/classes/SuccessResult.php
@@ -3,17 +3,30 @@
  * SuccessResult
  * Generic success result class, extend if you want to do something special.
  *
- * @package Elgg
- * @subpackage Core
+ * @package    Elgg.Core
+ * @subpackage WebServicesAPI
  */
 class SuccessResult extends GenericResult {
-	public static $RESULT_SUCCESS = 0;  // Do not change this from 0
+	// Do not change this from 0
+	public static $RESULT_SUCCESS = 0;
 
+	/**
+	 * A new success result
+	 *
+	 * @param string $result The result
+	 */
 	public function SuccessResult($result) {
 		$this->setResult($result);
 		$this->setStatusCode(SuccessResult::$RESULT_SUCCESS);
 	}
 
+	/**
+	 * Returns a new instance of this class
+	 *
+	 * @param unknown $result A result of some kind?
+	 *
+	 * @return SuccessResult
+	 */
 	public static function getInstance($result) {
 		// Return a new error object.
 		return new SuccessResult($result);
-- 
cgit v1.2.3