wikimedia / mediawiki

includes/collation/IcuCollation.php

Doc Comments +6 added lines, -1 removed lines

@@ -182,6 +182,9 @@ 
 	 */
 	const RECORD_LENGTH = 14;
 
+	/**
+	 * @param string $locale
+	 */
 	public function __construct( $locale ) {
 		if ( !extension_loaded( 'intl' ) ) {
 			throw new MWException( 'An ICU collation was requested, ' .
@@ -413,6 +416,8 @@ 
 
 	/**
 	 * @since 1.16.3
+	 * @param integer $index
+	 * @return string
 	 */
 	public function getLetterByIndex( $index ) {
 		return $this->getFirstLetterData()['chars'][$index];
@@ -466,7 +471,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();

includes/revisiondelete/RevDelArchivedFileItem.php

Doc Comments +3 added lines

@@ -30,6 +30,9 @@
 	/** @var LocalFile */
 	protected $lockFile;
 
+	/**
+	 * @param RevDelArchivedFileList $list
+	 */
 	public function __construct( $list, $row ) {
 		RevDelItem::__construct( $list, $row );
 		$this->file = ArchivedFile::newFromRow( $row );

includes/search/SearchEngine.php

Doc Comments +6 added lines, -5 removed lines

@@ -104,7 +104,7 @@ 
 	 * @since 1.18
 	 * @param string $feature
 	 * @param mixed $data
-	 * @return bool
+	 * @return boolean|null
 	 */
 	public function setFeatureData( $feature, $data ) {
 		$this->features[$feature] = $data;
@@ -301,7 +301,7 @@ 
 
 	/**
 	 * Find snippet highlight settings for all users
-	 * @return array Contextlines, contextchars
+	 * @return integer[] Contextlines, contextchars
 	 */
 	public static function userHighlightPrefs() {
 		$contextlines = 2; // Hardcode this. Old defaults sucked. :)
@@ -507,6 +507,7 @@ 
 	 * Process completion search results.
 	 * Resolves the titles and rescores.
 	 * @param SearchSuggestionSet $suggestions
+	 * @param string $search
 	 * @return SearchSuggestionSet
 	 */
 	protected function processCompletionResults( $search, SearchSuggestionSet $suggestions ) {
@@ -590,7 +591,7 @@ 
 	 * settings, returning a list of index numbers.
 	 * @deprecated since 1.27; use SearchEngineConfig::userNamespaces()
 	 * @param user $user
-	 * @return array
+	 * @return integer[]
 	 */
 	public static function userNamespaces( $user ) {
 		return MediaWikiServices::getInstance()->getSearchEngineConfig()->userNamespaces( $user );
@@ -599,7 +600,7 @@ 
 	/**
 	 * An array of namespaces indexes to be searched by default
 	 * @deprecated since 1.27; use SearchEngineConfig::defaultNamespaces()
-	 * @return array
+	 * @return integer[]
 	 */
 	public static function defaultNamespaces() {
 		return MediaWikiServices::getInstance()->getSearchEngineConfig()->defaultNamespaces();
@@ -610,7 +611,7 @@ 
 	 * and preferences
 	 * @deprecated since 1.27; use SearchEngineConfig::namespacesAsText()
 	 * @param array $namespaces
-	 * @return array
+	 * @return string[]
 	 */
 	public static function namespacesAsText( $namespaces ) {
 		return MediaWikiServices::getInstance()->getSearchEngineConfig()->namespacesAsText( $namespaces );

includes/htmlform/fields/HTMLButtonField.php

Doc Comments +1 added lines, -1 removed lines

@@ -125,7 +125,7 @@
 
 	/**
 	 * IE<8 has bugs with <button>, so we'll need to avoid them.
-	 * @return bool Whether the request is from a bad version of IE
+	 * @return integer Whether the request is from a bad version of IE
 	 */
 	private function isBadIE() {
 		$request = $this->mParent

includes/htmlform/fields/HTMLCheckMatrix.php

Doc Comments +4 added lines, -1 removed lines

@@ -75,7 +75,7 @@ 
 	 * mParams['rows'] is an array with row labels as keys and row tags as values.
 	 * mParams['columns'] is an array with column labels as keys and column tags as values.
 	 *
-	 * @param array $value Array of the options that should be checked
+	 * @param string $value Array of the options that should be checked
 	 *
 	 * @return string
 	 */
@@ -151,6 +151,9 @@ 
 		return $html;
 	}
 
+	/**
+	 * @param boolean $checked
+	 */
 	protected function getOneCheckbox( $checked, $attribs ) {
 		if ( $this->mParent instanceof OOUIHTMLForm ) {
 			return new OOUI\CheckboxInputWidget( array(

includes/htmlform/fields/HTMLMultiSelectField.php

Doc Comments +3 added lines

@@ -63,6 +63,9 @@
 		return $html;
 	}
 
+	/**
+	 * @param boolean $checked
+	 */
 	protected function getOneCheckbox( $checked, $attribs, $label ) {
 		if ( $this->mParent instanceof OOUIHTMLForm ) {
 			if ( $this->mOptionsLabelsNotFromMessage ) {

includes/htmlform/fields/HTMLRadioField.php

Doc Comments +3 added lines

@@ -55,6 +55,9 @@
 		) + $this->getAttributes( array( 'disabled', 'tabindex' ), array( 'tabindex' => 'tabIndex' ) ) );
 	}
 
+	/**
+	 * @param string $value
+	 */
 	function formatOptions( $options, $value ) {
 		$html = '';
 

includes/utils/AutoloadGenerator.php

Doc Comments +3 added lines, -2 removed lines

@@ -158,8 +158,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
@@ -320,6 +320,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 ) {

includes/media/MediaHandler.php

Doc Comments +4 added lines, -4 removed lines

@@ -41,7 +41,7 @@ 
 	 * Get a MediaHandler for a given MIME type from the instance cache
 	 *
 	 * @param string $type
-	 * @return MediaHandler|bool
+	 * @return File
 	 */
 	static function getHandler( $type ) {
 		return MediaWikiServices::getInstance()
@@ -173,7 +173,7 @@ 
 	 *
 	 * @note This method is currently unused.
 	 * @param File $image
-	 * @return string
+	 * @return boolean
 	 */
 	function getMetadataType( $image ) {
 		return false;
@@ -285,7 +285,7 @@ 
 	 * @param string $ext Extension of original file
 	 * @param string $mime MIME type of original file
 	 * @param array $params Handler specific rendering parameters
-	 * @return array Thumbnail extension and MIME type
+	 * @return string[] Thumbnail extension and MIME type
 	 */
 	function getThumbType( $ext, $mime, $params = null ) {
 		$magic = MimeMagic::singleton();
@@ -625,7 +625,7 @@ 
 	 * @param int $boxWidth Width of the thumbnail box.
 	 * @param int $boxHeight Height of the thumbnail box.
 	 * @param int $maxHeight Maximum height expected for the thumbnail.
-	 * @return int
+	 * @return double
 	 */
 	public static function fitBoxWidth( $boxWidth, $boxHeight, $maxHeight ) {
 		$idealWidth = $boxWidth * $maxHeight / $boxHeight;