And some more parameter documentation!!
authorSam Reed <reedy@users.mediawiki.org>
Sat, 28 May 2011 16:31:00 +0000 (16:31 +0000)
committerSam Reed <reedy@users.mediawiki.org>
Sat, 28 May 2011 16:31:00 +0000 (16:31 +0000)
includes/Article.php
includes/Feed.php
includes/Metadata.php
includes/Pager.php
includes/actions/CreditsAction.php
includes/cache/HTMLFileCache.php
includes/media/JpegOrTiff.php
includes/specials/SpecialFilepath.php
includes/specials/SpecialMIMEsearch.php
includes/specials/SpecialMergeHistory.php
includes/specials/SpecialTags.php

index 915ee7a..a5110f4 100644 (file)
@@ -864,7 +864,7 @@ class Article {
        /**
         * Get a list of users who have edited this article, not including the user who made
         * the most recent revision, which you can get from $article->getUser() if you want it
-        * @return UserArray
+        * @return UserArrayFromResult
         */
        public function getContributors() {
                # @todo FIXME: This is expensive; cache this info somewhere.
index e22ed93..528b5f5 100644 (file)
@@ -36,9 +36,8 @@
  * @ingroup Feed
  */
 class FeedItem {
-       /**#@+
-        * @var string
-        * @private
+       /**
+        * @var Title
         */
        var $Title = 'Wiki';
        var $Description = '';
@@ -47,12 +46,11 @@ class FeedItem {
        var $Author = '';
        var $UniqueId = '';
        var $RSSIsPermalink;
-       /**#@-*/
 
        /**
         * Constructor
         *
-        * @param $Title String: Item's title
+        * @param $Title String|Title Item's title
         * @param $Description String
         * @param $Url String: URL uniquely designating the item.
         * @param $Date String: Item's date
index 463b497..62d1043 100644 (file)
@@ -101,6 +101,10 @@ abstract class RdfMetaData {
                }
        }
 
+       /**
+        * @param $name string
+        * @param $title Title
+        */
        protected function page( $name, $title ) {
                $this->url( $name, $title->getFullUrl() );
        }
index fb657f8..c10dd95 100644 (file)
@@ -93,6 +93,8 @@ abstract class IndexPager implements Pager {
 
        /**
         * Result object for the query. Warning: seek before use.
+        *
+        * @var ResultWrapper
         */
        public $mResult;
 
index 26bb70b..9ce7963 100644 (file)
@@ -119,7 +119,7 @@ class CreditsAction extends FormlessAction {
 
                # Sift for real versus user names
                foreach ( $contributors as $user ) {
-                       $cnt--;
+                       $cnt--; 
                        if ( $user->isLoggedIn() ) {
                                $link = self::link( $user );
                                if ( !in_array( 'realname', $wgHiddenPrefs ) && $user->getRealName() ) {
index 31d92ff..3b3ce96 100644 (file)
@@ -119,6 +119,8 @@ class HTMLFileCache {
        /**
         * Check if up to date cache file exists
         * @param $timestamp string
+        *
+        * @return bool
         */
        public function isFileCacheGood( $timestamp = '' ) {
                global $wgCacheEpoch;
index 767cb19..d483500 100644 (file)
@@ -95,6 +95,10 @@ class JpegOrTiffHandler extends BitmapHandler {
                return self::METADATA_GOOD;
        }
 
+       /**
+        * @param $image File
+        * @return array|bool
+        */
        function formatMetadata( $image ) {
                $metadata = $image->getMetadata();
                if ( !$metadata ||
@@ -116,8 +120,8 @@ class JpegOrTiffHandler extends BitmapHandler {
                return $this->formatMetadataHelper( $exif );
        }
 
-        function getMetadataType( $image ) {
-                return 'exif';
-        }
+       function getMetadataType( $image ) {
+               return 'exif';
+       }
 }
 
index 744940f..bcf6965 100644 (file)
@@ -70,6 +70,9 @@ class SpecialFilepath extends SpecialPage {
                }
        }
 
+       /**
+        * @param $title Title
+        */
        function showForm( $title ) {
                global $wgOut, $wgScript;
 
index a64b287..aefe7bf 100644 (file)
@@ -107,6 +107,10 @@ class MIMEsearchPage extends QueryPage {
                return "($download) $plink . . $dimensions . . $bytes . . $user . . $time";
        }
 
+       /**
+        * @param $type string
+        * @return bool
+        */
        protected static function isValidType( $type ) {
                // From maintenance/tables.sql => img_major_mime
                $types = array(
index 99d3394..916230c 100644 (file)
  */
 class SpecialMergeHistory extends SpecialPage {
        var $mAction, $mTarget, $mDest, $mTimestamp, $mTargetID, $mDestID, $mComment;
+
+       /**
+        * @var Title
+        */
        var $mTargetObj, $mDestObj;
 
        public function __construct() {
index d3f4e7d..add54c1 100644 (file)
@@ -63,8 +63,8 @@ class SpecialTags extends SpecialPage {
        }
 
        function doTagRow( $tag, $hitcount ) {
-               static $sk=null, $doneTags=array();
-               if (!$sk) {
+               static $sk = null, $doneTags = array();
+               if ( !$sk ) {
                        global $wgUser;
                        $sk = $wgUser->getSkin();
                }