http://www.mediawiki.org/wiki/Special:Code/MediaWiki/89043
Revision: 89043
Author: reedy
Date: 2011-05-28 16:31:00 +0000 (Sat, 28 May 2011)
Log Message:
-----------
And some more parameter documentation!!
Modified Paths:
--------------
trunk/phase3/includes/Article.php
trunk/phase3/includes/Feed.php
trunk/phase3/includes/Metadata.php
trunk/phase3/includes/Pager.php
trunk/phase3/includes/actions/CreditsAction.php
trunk/phase3/includes/cache/HTMLFileCache.php
trunk/phase3/includes/media/JpegOrTiff.php
trunk/phase3/includes/specials/SpecialFilepath.php
trunk/phase3/includes/specials/SpecialMIMEsearch.php
trunk/phase3/includes/specials/SpecialMergeHistory.php
trunk/phase3/includes/specials/SpecialTags.php
Modified: trunk/phase3/includes/Article.php
===================================================================
--- trunk/phase3/includes/Article.php 2011-05-28 16:18:40 UTC (rev 89042)
+++ trunk/phase3/includes/Article.php 2011-05-28 16:31:00 UTC (rev 89043)
@@ -864,7 +864,7 @@
/**
* 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.
Modified: trunk/phase3/includes/Feed.php
===================================================================
--- trunk/phase3/includes/Feed.php 2011-05-28 16:18:40 UTC (rev 89042)
+++ trunk/phase3/includes/Feed.php 2011-05-28 16:31:00 UTC (rev 89043)
@@ -36,9 +36,8 @@
* @ingroup Feed
*/
class FeedItem {
- /**#@+
- * @var string
- * @private
+ /**
+ * @var Title
*/
var $Title = 'Wiki';
var $Description = '';
@@ -47,12 +46,11 @@
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
Modified: trunk/phase3/includes/Metadata.php
===================================================================
--- trunk/phase3/includes/Metadata.php 2011-05-28 16:18:40 UTC (rev 89042)
+++ trunk/phase3/includes/Metadata.php 2011-05-28 16:31:00 UTC (rev 89043)
@@ -101,6 +101,10 @@
}
}
+ /**
+ * @param $name string
+ * @param $title Title
+ */
protected function page( $name, $title ) {
$this->url( $name, $title->getFullUrl() );
}
Modified: trunk/phase3/includes/Pager.php
===================================================================
--- trunk/phase3/includes/Pager.php 2011-05-28 16:18:40 UTC (rev 89042)
+++ trunk/phase3/includes/Pager.php 2011-05-28 16:31:00 UTC (rev 89043)
@@ -93,6 +93,8 @@
/**
* Result object for the query. Warning: seek before use.
+ *
+ * @var ResultWrapper
*/
public $mResult;
Modified: trunk/phase3/includes/actions/CreditsAction.php
===================================================================
--- trunk/phase3/includes/actions/CreditsAction.php 2011-05-28 16:18:40 UTC
(rev 89042)
+++ trunk/phase3/includes/actions/CreditsAction.php 2011-05-28 16:31:00 UTC
(rev 89043)
@@ -119,7 +119,7 @@
# 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() ) {
Modified: trunk/phase3/includes/cache/HTMLFileCache.php
===================================================================
--- trunk/phase3/includes/cache/HTMLFileCache.php 2011-05-28 16:18:40 UTC
(rev 89042)
+++ trunk/phase3/includes/cache/HTMLFileCache.php 2011-05-28 16:31:00 UTC
(rev 89043)
@@ -119,6 +119,8 @@
/**
* Check if up to date cache file exists
* @param $timestamp string
+ *
+ * @return bool
*/
public function isFileCacheGood( $timestamp = '' ) {
global $wgCacheEpoch;
Modified: trunk/phase3/includes/media/JpegOrTiff.php
===================================================================
--- trunk/phase3/includes/media/JpegOrTiff.php 2011-05-28 16:18:40 UTC (rev
89042)
+++ trunk/phase3/includes/media/JpegOrTiff.php 2011-05-28 16:31:00 UTC (rev
89043)
@@ -95,6 +95,10 @@
return self::METADATA_GOOD;
}
+ /**
+ * @param $image File
+ * @return array|bool
+ */
function formatMetadata( $image ) {
$metadata = $image->getMetadata();
if ( !$metadata ||
@@ -116,8 +120,8 @@
return $this->formatMetadataHelper( $exif );
}
- function getMetadataType( $image ) {
- return 'exif';
- }
+ function getMetadataType( $image ) {
+ return 'exif';
+ }
}
Modified: trunk/phase3/includes/specials/SpecialFilepath.php
===================================================================
--- trunk/phase3/includes/specials/SpecialFilepath.php 2011-05-28 16:18:40 UTC
(rev 89042)
+++ trunk/phase3/includes/specials/SpecialFilepath.php 2011-05-28 16:31:00 UTC
(rev 89043)
@@ -70,6 +70,9 @@
}
}
+ /**
+ * @param $title Title
+ */
function showForm( $title ) {
global $wgOut, $wgScript;
Modified: trunk/phase3/includes/specials/SpecialMIMEsearch.php
===================================================================
--- trunk/phase3/includes/specials/SpecialMIMEsearch.php 2011-05-28
16:18:40 UTC (rev 89042)
+++ trunk/phase3/includes/specials/SpecialMIMEsearch.php 2011-05-28
16:31:00 UTC (rev 89043)
@@ -107,6 +107,10 @@
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(
Modified: trunk/phase3/includes/specials/SpecialMergeHistory.php
===================================================================
--- trunk/phase3/includes/specials/SpecialMergeHistory.php 2011-05-28
16:18:40 UTC (rev 89042)
+++ trunk/phase3/includes/specials/SpecialMergeHistory.php 2011-05-28
16:31:00 UTC (rev 89043)
@@ -29,6 +29,10 @@
*/
class SpecialMergeHistory extends SpecialPage {
var $mAction, $mTarget, $mDest, $mTimestamp, $mTargetID, $mDestID,
$mComment;
+
+ /**
+ * @var Title
+ */
var $mTargetObj, $mDestObj;
public function __construct() {
Modified: trunk/phase3/includes/specials/SpecialTags.php
===================================================================
--- trunk/phase3/includes/specials/SpecialTags.php 2011-05-28 16:18:40 UTC
(rev 89042)
+++ trunk/phase3/includes/specials/SpecialTags.php 2011-05-28 16:31:00 UTC
(rev 89043)
@@ -63,8 +63,8 @@
}
function doTagRow( $tag, $hitcount ) {
- static $sk=null, $doneTags=array();
- if (!$sk) {
+ static $sk = null, $doneTags = array();
+ if ( !$sk ) {
global $wgUser;
$sk = $wgUser->getSkin();
}
_______________________________________________
MediaWiki-CVS mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-cvs
