Object return type hints
authorSam Reed <reedy@users.mediawiki.org>
Sun, 3 Oct 2010 22:13:04 +0000 (22:13 +0000)
committerSam Reed <reedy@users.mediawiki.org>
Sun, 3 Oct 2010 22:13:04 +0000 (22:13 +0000)
includes/api/ApiMain.php

index bd3db40..801ae4c 100644 (file)
@@ -132,7 +132,7 @@ class ApiMain extends ApiBase {
        /**
         * Constructs an instance of ApiMain that utilizes the module and format specified by $request.
         *
-        * @param $request object - if this is an instance of FauxRequest, errors are thrown and no printing occurs
+        * @param $request WebRequest - if this is an instance of FauxRequest, errors are thrown and no printing occurs
         * @param $enableWrite bool should be set to true if the api may modify data
         */
        public function __construct( $request, $enableWrite = false ) {
@@ -181,6 +181,7 @@ class ApiMain extends ApiBase {
 
        /**
         * Return the request object that contains client's request
+        * @return WebRequest
         */
        public function getRequest() {
                return $this->mRequest;