wikimedia / mediawiki

includes/GlobalFunctions.php

Doc Comments +11 added lines, -17 removed lines

@@ -235,7 +235,6 @@ 
  *   		array( 'y' )
  *   	)
  *
- * @param array $array1,...
  * @return array
  */
 function wfMergeErrorArrays( /*...*/ ) {
@@ -1287,7 +1286,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() {
@@ -1362,7 +1361,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
@@ -1383,7 +1381,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
@@ -1614,7 +1611,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;
@@ -1750,7 +1747,7 @@ 
 /**
  * Provide a simple HTTP error.
  *
- * @param int|string $code
+ * @param integer $code
  * @param string $label
  * @param string $desc
  */
@@ -2032,8 +2029,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 {
@@ -2074,7 +2071,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;
@@ -2313,7 +2310,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() {
@@ -2927,7 +2924,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'
@@ -3012,7 +3009,6 @@ 
 /**
  * Make a cache key for the local wiki.
  *
- * @param string $args,...
  * @return string
  */
 function wfMemcKey( /*...*/ ) {
@@ -3029,7 +3025,6 @@ 
  *
  * @param string $db
  * @param string $prefix
- * @param string $args,...
  * @return string
  */
 function wfForeignMemcKey( $db, $prefix /*...*/ ) {
@@ -3049,7 +3044,6 @@ 
  * in the first segment will clash with wfMemcKey/wfForeignMemcKey.
  *
  * @since 1.26
- * @param string $args,...
  * @return string
  */
 function wfGlobalCacheKey( /*...*/ ) {
@@ -3151,7 +3145,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 );
@@ -3355,7 +3349,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() {
@@ -3491,7 +3485,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/logging/LogPager.php

Doc Comments +3 added lines

@@ -112,6 +112,9 @@
 		}
 	}
 
+	/**
+	 * @return string
+	 */
 	function stripParameters( $text ) {
 		if ( !$this->stripParametersEnabled ) {
 			return $text;

includes/skins/SkinTemplate.php

Doc Comments +3 added lines

@@ -30,6 +30,9 @@
 		}
 	}
 
+	/**
+	 * @param string $name
+	 */
 	function __call( $name, array $arguments ) {
 		if ( $this->conn === null ) {
 			list( $db, $groups, $wiki ) = $this->params;

includes/FauxRequest.php

Doc Comments +2 added lines, -2 removed lines

@@ -39,7 +39,7 @@ 
 	 * @param array $data Array of *non*-urlencoded key => value pairs, the
 	 *   fake GET/POST values
 	 * @param bool $wasPosted Whether to treat the data as POST
-	 * @param MediaWiki\Session\Session|array|null $session Session, session
+	 * @param MediaWiki\Session\Session|null $session Session, session
 	 *  data array, or null
 	 * @param string $protocol 'http' or 'https'
 	 * @throws MWException
@@ -126,7 +126,6 @@ 
 
 	/**
 	 * @since 1.26
-	 * @param string $name Unprefixed name of the cookie to set
 	 * @param string|null $value Value of the cookie to set
 	 * @param string|null $prefix Cookie prefix. Defaults to $wgCookiePrefix
 	 */
@@ -152,6 +151,7 @@ 
 
 	/**
 	 * @since 1.25
+	 * @param string $url
 	 */
 	public function setRequestURL( $url ) {
 		$this->requestUrl = $url;

includes/deferred/DeferredUpdates.php

Doc Comments +3 added lines

@@ -483,6 +483,9 @@
 		return Html::element( 'input', $realAttrs );
 	}
 
+	/**
+	 * @param string $mode
+	 */
 	function makeSearchButton( $mode, $attrs = array() ) {
 		switch ( $mode ) {
 			case 'go':

includes/installer/Installer.php

Doc Comments +7 added lines, -7 removed lines

@@ -359,7 +359,7 @@ 
 	 *
 	 * @param Config $baseConfig
 	 *
-	 * @return Config The config to use during installation.
+	 * @return null|Config The config to use during installation.
 	 */
 	public static function getInstallerConfig( Config $baseConfig ) {
 		$configOverrides = new HashConfig();
@@ -611,7 +611,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 ) ) {
@@ -1256,7 +1256,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 ) ) {
@@ -1288,14 +1288,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 ) {
@@ -1314,7 +1314,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 = [

includes/MediaWikiServices.php

Doc Comments +1 added lines, -1 removed lines

@@ -183,7 +183,7 @@
 	 * given $bootstrapConfig. In particular, all wiring files defined in the
 	 * ServiceWiringFiles setting are loaded, and the MediaWikiServices hook is called.
 	 *
-	 * @param Config|null $bootstrapConfig The Config object to be registered as the
+	 * @param Config $bootstrapConfig The Config object to be registered as the
 	 *        'BootstrapConfig' service. This has to contain at least the information
 	 *        needed to set up the 'ConfigFactory' service. If not provided, any call
 	 *        to getBootstrapConfig(), getConfigFactory, or getMainConfig will fail.

includes/specials/SpecialUpload.php

Doc Comments +2 added lines, -2 removed lines

@@ -218,7 +218,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
@@ -601,7 +601,7 @@ 
 	 *
 	 * Note that the page target can be changed *on the form*, so our check
 	 * state can get out of sync.
-	 * @return bool|string
+	 * @return boolean
 	 */
 	protected function getWatchCheck() {
 		if ( $this->getUser()->getOption( 'watchdefault' ) ) {

includes/filerepo/file/File.php

Doc Comments +14 added lines, -14 removed lines

@@ -160,7 +160,7 @@ 
 	 * Most subclasses will want to call assertRepoDefined() here.
 	 *
 	 * @param Title|string|bool $title
-	 * @param FileRepo|bool $repo
+	 * @param FileRepo $repo
 	 */
 	function __construct( $title, $repo ) {
 		// Some subclasses do not use $title, but set name/title some other way
@@ -411,7 +411,7 @@ 
 	 * Most callers don't check the return value, but ForeignAPIFile::getPath
 	 * returns false.
 	 *
-	 * @return string|bool ForeignAPIFile::getPath can return false
+	 * @return string ForeignAPIFile::getPath can return false
 	 */
 	public function getPath() {
 		if ( !isset( $this->path ) ) {
@@ -457,7 +457,7 @@ 
 	 * Overridden by LocalFile, UnregisteredLocalFile
 	 *
 	 * @param int $page
-	 * @return int|bool
+	 * @return boolean
 	 */
 	public function getWidth( $page = 1 ) {
 		return false;
@@ -471,7 +471,7 @@ 
 	 * Overridden by LocalFile, UnregisteredLocalFile
 	 *
 	 * @param int $page
-	 * @return bool|int False on failure
+	 * @return boolean False on failure
 	 */
 	public function getHeight( $page = 1 ) {
 		return false;
@@ -484,7 +484,7 @@ 
 	 *
 	 * @param int $desiredWidth
 	 * @param int $page
-	 * @return bool|int
+	 * @return integer
 	 */
 	public function getThumbnailBucket( $desiredWidth, $page = 1 ) {
 		global $wgThumbnailBuckets, $wgThumbnailMinimumBucketDistance;
@@ -633,7 +633,7 @@ 
 	 * Get handler-specific metadata
 	 * Overridden by LocalFile, UnregisteredLocalFile
 	 * STUB
-	 * @return bool|array
+	 * @return boolean
 	 */
 	public function getMetadata() {
 		return false;
@@ -642,7 +642,7 @@ 
 	/**
 	 * Like getMetadata but returns a handler independent array of common values.
 	 * @see MediaHandler::getCommonMetaArray()
-	 * @return array|bool Array or false if not supported
+	 * @return boolean Array or false if not supported
 	 * @since 1.23
 	 */
 	public function getCommonMetaArray() {
@@ -660,7 +660,7 @@ 
 	 *
 	 * @param array|string $metadata Array or string of (serialized) metadata
 	 * @param int $version Version number.
-	 * @return array Array containing metadata, or what was passed to it on fail
+	 * @return ApiResult Array containing metadata, or what was passed to it on fail
 	 *   (unserializing if not array)
 	 */
 	public function convertMetadataVersion( $metadata, $version ) {
@@ -1359,7 +1359,7 @@ 
 	/**
 	 * Get a MediaHandler instance for this file
 	 *
-	 * @return MediaHandler|bool Registered MediaHandler for file's MIME type
+	 * @return MediaHandler Registered MediaHandler for file's MIME type
 	 *   or false if none found
 	 */
 	function getHandler() {
@@ -1782,7 +1782,7 @@ 
 	 * @param bool $watch
 	 * @param string|bool $timestamp
 	 * @param null|User $user User object or null to use $wgUser
-	 * @return bool
+	 * @return boolean|null
 	 * @throws MWException
 	 */
 	function recordUpload( $oldver, $desc, $license = '', $copyStatus = '', $source = '',
@@ -1817,7 +1817,7 @@ 
 	}
 
 	/**
-	 * @param bool|IContextSource $context Context to use (optional)
+	 * @param IContextSource $context Context to use (optional)
 	 * @return bool
 	 */
 	function formatMetadata( $context = false ) {
@@ -1964,7 +1964,7 @@ 
 	 * Returns the number of pages of a multipage document, or false for
 	 * documents which aren't multipage documents
 	 *
-	 * @return bool|int
+	 * @return string|boolean
 	 */
 	function pageCount() {
 		if ( !isset( $this->pageCount ) ) {
@@ -2031,7 +2031,7 @@ 
 	/**
 	 * Get the HTML text of the description page, if available
 	 *
-	 * @param bool|Language $lang Optional language to fetch description in
+	 * @param Language $lang Optional language to fetch description in
 	 * @return string
 	 */
 	function getDescriptionText( $lang = false ) {
@@ -2103,7 +2103,7 @@ 
 	 * Returns false if the file does not have a description page, or retrieving the timestamp
 	 * would be expensive.
 	 * @since 1.25
-	 * @return string|bool
+	 * @return boolean
 	 */
 	public function getDescriptionTouched() {
 		return false;