From 8eb8e2e0d4e283bd6fd118ebe4ec059dfabf4d34 Mon Sep 17 00:00:00 2001 From: Sam Reed Date: Thu, 11 Feb 2010 22:06:45 +0000 Subject: [PATCH] Update code documentation with Bryans help for r62282 and r62331 --- includes/api/ApiBase.php | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) 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(); -- 2.20.1