From: Roan Kattouw <catrope@users.mediawiki.org>
Date: Sun, 26 Jul 2009 18:24:47 +0000 (+0000)
Subject: Elaborate docs added in r53753 per CR comment
X-Git-Tag: 1.31.0-rc.0~40706
X-Git-Url: http://git.cyclocoop.org/%7B%24admin_url%7Dcompta/comptes/journal.php?a=commitdiff_plain;h=9e881e1b2e060017c29741ca1606418c7dbfe2f1;p=lhc%2Fweb%2Fwiklou.git

Elaborate docs added in r53753 per CR comment
---

diff --git a/includes/api/ApiBase.php b/includes/api/ApiBase.php
index 0ec93026b9..ad93c0babe 100644
--- a/includes/api/ApiBase.php
+++ b/includes/api/ApiBase.php
@@ -729,7 +729,7 @@ abstract class ApiBase {
 	 * @param $errorCode string Brief, arbitrary, stable string to allow easy
 	 *   automated identification of the error, e.g., 'unknown_action'
 	 * @param $httpRespCode int HTTP response code
-	 * @param $extradata array Data to add to the query result
+	 * @param $extradata array Data to add to the <error> element; array in ApiResult format
 	 */
 	public function dieUsage($description, $errorCode, $httpRespCode = 0, $extradata = null) {
 		wfProfileClose();