wikimedia / mediawiki

includes/installer/Installer.php

Doc Comments +6 added lines, -6 removed lines

@@ -578,7 +578,7 @@ 
 	 * fake password in which case leave it as it is.
 	 *
 	 * @param string $name
-	 * @param mixed $value
+	 * @param string $value
 	 */
 	public function setPassword( $name, $value ) {
 		if ( !preg_match( '/^\*+$/', $value ) ) {
@@ -1266,7 +1266,7 @@ 
 	 *
 	 * If $versionInfo is not false, only executables with a version
 	 * matching $versionInfo[1] will be returned.
-	 * @return bool|string
+	 * @return string|false
 	 */
 	public static function locateExecutable( $path, $names, $versionInfo = false ) {
 		if ( !is_array( $names ) ) {
@@ -1298,14 +1298,14 @@ 
 	/**
 	 * Same as locateExecutable(), but checks in getPossibleBinPaths() by default
 	 * @see locateExecutable()
-	 * @param array $names Array of possible names.
-	 * @param array|bool $versionInfo Default: false or array with two members:
+	 * @param string[] $names Array of possible names.
+	 * @param string[] $versionInfo Default: false or array with two members:
 	 *   0 => Command to run for version check, with $1 for the full executable name
 	 *   1 => String to compare the output with
 	 *
 	 * If $versionInfo is not false, only executables with a version
 	 * matching $versionInfo[1] will be returned.
-	 * @return bool|string
+	 * @return string|false
 	 */
 	public static function locateExecutableInDefaultPaths( $names, $versionInfo = false ) {
 		foreach ( self::getPossibleBinPaths() as $path ) {
@@ -1324,7 +1324,7 @@ 
 	 * Used only by environment checks.
 	 * @param string $dir
 	 * @param string $url
-	 * @return bool|int|string
+	 * @return string|false
 	 */
 	public function dirIsExecutable( $dir, $url ) {
 		$scriptTypes = array(

includes/skins/Skin.php

Doc Comments +2 added lines, -2 removed lines

@@ -1006,7 +1006,7 @@ 
 	}
 
 	/**
-	 * @param User|int $id
+	 * @param User $id
 	 * @return bool
 	 */
 	function showEmailUser( $id ) {
@@ -1469,7 +1469,7 @@ 
 	 * Get a cached notice
 	 *
 	 * @param string $name Message name, or 'default' for $wgSiteNotice
-	 * @return string|bool HTML fragment, or false to indicate that the caller
+	 * @return false|string HTML fragment, or false to indicate that the caller
 	 *   should fall back to the next notice in its sequence
 	 */
 	private function getCachedNotice( $name ) {

includes/Sanitizer.php

Doc Comments +4 added lines, -4 removed lines

@@ -1206,7 +1206,7 @@ 
 	 * @since 1.27
 	 *
 	 * @param string $referenceString Space delimited list of ids
-	 * @param string|array $options String or array of strings (default is array()):
+	 * @param string $options String or array of strings (default is array()):
 	 *   'noninitial': This is a non-initial fragment of an id, not a full id,
 	 *       so don't pay attention if the first character isn't valid at the
 	 *       beginning of an id.  Only matters if $wgExperimentalHtmlIds is
@@ -1334,7 +1334,7 @@ 
 	 * Pick the appropriate attribute value from a match set from the
 	 * attribs regex matches.
 	 *
-	 * @param array $set
+	 * @param string[] $set
 	 * @throws MWException When tag conditions are not met.
 	 * @return string
 	 */
@@ -1850,7 +1850,7 @@ 
 
 	/**
 	 * @param string $url
-	 * @return mixed|string
+	 * @return string
 	 */
 	static function cleanUrl( $url ) {
 		# Normalize any HTML entities in input. They will be
@@ -1936,7 +1936,7 @@ 
 	 * @since 1.18
 	 *
 	 * @param string $addr E-mail address
-	 * @return bool
+	 * @return null|boolean
 	 */
 	public static function validateEmail( $addr ) {
 		$result = null;

includes/tidy/Balancer.php

Doc Comments +18 added lines, -3 removed lines

@@ -751,7 +751,7 @@ 
 
 	/**
 	 * Determine if the stack has $tag in button scope.
-	 * @param BalanceElement|array|string $tag
+	 * @param string $tag
 	 * @return bool
 	 * @see https://html.spec.whatwg.org/multipage/syntax.html#has-an-element-in-button-scope
 	 */
@@ -831,6 +831,7 @@ 
 
 	/**
 	 * Return the adjusted current node.
+	 * @param BalanceElement|null $fragmentContext
 	 */
 	public function adjustedCurrentNode( $fragmentContext ) {
 		return ( $fragmentContext && $this->length() === 1 ) ?
@@ -840,7 +841,7 @@ 
 	/**
 	 * Return an iterator over this stack which visits the current node
 	 * first, and the root node last.
-	 * @return Iterator
+	 * @return ReverseArrayIterator
 	 */
 	public function getIterator() {
 		return new ReverseArrayIterator( $this->elements );
@@ -1063,7 +1064,7 @@ 
 	 * @param string $tag The subject tag name.
 	 * @param BalanceActiveFormattingElements $afe The current
 	 *   active formatting elements list.
-	 * @return true if the adoption agency algorithm "did something", false
+	 * @return boolean if the adoption agency algorithm "did something", false
 	 *   if more processing is required by the caller.
 	 * @see https://html.spec.whatwg.org/multipage/syntax.html#adoption-agency-algorithm
 	 */
@@ -1441,6 +1442,7 @@ 
 	 * Find and return the last element with the specified tag between the
 	 * end of the list and the last marker on the list.
 	 * Used when parsing <a> "in body mode".
+	 * @param string $tag
 	 */
 	public function findElementByTag( $tag ) {
 		$elt = $this->tail;
@@ -1588,6 +1590,10 @@ 
 	 * @see https://html.spec.whatwg.org/multipage/syntax.html#reconstruct-the-active-formatting-elements
 	 */
 	// @codingStandardsIgnoreEnd
+
+	/**
+	 * @param BalanceStack|null $stack
+	 */
 	public function reconstruct( $stack ) {
 		$entry = $this->tail;
 		// If there are no entries in the list of active formatting elements,
@@ -2051,6 +2057,10 @@ 
 		return $oldMode;
 	}
 
+	/**
+	 * @param string $mode
+	 * @param boolean $selfclose
+	 */
 	private function switchModeAndReprocess( $mode, $token, $value, $attribs, $selfclose ) {
 		$this->switchMode( $mode );
 		return $this->insertToken( $token, $value, $attribs, $selfclose );
@@ -3080,6 +3090,11 @@ 
 			return false;
 		}
 	}
+
+	/**
+	 * @param string $token
+	 * @param string $value
+	 */
 	private function inCellMode( $token, $value, $attribs = null, $selfclose = false ) {
 		if ( $token === 'tag' ) {
 			switch ( $value ) {

includes/Category.php

Doc Comments +7 added lines, -7 removed lines

@@ -205,42 +205,42 @@ 
 	}
 
 	/**
-	 * @return mixed DB key name, or false on failure
+	 * @return boolean DB key name, or false on failure
 	 */
 	public function getName() {
 		return $this->getX( 'mName' );
 	}
 
 	/**
-	 * @return mixed Category ID, or false on failure
+	 * @return boolean Category ID, or false on failure
 	 */
 	public function getID() {
 		return $this->getX( 'mID' );
 	}
 
 	/**
-	 * @return mixed Total number of member pages, or false on failure
+	 * @return boolean Total number of member pages, or false on failure
 	 */
 	public function getPageCount() {
 		return $this->getX( 'mPages' );
 	}
 
 	/**
-	 * @return mixed Number of subcategories, or false on failure
+	 * @return boolean Number of subcategories, or false on failure
 	 */
 	public function getSubcatCount() {
 		return $this->getX( 'mSubcats' );
 	}
 
 	/**
-	 * @return mixed Number of member files, or false on failure
+	 * @return boolean Number of member files, or false on failure
 	 */
 	public function getFileCount() {
 		return $this->getX( 'mFiles' );
 	}
 
 	/**
-	 * @return Title|bool Title for this category, or false on failure.
+	 * @return Title Title for this category, or false on failure.
 	 */
 	public function getTitle() {
 		if ( $this->mTitle ) {
@@ -260,7 +260,7 @@ 
 	 * category sort key $offset.
 	 * @param int $limit
 	 * @param string $offset
-	 * @return TitleArray TitleArray object for category members.
+	 * @return TitleArrayFromResult|null TitleArray object for category members.
 	 */
 	public function getMembers( $limit = false, $offset = '' ) {
 

includes/db/Database.php

Doc Comments +5 added lines, -5 removed lines

@@ -651,7 +651,7 @@ 
 	}
 
 	/**
-	 * @return bool|string
+	 * @return string|false
 	 */
 	protected function restoreErrorHandler() {
 		restore_error_handler();
@@ -1103,7 +1103,7 @@ 
 	 *
 	 * @param array $options Associative array of options to be turned into
 	 *   an SQL query, valid keys are listed in the function.
-	 * @return array
+	 * @return string[]
 	 * @see DatabaseBase::select()
 	 */
 	public function makeSelectOptions( $options ) {
@@ -2959,8 +2959,8 @@ 
 	 * on object's error ignore settings).
 	 *
 	 * @param string $filename File name to open
-	 * @param bool|callable $lineCallback Optional function called before reading each line
-	 * @param bool|callable $resultCallback Optional function called for each MySQL result
+	 * @param boolean $lineCallback Optional function called before reading each line
+	 * @param boolean $resultCallback Optional function called for each MySQL result
 	 * @param bool|string $fname Calling function name or false if name should be
 	 *   generated dynamically using $filename
 	 * @param bool|callable $inputCallback Optional function called for each
@@ -3291,7 +3291,7 @@ 
 	}
 
 	/**
-	 * @return string|bool Reason this DB is read-only or false if it is not
+	 * @return string|false Reason this DB is read-only or false if it is not
 	 */
 	protected function getReadOnlyReason() {
 		$reason = $this->getLBInfo( 'readOnlyReason' );

includes/db/DatabaseMysqlBase.php

Doc Comments +10 added lines, -4 removed lines

@@ -376,7 +376,7 @@ 
 	/**
 	 * Get the name of the specified field in a result
 	 *
-	 * @param ResultWrapper|resource $res
+	 * @param resource $res
 	 * @param int $n
 	 * @return string
 	 */
@@ -399,7 +399,7 @@ 
 	/**
 	 * Get the type of the specified field in a result
 	 *
-	 * @param ResultWrapper|resource $res
+	 * @param resource $res
 	 * @param int $n
 	 * @return string
 	 */
@@ -421,7 +421,7 @@ 
 	/**
 	 * Move internal result pointer
 	 *
-	 * @param ResultWrapper|resource $res
+	 * @param resource $res
 	 * @param int $row
 	 * @return bool
 	 */
@@ -835,7 +835,7 @@ 
 	/**
 	 * Get the position of the master from SHOW SLAVE STATUS
 	 *
-	 * @return MySQLMasterPos|bool
+	 * @return DBMasterPos
 	 */
 	function getSlavePos() {
 		$res = $this->query( 'SHOW SLAVE STATUS', __METHOD__ );
@@ -1016,6 +1016,9 @@ 
 		return false;
 	}
 
+	/**
+	 * @param string $lockName
+	 */
 	private function makeLockName( $lockName ) {
 		// http://dev.mysql.com/doc/refman/5.7/en/miscellaneous-functions.html#function_get-lock
 		// Newer version enforce a 64 char length limit.
@@ -1371,6 +1374,9 @@ 
 		$is_pk, $is_unique, $is_multiple, $is_key, $type, $binary,
 		$is_numeric, $is_blob, $is_unsigned, $is_zerofill;
 
+	/**
+	 * @param stdClass $info
+	 */
 	function __construct( $info ) {
 		$this->name = $info->name;
 		$this->tablename = $info->table;

includes/diff/DifferenceEngine.php

Doc Comments +5 added lines, -5 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
@@ -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' ) ) {
@@ -676,7 +676,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();
@@ -698,7 +698,7 @@ 
 	/**
 	 * Get the diff table body, without header
 	 *
-	 * @return mixed (string/false)
+	 * @return false|string (string/false)
 	 */
 	public function getDiffBody() {
 		$this->mCacheHit = true;
@@ -973,7 +973,7 @@ 
 	 *
 	 * @param string $text
 	 *
-	 * @return mixed
+	 * @return string
 	 */
 	public function localiseLineNumbers( $text ) {
 		return preg_replace_callback(

includes/filebackend/FileBackend.php

Doc Comments +1 added lines, -1 removed lines

@@ -192,7 +192,7 @@
 	/**
 	 * Get an explanatory message if this backend is read-only
 	 *
-	 * @return string|bool Returns false if the backend is not read-only
+	 * @return string|false Returns false if the backend is not read-only
 	 */
 	final public function getReadOnlyReason() {
 		return ( $this->readOnly != '' ) ? $this->readOnly : false;