| Index: trunk/phase3/includes/api/ApiBase.php |
| — | — | @@ -967,6 +967,7 @@ |
| 968 | 968 | |
| 969 | 969 | /** |
| 970 | 970 | * Returns a list of all possible errors returned by the module |
| | 971 | + * @return array in the format of array( key, param1, param2, ... ) or array( 'code' => ..., 'info' => ... ) |
| 971 | 972 | */ |
| 972 | 973 | public function getPossibleErrors() { |
| 973 | 974 | $ret = array( array( 'readrequired' ) ); |
| — | — | @@ -979,7 +980,9 @@ |
| 980 | 981 | } |
| 981 | 982 | |
| 982 | 983 | /** |
| 983 | | - * |
| | 984 | + * Parses a list of errors into a standardised format |
| | 985 | + * @param $errors array List of errors. Items can be in the for array( key, param1, param2, ... ) or array( 'code' => ..., 'info' => ... ) |
| | 986 | + * @return array Parsed list of errors with items in the form array( 'code' => ..., 'info' => ... ) |
| 984 | 987 | */ |
| 985 | 988 | public function parseErrors( $errors ) { |
| 986 | 989 | $ret = array(); |