From: Sam Reed <reedy@users.mediawiki.org>
Date: Thu, 11 Feb 2010 22:06:45 +0000 (+0000)
Subject: Update code documentation with Bryans help for r62282 and r62331
X-Git-Tag: 1.31.0-rc.0~37811
X-Git-Url: http://git.cyclocoop.org/data/Fool?a=commitdiff_plain;h=8eb8e2e0d4e283bd6fd118ebe4ec059dfabf4d34;p=lhc%2Fweb%2Fwiklou.git

Update code documentation with Bryans help for r62282 and r62331
---

diff --git a/includes/api/ApiBase.php b/includes/api/ApiBase.php
index cbeeae83fd..22310feb12 100644
--- a/includes/api/ApiBase.php
+++ b/includes/api/ApiBase.php
@@ -967,6 +967,7 @@ abstract class ApiBase {
 
 	/**
 	* Returns a list of all possible errors returned by the module
+	* @return array in the format of array( key, param1, param2, ... ) or array( 'code' => ..., 'info' => ... )
 	*/
 	public function getPossibleErrors() {
 		$ret = array( array( 'readrequired' ) );
@@ -979,7 +980,9 @@ abstract class ApiBase {
 	}
 	
 	/**
-	* 
+	* Parses a list of errors into a standardised format
+	* @param $errors array List of errors. Items can be in the for array( key, param1, param2, ... ) or array( 'code' => ..., 'info' => ... )
+	* @return array Parsed list of errors with items in the form array( 'code' => ..., 'info' => ... )
 	*/
 	public function parseErrors( $errors ) {
 		$ret = array();