wikimedia / mediawiki

includes/upload/UploadBase.php

Doc Comments +2 added lines, -3 removed lines

@@ -265,7 +265,7 @@ 
 
 	/**
 	 * @param string $srcPath The source path
-	 * @return string|bool The real path if it was a virtual URL Returns false on failure
+	 * @return string|false The real path if it was a virtual URL Returns false on failure
 	 */
 	function getRealPath( $srcPath ) {
 		$repo = RepoGroup::singleton()->getLocalRepo();
@@ -1513,7 +1513,6 @@ 
 	 * Check a block of CSS or CSS fragment for anything that looks like
 	 * it is bringing in remote code.
 	 * @param string $value a string of CSS
-	 * @param bool $propOnly only check css properties (start regex with :)
 	 * @return bool true if the CSS contains an illegal string, false if otherwise
 	 */
 	private static function checkCssFragment( $value ) {
@@ -1887,7 +1886,7 @@ 
 	 * format, presumably.
 	 *
 	 * @param ApiResult $result
-	 * @return array Image info
+	 * @return User Image info
 	 */
 	public function getImageInfo( $result ) {
 		$file = $this->getLocalFile();

includes/upload/UploadFromChunks.php

Doc Comments +3 added lines

@@ -333,6 +333,9 @@
 		return $storeStatus;
 	}
 
+	/**
+	 * @param integer $index
+	 */
 	private function getChunkFileKey( $index = null ) {
 		if ( $index === null ) {
 			$index = $this->getChunkIndex();

includes/upload/UploadFromStash.php

Doc Comments +1 added lines, -1 removed lines

@@ -40,7 +40,7 @@
 	private $repo;
 
 	/**
-	 * @param User|bool $user Default: false
+	 * @param User $user Default: false
 	 * @param UploadStash|bool $stash Default: false
 	 * @param FileRepo|bool $repo Default: false
 	 */

includes/upload/UploadStash.php

Doc Comments +2 added lines, -2 removed lines

@@ -170,7 +170,7 @@ 
 	 * Getter for file metadata.
 	 *
 	 * @param string $key Key under which file information is stored
-	 * @return array
+	 * @return string
 	 */
 	public function getMetadata( $key ) {
 		$this->getFile( $key );
@@ -200,7 +200,7 @@ 
 	 * @throws UploadStashBadPathException
 	 * @throws UploadStashFileException
 	 * @throws UploadStashNotLoggedInException
-	 * @return UploadStashFile|null File, or null on failure
+	 * @return UploadStashFile File, or null on failure
 	 */
 	public function stashFile( $path, $sourceType = null ) {
 		if ( !is_file( $path ) ) {

includes/user/BotPassword.php

Doc Comments +1 added lines, -1 removed lines

@@ -69,7 +69,7 @@
 	/**
 	 * Get a database connection for the bot passwords database
 	 * @param int $db Index of the connection to get, e.g. DB_MASTER or DB_SLAVE.
-	 * @return DatabaseBase
+	 * @return DBConnRef
 	 */
 	public static function getDB( $db ) {
 		global $wgBotPasswordsCluster, $wgBotPasswordsDatabase;

includes/user/User.php

Doc Comments +8 added lines, -8 removed lines

@@ -1135,7 +1135,7 @@ 
 	/**
 	 * Load user data from the session.
 	 *
-	 * @return bool True if the user is logged in, false otherwise.
+	 * @return null|boolean True if the user is logged in, false otherwise.
 	 */
 	private function loadFromSession() {
 		// Deprecated hook
@@ -2708,7 +2708,7 @@ 
 	 * resetting it if it's empty (and saving changes).
 	 *
 	 * @param string $oname The option name to retrieve the token from
-	 * @return string|bool User's current value for the option, or false if this option is disabled.
+	 * @return false|string User's current value for the option, or false if this option is disabled.
 	 * @see resetTokenFromOption()
 	 * @see getOption()
 	 * @deprecated 1.26 Applications should use the OAuth extension
@@ -2737,7 +2737,7 @@ 
 	 * *Does not* save user's preferences (similarly to setOption()).
 	 *
 	 * @param string $oname The option name to reset the token in
-	 * @return string|bool New token value, or false if this option is disabled.
+	 * @return false|string New token value, or false if this option is disabled.
 	 * @see getTokenFromOption()
 	 * @see setOption()
 	 */
@@ -2773,7 +2773,7 @@ 
 	 * new option kind is added.
 	 *
 	 * @see User::getOptionKinds
-	 * @return array Option kinds
+	 * @return string[] Option kinds
 	 */
 	public static function listOptionKinds() {
 		return array(
@@ -3889,7 +3889,7 @@ 
 
 	/**
 	 * Get whether the user is explicitly blocked from account creation.
-	 * @return bool|Block
+	 * @return Block
 	 */
 	public function isBlockedFromCreateAccount() {
 		$this->getBlockedStatus();
@@ -4410,7 +4410,7 @@ 
 	/**
 	 * Get the timestamp of account creation.
 	 *
-	 * @return string|bool|null Timestamp of account creation, false for
+	 * @return false|string Timestamp of account creation, false for
 	 *  non-existent/anonymous user accounts, or null if existing account
 	 *  but information is not in database.
 	 */
@@ -4425,7 +4425,7 @@ 
 	/**
 	 * Get the timestamp of the first edit
 	 *
-	 * @return string|bool Timestamp of first edit, or false for
+	 * @return false|string Timestamp of first edit, or false for
 	 *  non-existent/anonymous user accounts.
 	 */
 	public function getFirstEditTimestamp() {
@@ -5219,7 +5219,7 @@ 
 	/**
 	 * Return the list of user fields that should be selected to create
 	 * a new user object.
-	 * @return array
+	 * @return string[]
 	 */
 	public static function selectFields() {
 		return array(

includes/user/UserNamePrefixSearch.php

Doc Comments +1 added lines, -1 removed lines

@@ -30,7 +30,7 @@
 	/**
 	 * Do a prefix search of user names and return a list of matching user names.
 	 *
-	 * @param string|User $audience The string 'public' or a user object to show the search for
+	 * @param string $audience The string 'public' or a user object to show the search for
 	 * @param string $search
 	 * @param int $limit
 	 * @param int $offset How many results to offset from the beginning

includes/user/UserRightsProxy.php

Doc Comments +1 added lines, -1 removed lines

@@ -146,7 +146,7 @@
 	 *
 	 * @param string $database
 	 * @param bool $ignoreInvalidDB If true, don't check if $database is in $wgLocalDatabases
-	 * @return IDatabase|null If invalid selection
+	 * @return DatabaseBase|null If invalid selection
 	 */
 	public static function getDB( $database, $ignoreInvalidDB = false ) {
 		global $wgDBname;

includes/utils/AutoloadGenerator.php

Doc Comments +4 added lines, -3 removed lines

@@ -122,7 +122,7 @@ 
 	 * Updates the AutoloadClasses field at the given
 	 * filename.
 	 *
-	 * @param {string} $filename Filename of JSON
+	 * @param string $filename Filename of JSON
 	 *  extension/skin registration file
 	 */
 	protected function generateJsonAutoload( $filename ) {
@@ -157,8 +157,8 @@ 
 	/**
 	 * Generates a PHP file setting up autoload information.
 	 *
-	 * @param {string} $commandName Command name to include in comment
-	 * @param {string} $filename of PHP file to put autoload information in.
+	 * @param string $commandName Command name to include in comment
+	 * @param string $filename of PHP file to put autoload information in.
 	 */
 	protected function generatePHPAutoload( $commandName, $filename ) {
 		// No existing JSON file found; update/generate PHP file
@@ -278,6 +278,7 @@ 
 
 	/**
 	 * @var string $code PHP code (including <?php) to detect class names from
+	 * @param string $code
 	 * @return array List of FQCN detected within the tokens
 	 */
 	public function getClasses( $code ) {