wikimedia / mediawiki

languages/Language.php

Doc Comments +17 added lines, -15 removed lines

@@ -738,7 +738,7 @@ 
 	}
 
 	/**
-	 * @return array|string
+	 * @return string
 	 */
 	function getDefaultDateFormat() {
 		$df = self::$dataCache->getItem( $this->mCode, 'defaultDateFormat' );
@@ -922,7 +922,7 @@ 
 	}
 
 	/**
-	 * @return array
+	 * @return string[]
 	 */
 	function getMonthNamesArray() {
 		$monthNames = [ '' ];
@@ -949,7 +949,7 @@ 
 	}
 
 	/**
-	 * @return array
+	 * @return string[]
 	 */
 	function getMonthAbbreviationsArray() {
 		$monthNames = [ '' ];
@@ -1011,7 +1011,7 @@ 
 	 * Pass through result from $dateTimeObj->format()
 	 * @param DateTime|bool|null &$dateTimeObj
 	 * @param string $ts
-	 * @param DateTimeZone|bool|null $zone
+	 * @param null|DateTimeZone $zone
 	 * @param string $code
 	 * @return string
 	 */
@@ -1808,7 +1808,7 @@ 
 	 *
 	 * @param int $year
 	 *
-	 * @return string
+	 * @return integer
 	 */
 	private static function hebrewYearStart( $year ) {
 		$a = intval( ( 12 * ( $year - 1 ) + 17 ) % 19 );
@@ -2596,7 +2596,7 @@ 
 
 	/**
 	 * @param array $matches
-	 * @return mixed|string
+	 * @return string
 	 */
 	function ucwordbreaksCallbackAscii( $matches ) {
 		return $this->ucfirst( $matches[1] );
@@ -2699,7 +2699,7 @@ 
 
 	/**
 	 * @param string $str
-	 * @return mixed|string
+	 * @return string
 	 */
 	function lcfirst( $str ) {
 		$o = ord( $str );
@@ -2718,7 +2718,7 @@ 
 	/**
 	 * @param string $str
 	 * @param bool $first
-	 * @return mixed|string
+	 * @return string
 	 */
 	function lc( $str, $first = false ) {
 		if ( function_exists( 'mb_strtolower' ) ) {
@@ -2755,7 +2755,7 @@ 
 
 	/**
 	 * @param string $str
-	 * @return mixed|string
+	 * @return string
 	 */
 	function ucwords( $str ) {
 		if ( $this->isMultibyte( $str ) ) {
@@ -2787,7 +2787,7 @@ 
 	 * capitalize words at word breaks
 	 *
 	 * @param string $str
-	 * @return mixed
+	 * @return string
 	 */
 	function ucwordbreaks( $str ) {
 		if ( $this->isMultibyte( $str ) ) {
@@ -2858,7 +2858,7 @@ 
 	}
 
 	/**
-	 * @return array
+	 * @return string
 	 */
 	function fallback8bitEncoding() {
 		return self::$dataCache->getItem( $this->mCode, 'fallback8bitEncoding' );
@@ -4154,6 +4154,8 @@ 
 	 * @param Title &$nt The title object of the link
 	 * @param bool $ignoreOtherCond To disable other conditions when
 	 *   we need to transclude a template or update a category's link
+	 * @param string $link
+	 * @param Title $nt
 	 */
 	public function findVariantLink( &$link, &$nt, $ignoreOtherCond = false ) {
 		$this->mConverter->findVariantLink( $link, $nt, $ignoreOtherCond );
@@ -4469,7 +4471,7 @@ 
 
 	/**
 	 * @param string $talk
-	 * @return mixed
+	 * @return string
 	 */
 	function fixVariableInNamespace( $talk ) {
 		if ( strpos( $talk, '$1' ) === false ) {
@@ -4545,7 +4547,7 @@ 
 
 	/**
 	 * @todo Document
-	 * @param int|float $seconds
+	 * @param double $seconds
 	 * @param array $format Optional
 	 *   If $format['avoid'] === 'avoidseconds': don't mention seconds if $seconds >= 1 hour.
 	 *   If $format['avoid'] === 'avoidminutes': don't mention seconds/minutes if $seconds > 48 hours.
@@ -4714,7 +4716,7 @@ 
 	 * @param string $details HTML safe text between brackets
 	 * @param bool $oppositedm Add the direction mark opposite to your
 	 *   language, to display text properly
-	 * @return HTML escaped string
+	 * @return string escaped string
 	 */
 	function specialList( $page, $details, $oppositedm = true ) {
 		if ( !$details ) {
@@ -4799,7 +4801,7 @@ 
 	/**
 	 * Get the conversion rule title, if any.
 	 *
-	 * @return string
+	 * @return boolean
 	 */
 	public function getConvRuleTitle() {
 		return $this->mConverter->getConvRuleTitle();

includes/cache/localisation/LCStoreCDB.php

Doc Comments +5 added lines

@@ -130,6 +130,11 @@
 		}
 	}
 
+	/**
+	 * @param string $code
+	 *
+	 * @return string
+	 */
 	protected function getFileName( $code ) {
 		if ( strval( $code ) === '' || strpos( $code, '/' ) !== false ) {
 			throw new MWException( __METHOD__ . ": Invalid language \"$code\"" );

includes/cache/localisation/LocalisationCache.php

Doc Comments +1 added lines, -1 removed lines

@@ -691,7 +691,7 @@
 	 *
 	 * @param string $code
 	 * @param array $deps
-	 * @return array
+	 * @return string
 	 */
 	protected function readSourceFilesAndRegisterDeps( $code, &$deps ) {
 		global $IP;

includes/specials/pagers/AllMessagesTablePager.php

Doc Comments +11 added lines, -1 removed lines

@@ -97,6 +97,10 @@ 
 	 */
 	public $custom;
 
+	/**
+	 * @param SpecialAllMessages $page
+	 * @param Language $langObj
+	 */
 	function __construct( $page, $conds, $langObj = null ) {
 		parent::__construct( $page->getContext() );
 		$this->mIndexField = 'am_title';
@@ -223,6 +227,9 @@ 
 		return $out;
 	}
 
+	/**
+	 * @param boolean $descending
+	 */
 	function getAllMessages( $descending ) {
 		$messageNames = Language::getLocalisationCache()->getSubitemList( 'en', 'messages' );
 
@@ -247,7 +254,7 @@ 
 	 * @param array $messageNames
 	 * @param string $langcode What language code
 	 * @param bool $foreign Whether the $langcode is not the content language
-	 * @return array A 'pages' and 'talks' array with the keys of existing pages
+	 * @return string A 'pages' and 'talks' array with the keys of existing pages
 	 */
 	public static function getCustomisedStatuses( $messageNames, $langcode = 'en', $foreign = false ) {
 		// FIXME: This function should be moved to Language:: or something.
@@ -439,6 +446,9 @@ 
 		return $arr;
 	}
 
+	/**
+	 * @param string $field
+	 */
 	function getCellAttrs( $field, $value ) {
 		if ( $this->mCurrentRow->am_customised && $field === 'am_title' ) {
 			return array( 'rowspan' => '2', 'class' => $field );

includes/specials/pagers/CategoryPager.php

Doc Comments +3 added lines

@@ -179,6 +179,9 @@
 		return Html::rawElement( 'li', null, $this->getLanguage()->specialList( $link, $count ) ) . "\n";
 	}
 
+	/**
+	 * @param string $from
+	 */
 	public function getStartForm( $from ) {
 		return Xml::tags(
 			'form',

includes/specials/pagers/NewPagesPager.php

Doc Comments +3 added lines

@@ -32,6 +32,9 @@
 	 */
 	protected $mForm;
 
+	/**
+	 * @param SpecialNewpages $form
+	 */
 	function __construct( $form, FormOptions $opts ) {
 		parent::__construct( $form->getContext() );
 		$this->mForm = $form;

includes/specials/pagers/ProtectedTitlesPager.php

Doc Comments +6 added lines

@@ -198,6 +198,12 @@
 class ProtectedTitlesPager extends AlphabeticPager {
 	public $mForm, $mConds;
 
+	/**
+	 * @param SpecialProtectedtitles $form
+	 * @param null|string $type
+	 * @param null|string $level
+	 * @param integer|null $namespace
+	 */
 	function __construct( $form, $conds = array(), $type, $level, $namespace,
 		$sizetype = '', $size = 0
 	) {

includes/specials/SpecialDeletedContributions.php

Doc Comments +1 added lines, -1 removed lines

@@ -128,7 +128,7 @@
 	/**
 	 * Generates the subheading with links
 	 * @param User $userObj User object for the target
-	 * @return string Appropriately-escaped HTML to be output literally
+	 * @return Message Appropriately-escaped HTML to be output literally
 	 * @todo FIXME: Almost the same as contributionsSub in SpecialContributions.php. Could be combined.
 	 */
 	function getSubTitle( $userObj ) {

includes/parser/Preprocessor.php

Doc Comments +7 added lines, -8 removed lines

@@ -56,6 +56,7 @@ 
 	 *
 	 * @param string $text
 	 * @param int $flags
+	 * @param string $tree
 	 */
 	protected function cacheSetTree( $text, $flags, $tree ) {
 		$config = RequestContext::getMain()->getConfig();
@@ -84,7 +85,7 @@ 
 	 *
 	 * @param string $text
 	 * @param int $flags
-	 * @return PPNode_Hash_Tree|bool
+	 * @return false|string
 	 */
 	protected function cacheGetTree( $text, $flags ) {
 		$config = RequestContext::getMain()->getConfig();
@@ -128,7 +129,7 @@ 
 	 * Create a new custom frame for programmatic use of parameter replacement
 	 * as used in some extensions.
 	 *
-	 * @param array $args
+	 * @param boolean $args
 	 *
 	 * @return PPFrame
 	 */
@@ -182,7 +183,7 @@ 
 
 	/**
 	 * Expand a document tree node, caching the result on its parent with the given key
-	 * @param string|int $key
+	 * @param string $key
 	 * @param string|PPNode $root
 	 * @param int $flags
 	 * @return string
@@ -201,7 +202,6 @@ 
 	 * Implode with flags for expand()
 	 * @param string $sep
 	 * @param int $flags
-	 * @param string|PPNode $args,...
 	 * @return string
 	 */
 	public function implodeWithFlags( $sep, $flags /*, ... */ );
@@ -209,7 +209,6 @@ 
 	/**
 	 * Implode with no flags specified
 	 * @param string $sep
-	 * @param string|PPNode $args,...
 	 * @return string
 	 */
 	public function implode( $sep /*, ... */ );
@@ -218,7 +217,6 @@ 
 	 * Makes an object that, when expand()ed, will be the same as one obtained
 	 * with implode()
 	 * @param string $sep
-	 * @param string|PPNode $args,...
 	 * @return PPNode
 	 */
 	public function virtualImplode( $sep /*, ... */ );
@@ -228,7 +226,6 @@ 
 	 * @param string $start
 	 * @param string $sep
 	 * @param string $end
-	 * @param string|PPNode $args,...
 	 * @return PPNode
 	 */
 	public function virtualBracketedImplode( $start, $sep, $end /*, ... */ );
@@ -260,7 +257,7 @@ 
 
 	/**
 	 * Get an argument to this frame by name
-	 * @param int|string $name
+	 * @param string $name
 	 * @return string|bool
 	 */
 	public function getArgument( $name );
@@ -289,6 +286,7 @@ 
 	 * to respect it, and it may be removed in the future.
 	 *
 	 * @param bool $flag
+	 * @return void
 	 */
 	public function setVolatile( $flag = true );
 
@@ -325,6 +323,7 @@ 
 	 *
 	 * @see self::getTTL()
 	 * @param int $ttl
+	 * @return void
 	 */
 	public function setTTL( $ttl );