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 71a8706..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();