Param documentation updates/added

diff --git a/includes/ImageQueryPage.php b/includes/ImageQueryPage.php
index 1edba7f..f46974b 100644 (file)
--- a/includes/ImageQueryPage.php
+++ b/includes/ImageQueryPage.php
@@ -15,7 +15,7 @@ abstract class ImageQueryPage extends QueryPage {
         *
         * @param $out OutputPage to print to
         * @param $skin Skin: user skin to use [unused]
-        * @param $dbr Database (read) connection to use
+        * @param $dbr DatabaseBase (read) connection to use
         * @param $res Integer: result pointer
         * @param $num Integer: number of available result rows
         * @param $offset Integer: paging offset

diff --git a/includes/LogPage.php b/includes/LogPage.php
index 184e768..4afa12f 100644 (file)
--- a/includes/LogPage.php
+++ b/includes/LogPage.php
@@ -38,7 +38,18 @@ class LogPage {
        const SUPPRESSED_USER = 12;
        const SUPPRESSED_ACTION = 9;
        /* @access private */
-       var $type, $action, $comment, $params, $target, $doer;
+       var $type, $action, $comment, $params;
+
+       /**
+        * @var User
+        */
+       var $doer;
+
+       /**
+        * @var Title
+        */
+       var $target;
+
        /* @acess public */
        var $updateRecentChanges, $sendToUDP;
 

diff --git a/includes/cache/LinkCache.php b/includes/cache/LinkCache.php
index 0e1029e..6ffb7e0 100644 (file)
--- a/includes/cache/LinkCache.php
+++ b/includes/cache/LinkCache.php
@@ -85,6 +85,9 @@ class LinkCache {
                        'revision' => intval( $revision ) );
        }
 
+       /**
+        * @param $title Title
+        */
        public function addBadLinkObj( $title ) {
                $dbkey = $title->getPrefixedDbKey();
                if ( !$this->isBadLink( $dbkey ) ) {
@@ -96,6 +99,9 @@ class LinkCache {
                unset( $this->mBadLinks[$title] );
        }
 
+       /**
+        * @param $title Title
+        */
        public function clearLink( $title ) {
                $dbkey = $title->getPrefixedDbKey();
                if( isset($this->mBadLinks[$dbkey]) ) {

diff --git a/includes/db/Database.php b/includes/db/Database.php
index fed315c..8dc2a76 100644 (file)
--- a/includes/db/Database.php
+++ b/includes/db/Database.php
@@ -217,7 +217,12 @@ abstract class DatabaseBase implements DatabaseType {
        protected $mDoneWrites = false;
        protected $mPHPError = false;
 
-       protected $mServer, $mUser, $mPassword, $mConn = null, $mDBname;
+       protected $mServer, $mUser, $mPassword, $mDBname;
+
+       /**
+        * @var DatabaseBase
+        */
+       protected $mConn = null;
        protected $mOpened = false;
 
        protected $mTablePrefix;

diff --git a/includes/db/DatabaseOracle.php b/includes/db/DatabaseOracle.php
index 1d8c58c..172eaca 100644 (file)
--- a/includes/db/DatabaseOracle.php
+++ b/includes/db/DatabaseOracle.php
@@ -34,6 +34,11 @@ class ORAResult {
                return $array_out;
        }
 
+       /**
+        * @param $db DatabaseBase
+        * @param $stmt
+        * @param bool $unique
+        */
        function __construct( &$db, $stmt, $unique = false ) {
                $this->db =& $db;
 

diff --git a/includes/media/GIF.php b/includes/media/GIF.php
index cdbde35..325ceb9 100644 (file)
--- a/includes/media/GIF.php
+++ b/includes/media/GIF.php
@@ -27,6 +27,10 @@ class GIFHandler extends BitmapHandler {
                return serialize($parsedGIFMetadata);
        }
 
+       /**
+        * @param $image File
+        * @return array|bool
+        */
        function formatMetadata( $image ) {
                $meta = $image->getMetadata();
 

diff --git a/includes/specials/SpecialListredirects.php b/includes/specials/SpecialListredirects.php
index 8a2444e..fc35b48 100644 (file)
--- a/includes/specials/SpecialListredirects.php
+++ b/includes/specials/SpecialListredirects.php
@@ -63,6 +63,8 @@ class ListredirectsPage extends QueryPage {
 
        /**
         * Cache page existence for performance
+        *
+        * @param $db DatabaseBase
         */
        function preprocessResults( $db, $res ) {
                $batch = new LinkBatch;

diff --git a/includes/specials/SpecialMergeHistory.php b/includes/specials/SpecialMergeHistory.php
index 1f6e628..99d3394 100644 (file)
--- a/includes/specials/SpecialMergeHistory.php
+++ b/includes/specials/SpecialMergeHistory.php
@@ -35,6 +35,10 @@ class SpecialMergeHistory extends SpecialPage {
                parent::__construct( 'MergeHistory', 'mergehistory' );
        }
 
+       /**
+        * @param $request WebRequest
+        * @return void
+        */
        private function loadRequestParams( $request ) {
                global $wgUser;
 

diff --git a/includes/specials/SpecialMostcategories.php b/includes/specials/SpecialMostcategories.php
index 6f3b0a3..2e43719 100644 (file)
--- a/includes/specials/SpecialMostcategories.php
+++ b/includes/specials/SpecialMostcategories.php
@@ -52,6 +52,11 @@ class MostcategoriesPage extends QueryPage {
                );
        }
 
+       /**
+        * @param $skin Skin
+        * @param $result
+        * @return string
+        */
        function formatResult( $skin, $result ) {
                global $wgLang;
                $title = Title::makeTitleSafe( $result->namespace, $result->title );

diff --git a/includes/specials/SpecialMostlinked.php b/includes/specials/SpecialMostlinked.php
index 73dd4f0..58f686e 100644 (file)
--- a/includes/specials/SpecialMostlinked.php
+++ b/includes/specials/SpecialMostlinked.php
@@ -57,6 +57,9 @@ class MostlinkedPage extends QueryPage {
 
        /**
         * Pre-fill the link cache
+        *
+        * @param $db DatabaseBase
+        * @param $res
         */
        function preprocessResults( $db, $res ) {
                if( $db->numRows( $res ) > 0 ) {

diff --git a/includes/specials/SpecialPopularpages.php b/includes/specials/SpecialPopularpages.php
index 1ef204f..7c7190a 100644 (file)
--- a/includes/specials/SpecialPopularpages.php
+++ b/includes/specials/SpecialPopularpages.php
@@ -48,6 +48,11 @@ class PopularPagesPage extends QueryPage {
                                        'page_namespace' => MWNamespace::getContentNamespaces() ) );
        }
 
+       /**
+        * @param $skin Skin
+        * @param $result
+        * @return string
+        */
        function formatResult( $skin, $result ) {
                global $wgLang, $wgContLang;
                $title = Title::makeTitle( $result->namespace, $result->title );

diff --git a/includes/specials/SpecialRecentchangeslinked.php b/includes/specials/SpecialRecentchangeslinked.php
index 873055c..5583c26 100644 (file)
--- a/includes/specials/SpecialRecentchangeslinked.php
+++ b/includes/specials/SpecialRecentchangeslinked.php
@@ -220,6 +220,9 @@ class SpecialRecentchangeslinked extends SpecialRecentChanges {
                return $extraOpts;
        }
 
+       /**
+        * @return Title
+        */
        function getTargetTitle() {
                if ( $this->rclTargetTitle === null ) {
                        $opts = $this->getOptions();

diff --git a/includes/specials/SpecialShortpages.php b/includes/specials/SpecialShortpages.php
index c53ab6a..5a487fc 100644 (file)
--- a/includes/specials/SpecialShortpages.php
+++ b/includes/specials/SpecialShortpages.php
@@ -61,6 +61,11 @@ class ShortPagesPage extends QueryPage {
                return array( 'page_len' );
        }
 
+       /**
+        * @param $db DatabaseBase
+        * @param $res
+        * @return void
+        */
        function preprocessResults( $db, $res ) {
                # There's no point doing a batch check if we aren't caching results;
                # the page must exist for it to have been pulled out of the table

diff --git a/includes/specials/SpecialUnusedtemplates.php b/includes/specials/SpecialUnusedtemplates.php
index cdb4ccb..da50160 100644 (file)
--- a/includes/specials/SpecialUnusedtemplates.php
+++ b/includes/specials/SpecialUnusedtemplates.php
@@ -54,6 +54,11 @@ class UnusedtemplatesPage extends QueryPage {
                );
        }
 
+       /**
+        * @param $skin Skin
+        * @param $result
+        * @return string
+        */
        function formatResult( $skin, $result ) {
                $title = Title::makeTitle( NS_TEMPLATE, $result->title );
                $pageLink = $skin->linkKnown(

diff --git a/includes/specials/SpecialUnwatchedpages.php b/includes/specials/SpecialUnwatchedpages.php
index 92d0355..86aa2b2 100644 (file)
--- a/includes/specials/SpecialUnwatchedpages.php
+++ b/includes/specials/SpecialUnwatchedpages.php
@@ -60,6 +60,11 @@ class UnwatchedpagesPage extends QueryPage {
                return array( 'page_namespace', 'page_title' );
        }
 
+       /**
+        * @param $skin Skin
+        * @param $result
+        * @return string
+        */
        function formatResult( $skin, $result ) {
                global $wgContLang;
 

diff --git a/includes/specials/SpecialWantedcategories.php b/includes/specials/SpecialWantedcategories.php
index 635b9b6..800e940 100644 (file)
--- a/includes/specials/SpecialWantedcategories.php
+++ b/includes/specials/SpecialWantedcategories.php
@@ -48,6 +48,11 @@ class WantedCategoriesPage extends WantedQueryPage {
                );
        }
 
+       /**
+        * @param $skin Skin
+        * @param $result
+        * @return string
+        */
        function formatResult( $skin, $result ) {
                global $wgLang, $wgContLang;
 

diff --git a/includes/specials/SpecialWhatlinkshere.php b/includes/specials/SpecialWhatlinkshere.php
index 44dd227..8b4eeef 100644 (file)
--- a/includes/specials/SpecialWhatlinkshere.php
+++ b/includes/specials/SpecialWhatlinkshere.php
@@ -28,8 +28,17 @@
  */
 class SpecialWhatLinksHere extends SpecialPage {
 
-       // Stored objects
-       protected $opts, $target, $selfTitle;
+       /**
+        * @var FormOptions
+        */
+       protected $opts;
+
+       protected $selfTitle;
+
+       /**
+        * @var Title
+        */
+       protected $target;
 
        protected $limits = array( 20, 50, 100, 250, 500 );