wikimedia / mediawiki

includes/deferred/SearchUpdate.php

Doc Comments +1 added lines, -1 removed lines

@@ -46,7 +46,7 @@
 	 *
 	 * @param int $id Page id to update
 	 * @param Title|string $title Title of page to update
-	 * @param Content|string|bool $c Content of the page to update. Default: false.
+	 * @param Content|null $c Content of the page to update. Default: false.
 	 *  If a Content object, text will be gotten from it. String is for back-compat.
 	 *  Passing false tells the backend to just update the title, not the content
 	 */

includes/deferred/SiteStatsUpdate.php

Doc Comments +6 added lines

@@ -38,6 +38,12 @@
 	protected $images = 0;
 
 	// @todo deprecate this constructor
+
+	/**
+	 * @param integer $views
+	 * @param integer $edits
+	 * @param integer $good
+	 */
 	function __construct( $views, $edits, $good, $pages = 0, $users = 0 ) {
 		$this->edits = $edits;
 		$this->articles = $good;

includes/diff/DairikiDiff.php

Doc Comments +2 added lines, -1 removed lines

@@ -590,6 +590,7 @@ 
 	 * to be the "change".
 	 *
 	 * This is extracted verbatim from analyze.c (GNU diffutils-2.7).
+	 * @param string[] $lines
 	 */
 	private function shiftBoundaries( $lines, &$changed, $other_changed ) {
 		$i = 0;
@@ -750,7 +751,7 @@ 
 	 *    $diff = new Diff($lines1, $lines2);
 	 *    $rev = $diff->reverse();
 	 *
-	 * @return Object A Diff object representing the inverse of the
+	 * @return Diff A Diff object representing the inverse of the
 	 *   original diff.
 	 */
 	public function reverse() {

includes/diff/DifferenceEngine.php

Doc Comments +6 added lines, -6 removed lines

@@ -104,7 +104,7 @@ 
 	 * Constructor
 	 * @param IContextSource $context Context to use, anything else will be ignored
 	 * @param int $old Old ID we want to show and diff with.
-	 * @param string|int $new Either revision ID or 'prev' or 'next'. Default: 0.
+	 * @param integer $new Either revision ID or 'prev' or 'next'. Default: 0.
 	 * @param int $rcid Deprecated, no longer used!
 	 * @param bool $refreshCache If set, refreshes the diff cache
 	 * @param bool $unhide If set, allow viewing deleted revs
@@ -160,7 +160,7 @@ 
 	}
 
 	/**
-	 * @return bool|int
+	 * @return integer
 	 */
 	public function getNewid() {
 		$this->loadRevisionIds();
@@ -174,7 +174,7 @@ 
 	 *
 	 * @param int $id Revision ID
 	 *
-	 * @return mixed URL or false
+	 * @return string|false URL or false
 	 */
 	public function deletedLink( $id ) {
 		if ( $this->getUser()->isAllowed( 'deletedhistory' ) ) {
@@ -675,7 +675,7 @@ 
 	 * @param string|bool $ntitle Header for new text or false
 	 * @param string $notice HTML between diff header and body
 	 *
-	 * @return mixed
+	 * @return false|string
 	 */
 	public function getDiff( $otitle, $ntitle, $notice = '' ) {
 		$body = $this->getDiffBody();
@@ -697,7 +697,7 @@ 
 	/**
 	 * Get the diff table body, without header
 	 *
-	 * @return mixed (string/false)
+	 * @return false|string (string/false)
 	 */
 	public function getDiffBody() {
 		$this->mCacheHit = true;
@@ -931,7 +931,7 @@ 
 	 *
 	 * @param string $text
 	 *
-	 * @return mixed
+	 * @return string
 	 */
 	public function localiseLineNumbers( $text ) {
 		return preg_replace_callback(

includes/diff/TableDiffFormatter.php

Doc Comments +1 added lines, -1 removed lines

@@ -41,7 +41,7 @@
 	 * @static
 	 * @param string $msg
 	 *
-	 * @return mixed
+	 * @return string
 	 */
 	public static function escapeWhiteSpace( $msg ) {
 		$msg = preg_replace( '/^ /m', '  ', $msg );

includes/diff/WikiDiff3.php

Doc Comments +18 added lines

@@ -222,6 +222,13 @@ 
 		return $ranges;
 	}
 
+	/**
+	 * @param integer $bottoml1
+	 * @param integer $topl1
+	 * @param integer $bottoml2
+	 * @param integer $topl2
+	 * @param integer[] $snake
+	 */
 	private function lcs_rec( $bottoml1, $topl1, $bottoml2, $topl2, &$V, &$snake ) {
 		// check that both sequences are non-empty
 		if ( $bottoml1 > $topl1 || $bottoml2 > $topl2 ) {
@@ -490,6 +497,11 @@ 
 		*/
 	}
 
+	/**
+	 * @param double $M
+	 * @param double $N
+	 * @param double $limit
+	 */
 	private static function findMostProgress( $M, $N, $limit, $V ) {
 		$delta = $N - $M;
 
@@ -609,6 +621,12 @@ 
 	/** @var int */
 	public $rightlength;
 
+	/**
+	 * @param integer $leftstart
+	 * @param integer $leftend
+	 * @param integer $rightstart
+	 * @param integer $rightend
+	 */
 	function __construct( $leftstart, $leftend, $rightstart, $rightend ) {
 		$this->leftstart = $leftstart;
 		$this->leftend = $leftend;

includes/EditPage.php

Doc Comments +14 added lines, -7 removed lines

@@ -2169,7 +2169,7 @@ 
 	 *
 	 * @param string $text
 	 *
-	 * @return string|bool Matching string or false
+	 * @return string|false Matching string or false
 	 */
 	public static function matchSpamRegex( $text ) {
 		global $wgSpamRegex;
@@ -2183,7 +2183,7 @@ 
 	 *
 	 * @param string $text
 	 *
-	 * @return string|bool Matching string or false
+	 * @return string|false Matching string or false
 	 */
 	public static function matchSummarySpamRegex( $text ) {
 		global $wgSummarySpamRegex;
@@ -2194,7 +2194,7 @@ 
 	/**
 	 * @param string $text
 	 * @param array $regexes
-	 * @return bool|string
+	 * @return string|false
 	 */
 	protected static function matchSpamRegexInternal( $text, $regexes ) {
 		foreach ( $regexes as $regex ) {
@@ -2437,7 +2437,7 @@ 
 	 * $this->allowNonTextContent to true to allow editing of non-textual
 	 * content.
 	 *
-	 * @param string|null|bool $text Text to unserialize
+	 * @param false|string $text Text to unserialize
 	 * @return Content The content object created from $text. If $text was false
 	 *   or null, false resp. null will be  returned instead.
 	 *
@@ -3128,6 +3128,10 @@ 
 		$this->showTextbox( $this->textbox2, 'wpTextbox2', array( 'tabindex' => 6, 'readonly' ) );
 	}
 
+	/**
+	 * @param string $text
+	 * @param string $name
+	 */
 	protected function showTextbox( $text, $name, $customAttribs = array() ) {
 		global $wgOut, $wgUser;
 
@@ -3157,6 +3161,9 @@ 
 		$wgOut->addHTML( Html::textarea( $name, $wikitext, $attribs ) );
 	}
 
+	/**
+	 * @param string $previewOutput
+	 */
 	protected function displayPreviewArea( $previewOutput, $isOnTop = false ) {
 		global $wgOut;
 		$classes = array();
@@ -3763,7 +3770,7 @@ 
 	 * Shows a bulletin board style toolbar for common editing functions.
 	 * It can be disabled in the user preferences.
 	 *
-	 * @param $title Title object for the page being edited (optional)
+	 * @param Title $title Title object for the page being edited (optional)
 	 * @return string
 	 */
 	static function getEditToolbar( $title = null ) {
@@ -3903,7 +3910,7 @@ 
 	 * @param array $checked Array of checkbox => bool, where bool indicates the checked
 	 *                 status of the checkbox
 	 *
-	 * @return array
+	 * @return string
 	 */
 	public function getCheckboxes( &$tabindex, $checked ) {
 		global $wgUser, $wgUseMediaWikiUIEverywhere;
@@ -3967,7 +3974,7 @@ 
 	 *
 	 * @param int $tabindex Current tabindex
 	 *
-	 * @return array
+	 * @return string
 	 */
 	public function getEditButtons( &$tabindex ) {
 		$buttons = array();

includes/exception/BadTitleError.php

Doc Comments +1 added lines, -1 removed lines

@@ -28,7 +28,7 @@
  */
 class BadTitleError extends ErrorPageError {
 	/**
-	 * @param string|Message|MalformedTitleException $msg A message key (default: 'badtitletext'), or
+	 * @param MalformedTitleException $msg A message key (default: 'badtitletext'), or
 	 *     a MalformedTitleException to figure out things from
 	 * @param array $params Parameter to wfMessage()
 	 */

includes/exception/MWException.php

Doc Comments +4 added lines

@@ -265,6 +265,10 @@
 			header( $header );
 		}
 	}
+
+	/**
+	 * @param integer $code
+	 */
 	private static function statusHeader( $code ) {
 		if ( !headers_sent() ) {
 			HttpStatus::header( $code );