Tweak/add some documentation as hints for some code analysis

diff --git a/includes/RecentChange.php b/includes/RecentChange.php
index 6663d58..970411e 100644 (file)
--- a/includes/RecentChange.php
+++ b/includes/RecentChange.php
@@ -115,6 +115,10 @@ class RecentChange {
                $this->mExtra = $extra;
        }
 
+    /**
+     *
+     * @return Title
+     */
        public function &getTitle() {
                if( $this->mTitle === false ) {
                        $this->mTitle = Title::makeTitle( $this->mAttribs['rc_namespace'], $this->mAttribs['rc_title'] );
@@ -579,7 +583,7 @@ class RecentChange {
        /**
         * Get an attribute value
         *
-        * @param $name Attribute name
+        * @param $name String Attribute name
         * @return mixed
         */
        public function getAttribute( $name ) {

diff --git a/includes/api/ApiBase.php b/includes/api/ApiBase.php
index 9ef45ef..78d44bc 100644 (file)
--- a/includes/api/ApiBase.php
+++ b/includes/api/ApiBase.php
@@ -551,7 +551,7 @@ abstract class ApiBase {
         * Return true if we're to watch the page, false if not, null if no change.
         * @param $watchlist String Valid values: 'watch', 'unwatch', 'preferences', 'nochange'
         * @param $titleObj Title the page under consideration
-        * @param $userOption The user option to consider when $watchlist=preferences.
+        * @param $userOption String The user option to consider when $watchlist=preferences.
         *      If not set will magically default to either watchdefault or watchcreations
         * @returns mixed
         */

diff --git a/includes/api/ApiMain.php b/includes/api/ApiMain.php
index e490ece..4d8d671 100644 (file)
--- a/includes/api/ApiMain.php
+++ b/includes/api/ApiMain.php
@@ -530,7 +530,7 @@ class ApiMain extends ApiBase {
 
        /**
         * Set up the module for response
-        * @return Object the module that will handle this action
+        * @return ApiBase The module that will handle this action
         */
        protected function setupModule() {
                // Instantiate the module requested by the user