wikimedia / mediawiki

includes/specials/SpecialRandomInCategory.php

Doc Comments +2 added lines, -2 removed lines

@@ -189,7 +189,7 @@ 
 	 * @param float $rand Random number between 0 and 1
 	 * @param int $offset Extra offset to fudge randomness
 	 * @param bool $up True to get the result above the random number, false for below
-	 * @return array Query information.
+	 * @return string Query information.
 	 * @throws MWException
 	 * @note The $up parameter is supposed to counteract what would happen if there
 	 *   was a large gap in the distribution of cl_timestamp values. This way instead
@@ -231,7 +231,7 @@ 
 	/**
 	 * @param float $rand Random number between 0 and 1
 	 *
-	 * @return int|bool A random (unix) timestamp from the range of the category or false on failure
+	 * @return integer A random (unix) timestamp from the range of the category or false on failure
 	 */
 	protected function getTimestampOffset( $rand ) {
 		if ( $rand === false ) {

includes/specials/SpecialRandompage.php

Doc Comments +3 added lines

@@ -158,6 +158,9 @@
 		);
 	}
 
+	/**
+	 * @param string $randstr
+	 */
 	private function selectRandomPageFromDB( $randstr, $fname = __METHOD__ ) {
 		$dbr = wfGetDB( DB_SLAVE );
 

includes/specials/SpecialRecentchanges.php

Doc Comments +3 added lines, -3 removed lines

@@ -173,7 +173,7 @@ 
 	 * Return an array of conditions depending of options set in $opts
 	 *
 	 * @param FormOptions $opts
-	 * @return array
+	 * @return string[]
 	 */
 	public function buildMainQueryConds( FormOptions $opts ) {
 		$dbr = $this->getDB();
@@ -535,7 +535,7 @@ 
 	 * Creates the choose namespace selection
 	 *
 	 * @param FormOptions $opts
-	 * @return string
+	 * @return string[]
 	 */
 	protected function namespaceFilterForm( FormOptions $opts ) {
 		$nsSelect = Html::namespaceSelector(
@@ -561,7 +561,7 @@ 
 	 * Create an input to filter changes by categories
 	 *
 	 * @param FormOptions $opts
-	 * @return array
+	 * @return string[]
 	 */
 	protected function categoryFilterForm( FormOptions $opts ) {
 		list( $label, $input ) = Xml::inputLabelSep( $this->msg( 'rc_categories' )->text(),

includes/specials/SpecialSearch.php

Doc Comments +2 added lines, -2 removed lines

@@ -889,7 +889,7 @@ 
 	/**
 	 * Show results from other wikis
 	 *
-	 * @param SearchResultSet|array $matches
+	 * @param SearchResultSet|null $matches
 	 * @param string $query
 	 *
 	 * @return string
@@ -1348,7 +1348,7 @@ 
 	 * @since 1.18
 	 *
 	 * @param string $key
-	 * @param mixed $value
+	 * @param string $value
 	 */
 	public function setExtraParam( $key, $value ) {
 		$this->extraParams[$key] = $value;

includes/specials/SpecialTags.php

Doc Comments +11 added lines

@@ -170,6 +170,10 @@ 
 		) );
 	}
 
+	/**
+	 * @param boolean $showActions
+	 * @param boolean $showEditLinks
+	 */
 	function doTagRow( $tag, $hitcount, $showActions, $showEditLinks ) {
 		$newRow = '';
 		$newRow .= Xml::tags( 'td', null, Xml::element( 'code', null, $tag ) );
@@ -317,6 +321,9 @@ 
 		}
 	}
 
+	/**
+	 * @param null|string $tag
+	 */
 	protected function showDeleteTagForm( $tag ) {
 		$user = $this->getUser();
 		if ( !$user->isAllowed( 'managechangetags' ) ) {
@@ -375,6 +382,10 @@ 
 		$form->show();
 	}
 
+	/**
+	 * @param null|string $tag
+	 * @param boolean $activate
+	 */
 	protected function showActivateDeactivateForm( $tag, $activate ) {
 		$actionStr = $activate ? 'activate' : 'deactivate';
 

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/SpecialUserlogin.php

Doc Comments +3 added lines, -3 removed lines

@@ -136,7 +136,7 @@ 
 	/**
 	 * Returns an array of all valid error messages.
 	 *
-	 * @return array
+	 * @return string[]
 	 */
 	public static function getValidErrorMessages() {
 		static $messages = null;
@@ -1222,7 +1222,7 @@ 
 	 * Display a "successful action" page.
 	 *
 	 * @param string $type Condition of return to; see `executeReturnTo`
-	 * @param string|Message $title Page's title
+	 * @param Message $title Page's title
 	 * @param string $msgname
 	 * @param string $injected_html
 	 */
@@ -1735,7 +1735,7 @@ 
 	 * Private function to check password expiration, until AuthManager comes
 	 * along to handle that.
 	 * @param User $user
-	 * @return string|bool
+	 * @return string|false
 	 */
 	private function checkUserPasswordExpired( User $user ) {
 		global $wgPasswordExpireGrace;