API: Various docu and clean-up.

[lhc/web/wiklou.git] / includes / api / ApiUnblock.php

diff --git a/includes/api/ApiUnblock.php b/includes/api/ApiUnblock.php
index bf5f256..a09c19a 100644 (file)
--- a/includes/api/ApiUnblock.php
+++ b/includes/api/ApiUnblock.php
@@ -28,6 +28,9 @@ if (!defined('MEDIAWIKI')) {
 }
 
 /**
+ * API module that facilitates the unblocking of users. Requires API write mode
+ * to be enabled.
+ *
  * @addtogroup API
  */
 class ApiUnblock extends ApiBase {
@@ -36,6 +39,9 @@ class ApiUnblock extends ApiBase {
                parent :: __construct($main, $action);
        }
 
+       /**
+        * Unblocks the specified user or provides the reason the unblock failed.
+        */
        public function execute() {
                global $wgUser;
                $this->getMain()->requestWriteMode();
@@ -103,7 +109,7 @@ class ApiUnblock extends ApiBase {
 
        protected function getParamDescription() {
                return array (
-                       'id' => 'ID of the block you want to unblock (obtained through list=blocks). Cannot be user together with user',
+                       'id' => 'ID of the block you want to unblock (obtained through list=blocks). Cannot be used together with user',
                        'user' => 'Username, IP address or IP range you want to unblock. Cannot be used together with id',
                        'token' => 'An unblock token previously obtained through the gettoken parameter',
                        'gettoken' => 'If set, an unblock token will be returned, and no other action will be taken',