wikimedia / mediawiki

includes/specials/SpecialUndelete.php

Doc Comments +13 added lines, -3 removed lines

@@ -39,6 +39,9 @@ 
 	/** @var Config */
 	protected $config;
 
+	/**
+	 * @param null|Title $title
+	 */
 	function __construct( $title, Config $config = null ) {
 		if ( is_null( $title ) ) {
 			throw new MWException( __METHOD__ . ' given a null title.' );
@@ -913,6 +916,9 @@ 
 		return true;
 	}
 
+	/**
+	 * @param string|boolean $timestamp
+	 */
 	private function showRevision( $timestamp ) {
 		if ( !preg_match( '/[0-9]{14}/', $timestamp ) ) {
 			return;
@@ -1388,6 +1394,10 @@ 
 		return true;
 	}
 
+	/**
+	 * @param string|null $earliestLiveTime
+	 * @param integer $remaining
+	 */
 	protected function formatRevisionRow( $row, $earliestLiveTime, $remaining ) {
 		$rev = Revision::newFromArchiveRow( $row,
 			array(
@@ -1563,7 +1573,7 @@ 
 	/**
 	 * Fetch image view link if it's available to all users
 	 *
-	 * @param File|ArchivedFile $file
+	 * @param ArchivedFile $file
 	 * @param Title $titleObj
 	 * @param string $ts A timestamp
 	 * @param string $key A storage key
@@ -1599,7 +1609,7 @@ 
 	/**
 	 * Fetch file's user id if it's available to this user
 	 *
-	 * @param File|ArchivedFile $file
+	 * @param ArchivedFile $file
 	 * @return string HTML fragment
 	 */
 	function getFileUser( $file ) {
@@ -1622,7 +1632,7 @@ 
 	/**
 	 * Fetch file upload comment if it's available to this user
 	 *
-	 * @param File|ArchivedFile $file
+	 * @param ArchivedFile $file
 	 * @return string HTML fragment
 	 */
 	function getFileComment( $file ) {

includes/specials/SpecialUpload.php

Doc Comments +1 added lines, -1 removed lines

@@ -214,7 +214,7 @@
 	/**
 	 * Show the main upload form
 	 *
-	 * @param HTMLForm|string $form An HTMLForm instance or HTML string to show
+	 * @param UploadForm $form An HTMLForm instance or HTML string to show
 	 */
 	protected function showUploadForm( $form ) {
 		# Add links if file was previously deleted

includes/specials/SpecialUploadStash.php

Doc Comments +3 added lines, -3 removed lines

@@ -57,7 +57,7 @@ 
 	 *
 	 * @param string $subPage Subpage, e.g. in
 	 *   http://example.com/wiki/Special:UploadStash/foo.jpg, the "foo.jpg" part
-	 * @return bool Success
+	 * @return boolean|null Success
 	 */
 	public function execute( $subPage ) {
 		$this->useTransactionalTimeLimit();
@@ -78,7 +78,7 @@ 
 	 *
 	 * @param string $key The key of a particular requested file
 	 * @throws HttpError
-	 * @return bool
+	 * @return boolean|null
 	 */
 	public function showUpload( $key ) {
 		// prevent callers from doing standard HTML output -- we'll take it from here
@@ -157,7 +157,7 @@ 
 	 * @param File $file
 	 * @param array $params
 	 *
-	 * @return bool Success
+	 * @return boolean|null Success
 	 */
 	private function outputThumbFromStash( $file, $params ) {
 		$flags = 0;

includes/specials/SpecialUserrights.php

Doc Comments +1 added lines, -1 removed lines

@@ -308,7 +308,7 @@
 	 * @param User $user
 	 * @param array $oldGroups
 	 * @param array $newGroups
-	 * @param array $reason
+	 * @param string $reason
 	 */
 	function addLogEntry( $user, $oldGroups, $newGroups, $reason ) {
 		$logEntry = new ManualLogEntry( 'rights', 'rights' );

includes/specials/SpecialVersion.php

Doc Comments +7 added lines, -3 removed lines

@@ -360,7 +360,7 @@ 
 
 	/**
 	 * @since 1.22 Returns the HEAD date in addition to the sha1 and link
-	 * @return bool|string Global wgVersion + HEAD sha1 stripped to the first 7 chars
+	 * @return false|string Global wgVersion + HEAD sha1 stripped to the first 7 chars
 	 *   with link and date, or false on failure
 	 */
 	private static function getVersionLinkedGit() {
@@ -934,6 +934,10 @@ 
 		}
 	}
 
+	/**
+	 * @param string $text
+	 * @param string $name
+	 */
 	private function openExtType( $text = null, $name = null ) {
 		$out = '';
 
@@ -1052,7 +1056,7 @@ 
 	 *
 	 * @since 1.23
 	 *
-	 * @return bool|string False if no such file exists, otherwise returns
+	 * @return false|string False if no such file exists, otherwise returns
 	 * a path to it.
 	 */
 	public static function getExtAuthorsFileName( $extDir ) {
@@ -1081,7 +1085,7 @@ 
 	 *
 	 * @since 1.23
 	 *
-	 * @return bool|string False if no such file exists, otherwise returns
+	 * @return false|string False if no such file exists, otherwise returns
 	 * a path to it.
 	 */
 	public static function getExtLicenseFileName( $extDir ) {

includes/specials/SpecialWatchlist.php

Doc Comments +7 added lines, -1 removed lines

@@ -293,6 +293,9 @@ 
 		);
 	}
 
+	/**
+	 * @param FormOptions $opts
+	 */
 	protected function runMainQueryHook( &$tables, &$fields, &$conds, &$query_options,
 		&$join_conds, $opts
 	) {
@@ -516,6 +519,9 @@ 
 		$this->setBottomText( $opts );
 	}
 
+	/**
+	 * @param FormOptions $options
+	 */
 	function cutoffselector( $options ) {
 		// Cast everything to strings immediately, so that we know all of the values have the same
 		// precision, and can be compared with '==='. 2/24 has a few more decimal places than its
@@ -625,7 +631,7 @@ 
 	 * Count the number of items on a user's watchlist
 	 *
 	 * @param IDatabase $dbr A database connection
-	 * @return int
+	 * @return double
 	 */
 	protected function countItems( $dbr ) {
 		# Fetch the raw count

includes/specials/SpecialWhatlinkshere.php

Doc Comments +13 added lines

@@ -303,10 +303,17 @@ 
 		}
 	}
 
+	/**
+	 * @param integer $level
+	 */
 	protected function listStart( $level ) {
 		return Xml::openElement( 'ul', ( $level ? array() : array( 'id' => 'mw-whatlinkshere-list' ) ) );
 	}
 
+	/**
+	 * @param Title $nt
+	 * @param Title $target
+	 */
 	protected function listItem( $row, $nt, $target, $notClose = false ) {
 		$dirmark = $this->getLanguage()->getDirMark();
 
@@ -405,6 +412,9 @@ 
 		return $this->getLanguage()->pipeList( $links );
 	}
 
+	/**
+	 * @param string $text
+	 */
 	function makeSelfLink( $text, $query ) {
 		return Linker::linkKnown(
 			$this->selfTitle,
@@ -414,6 +424,9 @@ 
 		);
 	}
 
+	/**
+	 * @param integer $prevId
+	 */
 	function getPrevNext( $prevId, $nextId ) {
 		$currentLimit = $this->opts->getValue( 'limit' );
 		$prev = $this->msg( 'whatlinkshere-prev' )->numParams( $currentLimit )->escaped();

includes/TitleArrayFromResult.php

Doc Comments +3 added lines

@@ -32,6 +32,9 @@
 
 	public $current;
 
+	/**
+	 * @param ResultWrapper $res
+	 */
 	function __construct( $res ) {
 		$this->res = $res;
 		$this->key = 0;

includes/upload/UploadBase.php

Doc Comments +2 added lines, -3 removed lines

@@ -265,7 +265,7 @@ 
 
 	/**
 	 * @param string $srcPath The source path
-	 * @return string|bool The real path if it was a virtual URL Returns false on failure
+	 * @return string|false The real path if it was a virtual URL Returns false on failure
 	 */
 	function getRealPath( $srcPath ) {
 		$repo = RepoGroup::singleton()->getLocalRepo();
@@ -1513,7 +1513,6 @@ 
 	 * Check a block of CSS or CSS fragment for anything that looks like
 	 * it is bringing in remote code.
 	 * @param string $value a string of CSS
-	 * @param bool $propOnly only check css properties (start regex with :)
 	 * @return bool true if the CSS contains an illegal string, false if otherwise
 	 */
 	private static function checkCssFragment( $value ) {
@@ -1887,7 +1886,7 @@ 
 	 * format, presumably.
 	 *
 	 * @param ApiResult $result
-	 * @return array Image info
+	 * @return User Image info
 	 */
 	public function getImageInfo( $result ) {
 		$file = $this->getLocalFile();