Elaborate docs added in r53753 per CR comment
authorRoan Kattouw <catrope@users.mediawiki.org>
Sun, 26 Jul 2009 18:24:47 +0000 (18:24 +0000)
committerRoan Kattouw <catrope@users.mediawiki.org>
Sun, 26 Jul 2009 18:24:47 +0000 (18:24 +0000)
includes/api/ApiBase.php

index 0ec9302..ad93c0b 100644 (file)
@@ -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();