wikimedia / mediawiki

includes/resourceloader/ResourceLoaderModule.php

Doc Comments +2 added lines, -2 removed lines

@@ -87,7 +87,7 @@ 
 	 * Get this module's name. This is set when the module is registered
 	 * with ResourceLoader::register()
 	 *
-	 * @return string|null Name (string) or null if no name was set
+	 * @return string Name (string) or null if no name was set
 	 */
 	public function getName() {
 		return $this->name;
@@ -209,7 +209,7 @@ 
 	 * MUST return either an only= URL or a non-load.php URL.
 	 *
 	 * @param ResourceLoaderContext $context
-	 * @return array Array of URLs
+	 * @return string[] Array of URLs
 	 */
 	public function getScriptURLsForDebug( ResourceLoaderContext $context ) {
 		$resourceLoader = $context->getResourceLoader();

includes/Sanitizer.php

Doc Comments +6 added lines, -6 removed lines

@@ -449,7 +449,7 @@ 
 	 *   replacements in HTML attribute values
 	 * @param array|bool $args Arguments for the processing callback
 	 * @param array $extratags For any extra tags to include
-	 * @param array $removetags For any tags (default or extra) to exclude
+	 * @param string[] $removetags For any tags (default or extra) to exclude
 	 * @return string
 	 */
 	public static function removeHTMLtags( $text, $processCallback = null,
@@ -1171,7 +1171,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
@@ -1246,7 +1246,7 @@ 
 	 * character references are decoded to UTF-8 text.
 	 *
 	 * @param string $text
-	 * @return array
+	 * @return callable
 	 */
 	public static function decodeTagAttributes( $text ) {
 		if ( trim( $text ) == '' ) {
@@ -1299,7 +1299,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
 	 */
@@ -1819,7 +1819,7 @@ 
 
 	/**
 	 * @param string $url
-	 * @return mixed|string
+	 * @return string
 	 */
 	static function cleanUrl( $url ) {
 		# Normalize any HTML entities in input. They will be
@@ -1905,7 +1905,7 @@ 
 	 * @since 1.18
 	 *
 	 * @param string $addr E-mail address
-	 * @return bool
+	 * @return null|boolean
 	 */
 	public static function validateEmail( $addr ) {
 		$result = null;

includes/search/SearchEngine.php

Doc Comments +4 added lines, -3 removed lines

@@ -95,8 +95,8 @@ 
 	 * Way to pass custom data for engines
 	 * @since 1.18
 	 * @param string $feature
-	 * @param mixed $data
-	 * @return bool
+	 * @param boolean $data
+	 * @return boolean|null
 	 */
 	public function setFeatureData( $feature, $data ) {
 		$this->features[$feature] = $data;
@@ -428,7 +428,7 @@ 
 	/**
 	 * Find snippet highlight settings for all users
 	 *
-	 * @return array Contextlines, contextchars
+	 * @return integer[] Contextlines, contextchars
 	 */
 	public static function userHighlightPrefs() {
 		$contextlines = 2; // Hardcode this. Old defaults sucked. :)
@@ -705,6 +705,7 @@ 
 	 * Process completion search results.
 	 * Resolves the titles and rescores.
 	 * @param SearchSuggestionSet $suggestions
+	 * @param string $search
 	 * @return SearchSuggestionSet
 	 */
 	protected function processCompletionResults( $search, SearchSuggestionSet $suggestions ) {

includes/search/SearchSuggestion.php

Doc Comments +1 added lines, -1 removed lines

@@ -55,9 +55,9 @@
 	/**
 	 * Construct a new suggestion
 	 * @param float $score the suggestion score
-	 * @param string $text|null the suggestion text
 	 * @param Title|null $suggestedTitle the suggested title
 	 * @param int|null $suggestedTitleID the suggested title ID
+	 * @param string $text
 	 */
 	public function __construct( $score, $text = null, Title $suggestedTitle = null,
 			$suggestedTitleID = null ) {

includes/Title.php

Doc Comments +13 added lines, -14 removed lines

@@ -383,7 +383,7 @@ 
 	 * objects or LinkCache entries. Uses $wgContentHandlerUseDB to determine
 	 * whether to include page_content_model.
 	 *
-	 * @return array
+	 * @return string[]
 	 */
 	protected static function getSelectFields() {
 		global $wgContentHandlerUseDB, $wgPageLanguageUseDB;
@@ -627,7 +627,7 @@ 
 	 * Get the prefixed DB key associated with an ID
 	 *
 	 * @param int $id The page_id of the article
-	 * @return Title|null An object representing the article, or null if no such article was found
+	 * @return null|string An object representing the article, or null if no such article was found
 	 */
 	public static function nameOf( $id ) {
 		$dbr = wfGetDB( DB_SLAVE );
@@ -913,7 +913,7 @@ 
 	 * (e.g. TitleValues cannot represent page-local links that have a
 	 * fragment but no title text).
 	 *
-	 * @return TitleValue|null
+	 * @return TitleValue
 	 */
 	public function getTitleValue() {
 		if ( $this->mTitleValue === null ) {
@@ -1144,7 +1144,6 @@ 
 	/**
 	 * Returns true if the title is inside one of the specified namespaces.
 	 *
-	 * @param int $namespaces,... The namespaces to check for
 	 * @return bool
 	 * @since 1.19
 	 */
@@ -1935,7 +1934,7 @@ 
 	 *   - quick  : does cheap permission checks from slaves (usable for GUI creation)
 	 *   - full   : does cheap and expensive checks possibly from a slave
 	 *   - secure : does cheap and expensive checks, using the master as needed
-	 * @param array $ignoreErrors Array of Strings Set this to a list of message keys
+	 * @param string[] $ignoreErrors Array of Strings Set this to a list of message keys
 	 *   whose corresponding errors may be ignored.
 	 * @return array Array of arrays of the arguments to wfMessage to explain permissions problems.
 	 */
@@ -2036,7 +2035,7 @@ 
 	 * Add the resulting error code to the errors array
 	 *
 	 * @param array $errors List of current errors
-	 * @param array $result Result of errors
+	 * @param string $result Result of errors
 	 *
 	 * @return array List of errors
 	 */
@@ -2427,7 +2426,7 @@ 
 	 *
 	 * @param string $action The action to check
 	 * @param bool $short Short circuit on first error
-	 * @return array List of errors
+	 * @return string[] List of errors
 	 */
 	private function missingPermissionError( $action, $short ) {
 		// We avoid expensive display logic for quickUserCan's and such
@@ -3949,7 +3948,7 @@ 
 	 *
 	 * @param int $revId Revision ID. Get the revision that was before this one.
 	 * @param int $flags Title::GAID_FOR_UPDATE
-	 * @return int|bool Old revision ID, or false if none exists
+	 * @return integer Old revision ID, or false if none exists
 	 */
 	public function getPreviousRevisionID( $revId, $flags = 0 ) {
 		$db = ( $flags & self::GAID_FOR_UPDATE ) ? wfGetDB( DB_MASTER ) : wfGetDB( DB_SLAVE );
@@ -4089,8 +4088,8 @@ 
 	 * Get the number of revisions between the given revision.
 	 * Used for diffs and other things that really need it.
 	 *
-	 * @param int|Revision $old Old revision or rev ID (first before range)
-	 * @param int|Revision $new New revision or rev ID (first after range)
+	 * @param Revision $old Old revision or rev ID (first before range)
+	 * @param Revision $new New revision or rev ID (first after range)
 	 * @param int|null $max Limit of Revisions to count, will be incremented to detect truncations
 	 * @return int Number of revisions between these revisions.
 	 */
@@ -4202,9 +4201,9 @@ 
 	 * Used for diffs and other things that really need it.
 	 *
 	 * @param int|Revision $old Old revision or rev ID (first before range by default)
-	 * @param int|Revision $new New revision or rev ID (first after range by default)
+	 * @param Revision $new New revision or rev ID (first after range by default)
 	 * @param int $limit Maximum number of authors
-	 * @param string|array $options (Optional): Single option, or an array of options:
+	 * @param string $options (Optional): Single option, or an array of options:
 	 *     'include_old' Include $old in the range; $new is excluded.
 	 *     'include_new' Include $new in the range; $old is excluded.
 	 *     'include_both' Include both $old and $new in the range.
@@ -4360,7 +4359,7 @@ 
 	/**
 	 * Get the default message text or false if the message doesn't exist
 	 *
-	 * @return string|bool
+	 * @return false|string
 	 */
 	public function getDefaultMessageText() {
 		global $wgContLang;
@@ -4798,7 +4797,7 @@ 
 	}
 
 	/**
-	 * @return array
+	 * @return string[]
 	 */
 	public function __sleep() {
 		return [

includes/WebRequest.php

Doc Comments +4 added lines, -4 removed lines

@@ -223,7 +223,7 @@ 
 	 * This is for use prior to Setup.php, when no WebRequest object is available.
 	 * At other times, use the non-static function getProtocol().
 	 *
-	 * @return array
+	 * @return string
 	 */
 	public static function detectProtocol() {
 		if ( ( !empty( $_SERVER['HTTPS'] ) && $_SERVER['HTTPS'] !== 'off' ) ||
@@ -381,7 +381,7 @@ 
 	 * Set an arbitrary value into our get/post data.
 	 *
 	 * @param string $key Key name to use
-	 * @param mixed $value Value to set
+	 * @param string $value Value to set
 	 * @return mixed Old value if one was present, null otherwise
 	 */
 	public function setVal( $key, $value ) {
@@ -569,7 +569,7 @@ 
 	/**
 	 * Returns the names of all input values excluding those in $exclude.
 	 *
-	 * @param array $exclude
+	 * @param string[] $exclude
 	 * @return array
 	 */
 	public function getValueNames( $exclude = [] ) {
@@ -698,7 +698,7 @@ 
 	 * @param string $key The name of the cookie
 	 * @param string $prefix A prefix to use for the cookie name, if not $wgCookiePrefix
 	 * @param mixed $default What to return if the value isn't found
-	 * @return mixed Cookie value or $default if the cookie not set
+	 * @return string Cookie value or $default if the cookie not set
 	 */
 	public function getCookie( $key, $prefix = null, $default = null ) {
 		if ( $prefix === null ) {

includes/changes/ChangesList.php

Doc Comments +7 added lines, -1 removed lines

@@ -145,7 +145,7 @@ 
 	 * @param RecentChange|RCCacheEntry $rc
 	 * @param string|bool $watched Optionally timestamp for adding watched class
 	 *
-	 * @return array of classes
+	 * @return string[] of classes
 	 */
 	protected function getHTMLClasses( $rc, $watched ) {
 		$classes = [];
@@ -468,6 +468,8 @@ 
 	 *
 	 * @param string &$s HTML to update
 	 * @param RecentChange &$rc
+	 * @param string $s
+	 * @param RecentChange $rc
 	 */
 	public function insertUserRelatedLinks( &$s, &$rc ) {
 		if ( $this->isDeleted( $rc, Revision::DELETED_USER ) ) {
@@ -636,6 +638,10 @@ 
 		return $s;
 	}
 
+	/**
+	 * @param string $s
+	 * @param RecentChange $rc
+	 */
 	public function insertExtra( &$s, &$rc, &$classes ) {
 		// Empty, used for subclasses to add anything special.
 	}

includes/MagicWordArray.php

Doc Comments +3 added lines, -3 removed lines

@@ -771,7 +771,7 @@ 
 
 	/**
 	 * Get the base regex
-	 * @return array
+	 * @return string[]
 	 */
 	function getBaseRegex() {
 		if ( is_null( $this->baseRegex ) ) {
@@ -815,7 +815,7 @@ 
 	/**
 	 * Get a regex for matching variables with parameters
 	 *
-	 * @return string
+	 * @return string[]
 	 */
 	function getVariableRegex() {
 		return str_replace( "\\$1", "(.*?)", $this->getRegex() );
@@ -868,7 +868,7 @@ 
 	 * Returns array(magic word ID, parameter value)
 	 * If there is no parameter value, that element will be false.
 	 *
-	 * @param array $m
+	 * @param string[] $m
 	 *
 	 * @throws MWException
 	 * @return array

includes/logging/PatrolLog.php

Doc Comments +1 added lines, -1 removed lines

@@ -30,7 +30,7 @@
 	/**
 	 * Record a log event for a change being patrolled
 	 *
-	 * @param int|RecentChange $rc Change identifier or RecentChange object
+	 * @param RecentChange $rc Change identifier or RecentChange object
 	 * @param bool $auto Was this patrol event automatic?
 	 * @param User $user User performing the action or null to use $wgUser
 	 * @param string|string[] $tags Change tags to add to the patrol log entry