Documentation updates and additions

diff --git a/includes/WebResponse.php b/includes/WebResponse.php
index 1dded19..9baaf3b 100644 (file)
--- a/includes/WebResponse.php
+++ b/includes/WebResponse.php
@@ -56,11 +56,19 @@ class WebResponse {
        }
 }
 
-
+/**
+ * @ingroup HTTP
+ */
 class FauxResponse extends WebResponse {
        private $headers;
        private $cookies;
 
+       /**
+        * Stores a HTTP header
+        * @param $string String: header to output
+        * @param $replace Bool: replace current similar header
+        * @param $http_response_code null|int Forces the HTTP response code to the specified value.
+        */
        public function header( $string, $replace = true, $http_response_code = null ) {
                list( $key, $val ) = explode( ":", $string, 2 );
 
@@ -69,17 +77,31 @@ class FauxResponse extends WebResponse {
                }
        }
 
+       /**
+        * @param $key string
+        * @return string
+        */
        public function getheader( $key ) {
                return $this->headers[$key];
        }
 
+       /**
+        * @param $name String: name of cookie
+        * @param $value String: value to give cookie
+        * @param $expire Int: number of seconds til cookie expires
+        */
        public function setcookie( $name, $value, $expire = 0 ) {
                $this->cookies[$name] = $value;
        }
 
+       /**
+        * @param $name string
+        * @return string
+        */
        public function getcookie( $name )  {
                if ( isset( $this->cookies[$name] ) ) {
                        return $this->cookies[$name];
                }
+               return null;
        }
 }

diff --git a/includes/api/ApiQueryBase.php b/includes/api/ApiQueryBase.php
index 74e8ae6..90e10df 100644 (file)
--- a/includes/api/ApiQueryBase.php
+++ b/includes/api/ApiQueryBase.php
@@ -359,7 +359,7 @@ abstract class ApiQueryBase extends ApiBase {
 
        /**
         * Get the Query database connection (read-only)
-        * @return Database
+        * @return DatabaseBase
         */
        protected function getDB() {
                if ( is_null( $this->mDb ) ) {

diff --git a/includes/api/ApiQueryBlocks.php b/includes/api/ApiQueryBlocks.php
index 3eed956..878a9ed 100644 (file)
--- a/includes/api/ApiQueryBlocks.php
+++ b/includes/api/ApiQueryBlocks.php
@@ -30,7 +30,7 @@ if ( !defined( 'MEDIAWIKI' ) ) {
 }
 
 /**
- * Query module to enumerate all available pages.
+ * Query module to enumerate all user blocks
  *
  * @ingroup API
  */