wikimedia / mediawiki

includes/Collation.php

Doc Comments +16 added lines, -2 removed lines

@@ -37,7 +37,7 @@ 
 	/**
 	 * @throws MWException
 	 * @param string $collationName
-	 * @return Collation
+	 * @return string
 	 */
 	static function factory( $collationName ) {
 		switch ( $collationName ) {
@@ -296,6 +296,9 @@ 
 
 	const RECORD_LENGTH = 14;
 
+	/**
+	 * @param string $locale
+	 */
 	function __construct( $locale ) {
 		if ( !extension_loaded( 'intl' ) ) {
 			throw new MWException( 'An ICU collation was requested, ' .
@@ -512,6 +515,9 @@ 
 		return $data;
 	}
 
+	/**
+	 * @param integer $index
+	 */
 	function getLetterByIndex( $index ) {
 		if ( $this->firstLetterData === null ) {
 			$this->getFirstLetterData();
@@ -563,7 +569,7 @@ 
 	 * currently in use, or false when it can't be determined.
 	 *
 	 * @since 1.21
-	 * @return string|bool
+	 * @return false|string
 	 */
 	static function getUnicodeVersionForICU() {
 		$icuVersion = IcuCollation::getICUVersion();
@@ -621,6 +627,11 @@ 
 		parent::__construct( 'et' );
 	}
 
+	/**
+	 * @param string $string
+	 *
+	 * @return string
+	 */
 	private static function mangle( $string ) {
 		return str_replace(
 			array( 'w', 'W' ),
@@ -629,6 +640,9 @@ 
 		);
 	}
 
+	/**
+	 * @param string $string
+	 */
 	private static function unmangle( $string ) {
 		// Casing data is lost…
 		return str_replace(

includes/content/AbstractContent.php

Doc Comments +1 added lines, -1 removed lines

@@ -219,7 +219,7 @@
 	 * @param bool $recursive
 	 * @param ParserOutput $parserOutput
 	 *
-	 * @return DataUpdate[]
+	 * @return LinksUpdate[]
 	 *
 	 * @see Content::getSecondaryDataUpdates()
 	 */

includes/content/ContentHandler.php

Doc Comments +4 added lines, -4 removed lines

@@ -649,7 +649,7 @@ 
 	 *
 	 * @param IContextSource $context Context to use, anything else will be ignored.
 	 * @param int $old Revision ID we want to show and diff with.
-	 * @param int|string $new Either a revision ID or one of the strings 'cur', 'prev' or 'next'.
+	 * @param integer $new Either a revision ID or one of the strings 'cur', 'prev' or 'next'.
 	 * @param int $rcid FIXME: Deprecated, no longer used. Defaults to 0.
 	 * @param bool $refreshCache If set, refreshes the diff cache. Defaults to false.
 	 * @param bool $unhide If set, allow viewing deleted revs. Defaults to false.
@@ -787,7 +787,7 @@ 
 	 * @param Content $myContent One of the page's conflicting contents.
 	 * @param Content $yourContent One of the page's conflicting contents.
 	 *
-	 * @return Content|bool Always false.
+	 * @return boolean Always false.
 	 */
 	public function merge3( Content $oldContent, Content $myContent, Content $yourContent ) {
 		return false;
@@ -879,7 +879,7 @@ 
 	 * @param Title $title The page's title
 	 * @param bool &$hasHistory Whether the page has a history
 	 *
-	 * @return mixed String containing deletion reason or empty string, or
+	 * @return false|string String containing deletion reason or empty string, or
 	 *    boolean false if no revision occurred
 	 *
 	 * @todo &$hasHistory is extremely ugly, it's here because
@@ -989,7 +989,7 @@ 
 	 * @param Revision $undo The revision to undo
 	 * @param Revision $undoafter Must be an earlier revision than $undo
 	 *
-	 * @return mixed String on success, false on failure
+	 * @return null|Content String on success, false on failure
 	 */
 	public function getUndoContent( Revision $current, Revision $undo, Revision $undoafter ) {
 		$cur_content = $current->getContent();

includes/context/DerivativeContext.php

Doc Comments -1 removed lines

@@ -329,7 +329,6 @@
 	 * it would set only the original context, and not take
 	 * into account any changes.
 	 *
-	 * @param mixed $args,... Arguments to wfMessage
 	 * @return Message
 	 */
 	public function msg() {

includes/db/Database.php

Doc Comments +6 added lines, -6 removed lines

@@ -184,7 +184,7 @@ 
 	 *   - false to disable debugging
 	 *   - omitted or null to do nothing
 	 *
-	 * @return bool|null Previous value of the flag
+	 * @return boolean Previous value of the flag
 	 */
 	public function debug( $debug = null ) {
 		return wfSetBit( $this->mFlags, DBO_DEBUG, $debug );
@@ -635,7 +635,7 @@ 
 	}
 
 	/**
-	 * @return bool|string
+	 * @return string|false
 	 */
 	protected function restoreErrorHandler() {
 		restore_error_handler();
@@ -1080,7 +1080,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 ) {
@@ -2921,8 +2921,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
@@ -3235,7 +3235,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/db/DatabaseError.php

Doc Comments +1 added lines, -1 removed lines

@@ -328,7 +328,7 @@
 	/**
 	 * @param DatabaseBase $db
 	 * @param string $error
-	 * @param int|string $errno
+	 * @param integer $errno
 	 * @param string $sql
 	 * @param string $fname
 	 */

includes/db/DatabaseMssql.php

Doc Comments +6 added lines, -6 removed lines

@@ -369,8 +369,8 @@ 
 	/**
 	 * SELECT wrapper
 	 *
-	 * @param mixed $table Array or string, table name(s) (prefix auto-added)
-	 * @param mixed $vars Array or string, field name(s) to be retrieved
+	 * @param string $table Array or string, table name(s) (prefix auto-added)
+	 * @param string $vars Array or string, field name(s) to be retrieved
 	 * @param mixed $conds Array or string, condition(s) for WHERE
 	 * @param string $fname Calling function name (use __METHOD__) for logs/profiling
 	 * @param array $options Associative array of options (e.g.
@@ -378,7 +378,7 @@ 
 	 *   code for list of supported stuff
 	 * @param array $join_conds Associative array of table join conditions
 	 *   (optional) (e.g. array( 'page' => array('LEFT JOIN','page_latest=rev_id') )
-	 * @return mixed Database result resource (feed to Database::fetchObject
+	 * @return MssqlResultWrapper Database result resource (feed to Database::fetchObject
 	 *   or whatever), or false on failure
 	 * @throws DBQueryError
 	 * @throws DBUnexpectedError
@@ -716,7 +716,7 @@ 
 	 * @param string $fname
 	 * @param array $insertOptions
 	 * @param array $selectOptions
-	 * @return null|ResultWrapper
+	 * @return ResultWrapper
 	 * @throws Exception
 	 */
 	public function insertSelect( $destTable, $srcTable, $varMap, $conds, $fname = __METHOD__,
@@ -860,7 +860,7 @@ 
 	 *
 	 * @param string $sql SQL query we will append the limit too
 	 * @param int $limit The SQL limit
-	 * @param bool|int $offset The SQL offset (default false)
+	 * @param string|false $offset The SQL offset (default false)
 	 * @return array|string
 	 * @throws DBUnexpectedError
 	 */
@@ -1149,7 +1149,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[]
 	 */
 	public function makeSelectOptions( $options ) {
 		$tailOpts = '';

includes/db/DatabasePostgres.php

Doc Comments +18 added lines, -2 removed lines

@@ -168,6 +168,11 @@ 
 		}
 	}
 
+	/**
+	 * @param string $keyword
+	 * @param string $msg_ok
+	 * @param string $msg_failed
+	 */
 	protected function query( $keyword, $msg_ok, $msg_failed ) {
 		if ( $this->dbw->doQuery( $keyword . " " . $this->id ) !== false ) {
 		} else {
@@ -259,6 +264,9 @@ 
 		return true;
 	}
 
+	/**
+	 * @param string $name
+	 */
 	function hasConstraint( $name ) {
 		$sql = "SELECT 1 FROM pg_catalog.pg_constraint c, pg_catalog.pg_namespace n " .
 			"WHERE c.connamespace = n.oid AND conname = '" .
@@ -550,7 +558,7 @@ 
 	 * Return the result of the last call to nextSequenceValue();
 	 * This must be called after nextSequenceValue().
 	 *
-	 * @return int|null
+	 * @return integer
 	 */
 	function insertId() {
 		return $this->mInsertId;
@@ -1310,6 +1318,10 @@ 
 		return $this->relationExists( $sequence, 'S', $schema );
 	}
 
+	/**
+	 * @param string $table
+	 * @param string $trigger
+	 */
 	function triggerExists( $table, $trigger ) {
 		$q = <<<SQL
 	SELECT 1 FROM pg_class, pg_namespace, pg_trigger
@@ -1333,6 +1345,10 @@ 
 		return $rows;
 	}
 
+	/**
+	 * @param string $table
+	 * @param string $rule
+	 */
 	function ruleExists( $table, $rule ) {
 		$exists = $this->selectField( 'pg_rules', 'rulename',
 			array(
@@ -1475,7 +1491,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/DatabaseSqlite.php

Doc Comments +4 added lines, -1 removed lines

@@ -551,7 +551,7 @@ 
 	 * Filter the options used in SELECT statements
 	 *
 	 * @param array $options
-	 * @return array
+	 * @return string[]
 	 */
 	function makeSelectOptions( $options ) {
 		foreach ( $options as $k => $v ) {
@@ -1048,6 +1048,9 @@ 
 class SQLiteField implements Field {
 	private $info, $tableName;
 
+	/**
+	 * @param string $tableName
+	 */
 	function __construct( $info, $tableName ) {
 		$this->info = $info;
 		$this->tableName = $tableName;