wikimedia / mediawiki

includes/db/Database.php

Doc Comments +19 added lines, -6 removed lines

@@ -736,7 +736,7 @@ 
 	}
 
 	/**
-	 * @return bool|string
+	 * @return string|false
 	 */
 	protected function restoreErrorHandler() {
 		restore_error_handler();
@@ -851,7 +851,7 @@ 
 	}
 
 	/**
-	 * @param $sql
+	 * @param string $sql
 	 * @return string|null
 	 */
 	protected function getQueryVerb( $sql ) {
@@ -975,6 +975,12 @@ 
 		return $res;
 	}
 
+	/**
+	 * @param string $sql
+	 * @param string $commentedSql
+	 * @param boolean $isWrite
+	 * @param string $fname
+	 */
 	private function doProfiledQuery( $sql, $commentedSql, $isWrite, $fname ) {
 		$isMaster = !is_null( $this->getLBInfo( 'master' ) );
 		# generalizeSQL() will probably cut down the query to reasonable
@@ -1047,6 +1053,10 @@ 
 		}
 	}
 
+	/**
+	 * @param string $sql
+	 * @param boolean $priorWritesPending
+	 */
 	private function canRecoverFromDisconnect( $sql, $priorWritesPending ) {
 		# Transaction dropped; this can mean lost writes, or REPEATABLE-READ snapshots.
 		# Dropped connections also mean that named locks are automatically released.
@@ -1268,7 +1278,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 ) {
@@ -2462,6 +2472,9 @@ 
 		return $this->insert( $destTable, $rows, $fname, $insertOptions );
 	}
 
+	/**
+	 * @param string $destTable
+	 */
 	public function nativeInsertSelect( $destTable, $srcTable, $varMap, $conds,
 		$fname = __METHOD__,
 		$insertOptions = [], $selectOptions = []
@@ -3287,8 +3300,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
@@ -3635,7 +3648,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/resourceloader/ResourceLoader.php

Doc Comments +7 added lines, -4 removed lines

@@ -207,6 +207,10 @@ 
 		return $result;
 	}
 
+	/**
+	 * @param string $filter
+	 * @param string $data
+	 */
 	private static function applyFilter( $filter, $data ) {
 		$data = trim( $data );
 		if ( $data ) {
@@ -309,7 +313,7 @@ 
 	 * @throws MWException If a duplicate module registration is attempted
 	 * @throws MWException If a module name contains illegal characters (pipes or commas)
 	 * @throws MWException If something other than a ResourceLoaderModule is being registered
-	 * @return bool False if there were any errors, in which case one or more modules were
+	 * @return boolean|null False if there were any errors, in which case one or more modules were
 	 *   not registered
 	 */
 	public function register( $name, $info = null ) {
@@ -573,7 +577,7 @@ 
 	/**
 	 * Get the list of sources.
 	 *
-	 * @return array Like [ id => load.php url, ... ]
+	 * @return string Like [ id => load.php url, ... ]
 	 */
 	public function getSources() {
 		return $this->sources;
@@ -610,7 +614,7 @@ 
 	 *
 	 * @since 1.26
 	 * @param ResourceLoaderContext $context
-	 * @param string[] $modules List of known module names
+	 * @param string[] $moduleNames List of known module names
 	 * @return string Hash
 	 */
 	public function getCombinedVersion( ResourceLoaderContext $context, array $moduleNames ) {
@@ -634,7 +638,6 @@ 
 	 *
 	 * @since 1.28
 	 * @param ResourceLoaderContext $context
-	 * @param string[] $modules List of module names
 	 * @return string Hash
 	 */
 	public function getExpectedVersionQuery( ResourceLoaderContext $context ) {

includes/page/ImagePage.php

Doc Comments +3 added lines, -3 removed lines

@@ -296,7 +296,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();
@@ -637,7 +637,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 ) {
@@ -1212,7 +1212,7 @@ 
 
 	/**
 	 * @see WikiFilePage::getFile
-	 * @return bool|File
+	 * @return string
 	 */
 	public function getFile() {
 		return $this->mPage->getFile();

includes/Revision.php

Doc Comments +8 added lines, -8 removed lines

@@ -434,7 +434,7 @@ 
 	/**
 	 * Return the list of revision fields that should be selected to create
 	 * a new revision.
-	 * @return array
+	 * @return string[]
 	 */
 	public static function selectFields() {
 		global $wgContentHandlerUseDB;
@@ -465,7 +465,7 @@ 
 	/**
 	 * Return the list of revision fields that should be selected to create
 	 * a new revision from an archive row.
-	 * @return array
+	 * @return string[]
 	 */
 	public static function selectArchiveFields() {
 		global $wgContentHandlerUseDB;
@@ -496,7 +496,7 @@ 
 	/**
 	 * Return the list of text fields that should be selected to read the
 	 * revision text
-	 * @return array
+	 * @return string[]
 	 */
 	public static function selectTextFields() {
 		return [
@@ -507,7 +507,7 @@ 
 
 	/**
 	 * Return the list of page fields that should be selected from page table
-	 * @return array
+	 * @return string[]
 	 */
 	public static function selectPageFields() {
 		return [
@@ -522,7 +522,7 @@ 
 
 	/**
 	 * Return the list of user fields that should be selected from user table
-	 * @return array
+	 * @return string[]
 	 */
 	public static function selectUserFields() {
 		return [ 'user_name' ];
@@ -870,7 +870,7 @@ 
 	/**
 	 * Fetch revision's user id without regard for the current user's permissions
 	 *
-	 * @return string
+	 * @return integer
 	 * @deprecated since 1.25, use getUser( Revision::RAW )
 	 */
 	public function getRawUser() {
@@ -1787,7 +1787,7 @@ 
 	 *
 	 * @param Title $title
 	 * @param int $id
-	 * @return string|bool False if not found
+	 * @return string|false False if not found
 	 */
 	static function getTimestampFromId( $title, $id, $flags = 0 ) {
 		$db = ( $flags & self::READ_LATEST )
@@ -1843,7 +1843,7 @@ 
 	 * @since 1.20
 	 * @deprecated since 1.24
 	 *
-	 * @param IDatabase|int $db The Database to perform the check on. May be given as a
+	 * @param integer $db The Database to perform the check on. May be given as a
 	 *        Database object or a database identifier usable with wfGetDB.
 	 * @param int $pageId The ID of the page in question
 	 * @param int $userId The ID of the user in question