wikimedia / mediawiki

includes/db/DatabaseOracle.php

Doc Comments +14 added lines, -2 removed lines

@@ -85,6 +85,9 @@ 
 		unset( $this->db );
 	}
 
+	/**
+	 * @param integer $row
+	 */
 	public function seek( $row ) {
 		$this->cursor = min( $row, $this->nrows );
 	}
@@ -484,7 +487,7 @@ 
 
 	/**
 	 * This must be called after nextSequenceVal
-	 * @return null|int
+	 * @return integer
 	 */
 	function insertId() {
 		return $this->mInsertId;
@@ -571,6 +574,9 @@ 
 		return $retVal;
 	}
 
+	/**
+	 * @param string $table
+	 */
 	private function fieldBindStatement( $table, $col, &$val, $includeCol = false ) {
 		$col_info = $this->fieldInfoMulti( $table, $col );
 		$col_type = $col_info != false ? $col_info->type() : 'CONSTANT';
@@ -812,6 +818,9 @@ 
 		return strtoupper( parent::tableName( $name, $format ) );
 	}
 
+	/**
+	 * @param string $name
+	 */
 	function tableNameInternal( $name ) {
 		$name = $this->tableName( $name );
 
@@ -1269,6 +1278,9 @@ 
 		return "'" . $this->strencode( $s ) . "'";
 	}
 
+	/**
+	 * @param string $s
+	 */
 	public function addIdentifierQuotes( $s ) {
 		if ( !$this->getFlag( DBO_DDLMODE ) ) {
 			$s = '/*Q*/' . $s;
@@ -1332,7 +1344,7 @@ 
 	 *
 	 * @param array $options An associative array of options to be turned into
 	 *   an SQL query, valid keys are listed in the function.
-	 * @return array
+	 * @return string[]
 	 */
 	function makeSelectOptions( $options ) {
 		$preLimitTail = $postLimitTail = '';

includes/db/loadbalancer/LoadBalancer.php

Doc Comments +5 added lines, -5 removed lines

@@ -232,7 +232,7 @@ 
 	 * @param string|bool $group Query group, or false for the generic reader
 	 * @param string|bool $wiki Wiki ID, or false for the current wiki
 	 * @throws MWException
-	 * @return bool|int|string
+	 * @return string
 	 */
 	public function getReaderIndex( $group = false, $wiki = false ) {
 		global $wgDBtype;
@@ -437,7 +437,7 @@ 
 	 * Returns false if there is no connection open
 	 *
 	 * @param int $i
-	 * @return DatabaseBase|bool False on failure
+	 * @return DatabaseBase|null False on failure
 	 */
 	public function getAnyOpenConnection( $i ) {
 		foreach ( $this->mConns as $conns ) {
@@ -968,7 +968,7 @@ 
 
 	/**
 	 * Get the current master position for chronology control purposes
-	 * @return mixed
+	 * @return DBMasterPos
 	 */
 	public function getMasterPos() {
 		# If this entire request was served from a slave without opening a connection to the
@@ -1289,7 +1289,7 @@ 
 	/**
 	 * Call a function with each open connection object
 	 * @param callable $callback
-	 * @param array $params
+	 * @param string[] $params
 	 */
 	public function forEachOpenConnection( $callback, array $params = [] ) {
 		foreach ( $this->mConns as $conns2 ) {
@@ -1364,7 +1364,7 @@ 
 	 * case on many installations.
 	 *
 	 * @param IDatabase $conn
-	 * @return int|bool Returns false on error
+	 * @return integer Returns false on error
 	 */
 	public function safeGetLag( IDatabase $conn ) {
 		if ( $this->getServerCount() == 1 ) {

includes/GlobalFunctions.php

Doc Comments +13 added lines, -18 removed lines

@@ -43,6 +43,7 @@ 
 	/**
 	 * @codeCoverageIgnore
 	 * @see Fallback::mb_substr
+	 * @param integer $start
 	 * @return string
 	 */
 	function mb_substr( $str, $start, $count = 'end' ) {
@@ -85,7 +86,7 @@ 
 	/**
 	 * @codeCoverageIgnore
 	 * @see Fallback::mb_strrpos
-	 * @return int
+	 * @return string|false
 	 */
 	function mb_strrpos( $haystack, $needle, $offset = 0, $encoding = '' ) {
 		return Fallback::mb_strrpos( $haystack, $needle, $offset, $encoding );
@@ -288,7 +289,6 @@ 
  *   		array( 'y' )
  *   	)
  *
- * @param array $array1,...
  * @return array
  */
 function wfMergeErrorArrays( /*...*/ ) {
@@ -1340,7 +1340,7 @@ 
 /**
  * Get the value of $wgReadOnly or the contents of $wgReadOnlyFile.
  *
- * @return string|bool String when in read-only mode; false otherwise
+ * @return string|false String when in read-only mode; false otherwise
  * @since 1.27
  */
 function wfConfiguredReadOnlyReason() {
@@ -1415,7 +1415,6 @@ 
  * This function replaces all old wfMsg* functions.
  *
  * @param string|string[]|MessageSpecifier $key Message key, or array of keys, or a MessageSpecifier
- * @param mixed $params,... Normal message parameters
  * @return Message
  *
  * @since 1.17
@@ -1436,7 +1435,6 @@ 
  * for the first message which is non-empty. If all messages are empty then an
  * instance of the first message key is returned.
  *
- * @param string|string[] $keys,... Message keys
  * @return Message
  *
  * @since 1.18
@@ -1667,7 +1665,7 @@ 
  * @todo FIXME: We may want to blacklist some broken browsers
  *
  * @param bool $force
- * @return bool Whereas client accept gzip compression
+ * @return null|boolean Whereas client accept gzip compression
  */
 function wfClientAcceptsGzip( $force = false ) {
 	static $result = null;
@@ -1803,7 +1801,7 @@ 
 /**
  * Provide a simple HTTP error.
  *
- * @param int|string $code
+ * @param integer $code
  * @param string $label
  * @param string $desc
  */
@@ -2085,8 +2083,8 @@ 
  *
  * @param mixed $outputtype A timestamp in one of the supported formats, the
  *   function will autodetect which format is supplied and act accordingly.
- * @param mixed $ts Optional timestamp to convert, default 0 for the current time
- * @return string|bool String / false The same date in the format specified in $outputtype or false
+ * @param integer $ts Optional timestamp to convert, default 0 for the current time
+ * @return string|false String / false The same date in the format specified in $outputtype or false
  */
 function wfTimestamp( $outputtype = TS_UNIX, $ts = 0 ) {
 	try {
@@ -2127,7 +2125,7 @@ 
 /**
  * Check if the operating system is Windows
  *
- * @return bool True if it's Windows, false otherwise.
+ * @return boolean|null True if it's Windows, false otherwise.
  */
 function wfIsWindows() {
 	static $isWindows = null;
@@ -2366,7 +2364,7 @@ 
 /**
  * Check if wfShellExec() is effectively disabled via php.ini config
  *
- * @return bool|string False or 'disabled'
+ * @return string|false False or 'disabled'
  * @since 1.22
  */
 function wfShellExecDisabled() {
@@ -2980,7 +2978,7 @@ 
  * @param int $pad Minimum number of digits in the output (pad with zeroes)
  * @param bool $lowercase Whether to output in lowercase or uppercase
  * @param string $engine Either "gmp", "bcmath", or "php"
- * @return string|bool The output number as a string, or false on error
+ * @return false|string The output number as a string, or false on error
  */
 function wfBaseConvert( $input, $sourceBase, $destBase, $pad = 1,
 	$lowercase = true, $engine = 'auto'
@@ -3065,7 +3063,6 @@ 
 /**
  * Make a cache key for the local wiki.
  *
- * @param string $args,...
  * @return string
  */
 function wfMemcKey( /*...*/ ) {
@@ -3082,7 +3079,6 @@ 
  *
  * @param string $db
  * @param string $prefix
- * @param string $args,...
  * @return string
  */
 function wfForeignMemcKey( $db, $prefix /*...*/ ) {
@@ -3102,7 +3098,6 @@ 
  * in the first segment will clash with wfMemcKey/wfForeignMemcKey.
  *
  * @since 1.26
- * @param string $args,...
  * @return string
  */
 function wfGlobalCacheKey( /*...*/ ) {
@@ -3204,7 +3199,7 @@ 
  * Returns a valid placeholder object if the file does not exist.
  *
  * @param Title|string $title
- * @return LocalFile|null A File, or null if passed an invalid Title
+ * @return File|null A File, or null if passed an invalid Title
  */
 function wfLocalFile( $title ) {
 	return RepoGroup::singleton()->getLocalRepo()->newFile( $title );
@@ -3408,7 +3403,7 @@ 
 /**
  * Set PHP's time limit to the larger of php.ini or $wgTransactionalTimeLimit
  *
- * @return int Prior time limit
+ * @return string Prior time limit
  * @since 1.26
  */
 function wfTransactionalTimeLimit() {
@@ -3544,7 +3539,7 @@ 
  *
  * @param string $format The format string (See php's docs)
  * @param string $data A binary string of binary data
- * @param int|bool $length The minimum length of $data or false. This is to
+ * @param integer $length The minimum length of $data or false. This is to
  *	prevent reading beyond the end of $data. false to disable the check.
  *
  * Also be careful when using this function to read unsigned 32 bit integer

includes/interwiki/Interwiki.php

Doc Comments +6 added lines

@@ -53,6 +53,9 @@ 
 	/** @var bool Whether interwiki transclusions are allowed */
 	protected $mTrans;
 
+	/**
+	 * @param string $prefix
+	 */
 	public function __construct( $prefix = null, $url = '', $api = '', $wikiId = '', $local = 0,
 		$trans = 0
 	) {
@@ -192,6 +195,9 @@ 
 		return $value;
 	}
 
+	/**
+	 * @return string
+	 */
 	private static function getCacheValue( $key ) {
 		global $wgInterwikiCache;
 		static $reader;

includes/OutputPage.php

Doc Comments +15 added lines, -9 removed lines

@@ -430,7 +430,7 @@ 
 	 * one is set.
 	 *
 	 * @since 1.25
-	 * @return bool|string
+	 * @return boolean
 	 */
 	public function getCanonicalUrl() {
 		return $this->mCanonicalUrl;
@@ -1650,7 +1650,7 @@ 
 	 * Get the timestamp of displayed revision.
 	 * This will be null if not filled by setRevisionTimestamp().
 	 *
-	 * @return string|null
+	 * @return string
 	 */
 	public function getRevisionTimestamp() {
 		return $this->mRevisionTimestamp;
@@ -1659,7 +1659,7 @@ 
 	/**
 	 * Set the displayed file version
 	 *
-	 * @param File|bool $file
+	 * @param File $file
 	 * @return mixed Previous value
 	 */
 	public function setFileVersion( $file ) {
@@ -2005,7 +2005,7 @@ 
 	/**
 	 * Get the list of cookies that will influence on the cache
 	 *
-	 * @return array
+	 * @return string[]
 	 */
 	function getCacheVaryCookies() {
 		static $cookies;
@@ -2379,7 +2379,7 @@ 
 	 * indexing, clear the current text and redirect, set the page's title
 	 * and optionally an custom HTML title (content of the "<title>" tag).
 	 *
-	 * @param string|Message $pageTitle Will be passed directly to setPageTitle()
+	 * @param Message $pageTitle Will be passed directly to setPageTitle()
 	 * @param string|Message $htmlTitle Will be passed directly to setHTMLTitle();
 	 *                   optional, if not passed the "<title>" attribute will be
 	 *                   based on $pageTitle
@@ -2405,8 +2405,8 @@ 
 	 * showErrorPage( 'titlemsg', $messageObject );
 	 * showErrorPage( $titleMessageObject, $messageObject );
 	 *
-	 * @param string|Message $title Message key (string) for page title, or a Message object
-	 * @param string|Message $msg Message key (string) for page text, or a Message object
+	 * @param string $title Message key (string) for page title, or a Message object
+	 * @param string $msg Message key (string) for page text, or a Message object
 	 * @param array $params Message parameters; ignored if $msg is a Message object
 	 */
 	public function showErrorPage( $title, $msg, $params = [] ) {
@@ -2602,6 +2602,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $message
+	 */
 	public function showFatalError( $message ) {
 		$this->prepareErrorPage( $this->msg( 'internalerror' ) );
 
@@ -2620,6 +2623,9 @@ 
 		$this->showFatalError( $this->msg( 'filerenameerror', $old, $new )->text() );
 	}
 
+	/**
+	 * @param string|false $name
+	 */
 	public function showFileDeleteError( $name ) {
 		$this->showFatalError( $this->msg( 'filedeleteerror', $name )->text() );
 	}
@@ -2646,7 +2652,7 @@ 
 	 * Add a "return to" link pointing to a specified title,
 	 * or the title indicated in the request, or else the main page
 	 *
-	 * @param mixed $unused
+	 * @param null|boolean $unused
 	 * @param Title|string $returnto Title or String to return to
 	 * @param string $returntoquery Query string for the return to link
 	 */
@@ -3892,7 +3898,7 @@ 
 	 * Caller is responsible for ensuring the file exists. Emits a PHP warning otherwise.
 	 *
 	 * @since 1.27
-	 * @param string $remotePath URL path prefix that points to $localPath
+	 * @param string $remotePathPrefix URL path prefix that points to $localPath
 	 * @param string $localPath File directory exposed at $remotePath
 	 * @param string $file Path to target file relative to $localPath
 	 * @return string URL

includes/page/ImagePage.php

Doc Comments +5 added lines, -5 removed lines

@@ -55,7 +55,7 @@ 
 	/**
 	 * Constructor from a page id
 	 * @param int $id Article ID to load
-	 * @return ImagePage|null
+	 * @return ImagePage
 	 */
 	public static function newFromID( $id ) {
 		$t = Title::newFromID( $id );
@@ -266,7 +266,7 @@ 
 	 *
 	 * @todo FIXME: Bad interface, see note on MediaHandler::formatMetadata().
 	 *
-	 * @param array $metadata The array containing the Exif data
+	 * @param boolean $metadata The array containing the Exif data
 	 * @return string The metadata table. This is treated as Wikitext (!)
 	 */
 	protected function makeMetadataTable( $metadata ) {
@@ -295,7 +295,7 @@ 
 	 *
 	 * Omit noarticletext if sharedupload; text will be fetched from the
 	 * shared upload server if possible.
-	 * @return string
+	 * @return null|Content
 	 */
 	public function getContentObject() {
 		$this->loadFile();
@@ -636,7 +636,7 @@ 
 	 * Make the text under the image to say what size preview
 	 *
 	 * @param $params Array parameters for thumbnail
-	 * @param $sizeLinkBigImagePreview HTML for the current size
+	 * @param string $sizeLinkBigImagePreview HTML for the current size
 	 * @return string HTML output
 	 */
 	private function getThumbPrevText( $params, $sizeLinkBigImagePreview ) {
@@ -1211,7 +1211,7 @@ 
 
 	/**
 	 * @see WikiFilePage::getFile
-	 * @return bool|File
+	 * @return File
 	 */
 	public function getFile() {
 		return $this->mPage->getFile();

includes/page/WikiPage.php

Doc Comments +7 added lines, -7 removed lines

@@ -267,7 +267,7 @@ 
 	 * Return the list of revision fields that should be selected to create
 	 * a new page.
 	 *
-	 * @return array
+	 * @return string[]
 	 */
 	public static function selectFields() {
 		global $wgContentHandlerUseDB, $wgPageLanguageUseDB;
@@ -528,7 +528,7 @@ 
 
 	/**
 	 * Get the page_links_updated field
-	 * @return string|null Containing GMT timestamp
+	 * @return string Containing GMT timestamp
 	 */
 	public function getLinksTimestamp() {
 		if ( !$this->mDataLoaded ) {
@@ -1157,7 +1157,7 @@ 
 	 * @param IDatabase $dbw
 	 * @param int|null $pageId Custom page ID that will be used for the insert statement
 	 *
-	 * @return bool|int The newly created page_id key; false if the title already existed
+	 * @return integer The newly created page_id key; false if the title already existed
 	 */
 	public function insertOn( $dbw, $pageId = null ) {
 		$pageIdForInsert = $pageId ?: $dbw->nextSequenceValue( 'page_page_id_seq' );
@@ -1484,7 +1484,7 @@ 
 	 * @param int|null $baseRevId
 	 *
 	 * @throws MWException
-	 * @return Content|null New complete article content, or null if error.
+	 * @return Content New complete article content, or null if error.
 	 *
 	 * @since 1.24
 	 */
@@ -1570,7 +1570,7 @@ 
 	 * error will be returned. These two conditions are also possible with
 	 * auto-detection due to MediaWiki's performance-optimised locking strategy.
 	 *
-	 * @param bool|int $baseRevId The revision ID this edit was based off, if any.
+	 * @param boolean $baseRevId The revision ID this edit was based off, if any.
 	 *   This is not the parent revision ID, rather the revision ID for older
 	 *   content used as the source for a rollback, for example.
 	 * @param User $user The user doing the edit
@@ -3379,7 +3379,7 @@ 
 	 * Returns a list of categories this page is a member of.
 	 * Results will include hidden categories
 	 *
-	 * @return TitleArray
+	 * @return TitleArrayFromResult|null
 	 */
 	public function getCategories() {
 		$id = $this->getId();
@@ -3454,7 +3454,7 @@ 
 	 * Auto-generates a deletion reason
 	 *
 	 * @param bool &$hasHistory Whether the page has a history
-	 * @return string|bool String containing deletion reason or empty string, or boolean false
+	 * @return false|string String containing deletion reason or empty string, or boolean false
 	 *    if no revision occurred
 	 */
 	public function getAutoDeleteReason( &$hasHistory ) {

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;