wikimedia / mediawiki

includes/api/ApiResult.php

Doc Comments +4 added lines, -4 removed lines

@@ -469,7 +469,7 @@ 
 	 *
 	 * @since 1.25
 	 * @param array &$arr To add $value to
-	 * @param string|int $name Index of $arr to add $value at.
+	 * @param string $name Index of $arr to add $value at.
 	 * @param mixed $value
 	 * @param int $flags Zero or more OR-ed flags like OVERRIDE | ADD_ON_TOP.
 	 */
@@ -486,10 +486,10 @@ 
 	 *
 	 * @since 1.25
 	 * @param array|string|null $path See ApiResult::addValue()
-	 * @param string|int $name See ApiResult::setValue()
+	 * @param string $name See ApiResult::setValue()
 	 * @param mixed $value
 	 * @param int $flags Zero or more OR-ed flags like OVERRIDE | ADD_ON_TOP.
-	 * @return bool True if $value fits in the result, false if not
+	 * @return boolean|null True if $value fits in the result, false if not
 	 */
 	public function addContentValue( $path, $name, $value, $flags = 0 ) {
 		if ( $name === null ) {
@@ -573,7 +573,7 @@ 
 	 * subelements rather than attributes.
 	 * @since 1.25
 	 * @param array|string|null $path See ApiResult::addValue()
-	 * @param array|string|int $names The element name(s) to be output as subelements
+	 * @param string $names The element name(s) to be output as subelements
 	 */
 	public function addSubelementsList( $path, $names ) {
 		$arr = &$this->path( $path );

includes/api/ApiStashEdit.php

Doc Comments +1 added lines, -1 removed lines

@@ -128,7 +128,7 @@
 	 * @param WikiPage $page
 	 * @param Content $content
 	 * @param User $user
-	 * @return integer ApiStashEdit::ERROR_* constant
+	 * @return string ApiStashEdit::ERROR_* constant
 	 * @since 1.25
 	 */
 	public static function parseAndStash( WikiPage $page, Content $content, User $user ) {

includes/api/ApiTag.php

Doc Comments +3 added lines

@@ -73,6 +73,9 @@
 		return (bool)$result;
 	}
 
+	/**
+	 * @param string $type
+	 */
 	protected function processIndividual( $type, $params, $id ) {
 		$idResult = array( $type => $id );
 

includes/AuthPlugin.php

Doc Comments +4 added lines

@@ -323,6 +323,10 @@
 }
 
 class AuthPluginUser {
+
+	/**
+	 * @param User $user
+	 */
 	function __construct( $user ) {
 		# Override this!
 	}

includes/cache/BacklinkCache.php

Doc Comments +2 added lines, -2 removed lines

@@ -112,7 +112,7 @@ 
 	 * failures after this class is deserialized from cache with dead DB
 	 * connection.
 	 *
-	 * @return array
+	 * @return string[]
 	 */
 	function __sleep() {
 		return array( 'partitionCache', 'fullResultCache', 'title' );
@@ -486,7 +486,7 @@ 
 	/**
 	 * Get a Title iterator for cascade-protected template/file use backlinks
 	 *
-	 * @return TitleArray
+	 * @return TitleArrayFromResult|null
 	 * @since 1.25
 	 */
 	public function getCascadeProtectedLinks() {

includes/cache/CacheHelper.php

Doc Comments +5 added lines, -1 removed lines

@@ -33,6 +33,7 @@ 
 	 *
 	 * @since 1.20
 	 * @param bool $cacheEnabled
+	 * @return void
 	 */
 	function setCacheEnabled( $cacheEnabled );
 
@@ -44,6 +45,7 @@ 
 	 *
 	 * @param int|null $cacheExpiry Sets the cache expiry, either ttl in seconds or unix timestamp.
 	 * @param bool|null $cacheEnabled Sets if the cache should be enabled or not.
+	 * @return void
 	 */
 	function startCache( $cacheExpiry = null, $cacheEnabled = null );
 
@@ -68,6 +70,7 @@ 
 	 * Should be called after the last time anything is added via addCachedHTML.
 	 *
 	 * @since 1.20
+	 * @return void
 	 */
 	function saveCache();
 
@@ -78,6 +81,7 @@ 
 	 * @since 1.20
 	 *
 	 * @param int $cacheExpiry
+	 * @return void
 	 */
 	function setExpiry( $cacheExpiry );
 }
@@ -259,7 +263,7 @@ 
 	 * @param array|mixed $args
 	 * @param string|null $key
 	 *
-	 * @return mixed
+	 * @return string
 	 */
 	public function getCachedValue( $computeFunction, $args = array(), $key = null ) {
 		$this->initCaching();

includes/cache/FileCacheBase.php

Doc Comments +1 added lines, -1 removed lines

@@ -98,7 +98,7 @@
 
 	/**
 	 * Get the last-modified timestamp of the cache file
-	 * @return string|bool TS_MW timestamp
+	 * @return string|false TS_MW timestamp
 	 */
 	public function cacheTimestamp() {
 		$timestamp = filemtime( $this->cachePath() );

includes/cache/MessageCache.php

Doc Comments +5 added lines, -5 removed lines

@@ -359,7 +359,7 @@ 
 
 	/**
 	 * @param string $code
-	 * @param array $where List of wfDebug() comments
+	 * @param string[] $where List of wfDebug() comments
 	 * @param integer $mode Use MessageCache::FOR_UPDATE to use DB_MASTER
 	 * @return bool|string True on success or one of ("cantacquire", "disabled")
 	 */
@@ -513,7 +513,7 @@ 
 	 * Updates cache as necessary when message page is changed
 	 *
 	 * @param string|bool $title Name of the page changed (false if deleted)
-	 * @param mixed $text New contents of the page.
+	 * @param string|boolean $text New contents of the page.
 	 */
 	public function replace( $title, $text ) {
 		global $wgMaxMsgCacheEntrySize, $wgContLang, $wgLanguageCode;
@@ -720,7 +720,7 @@ 
 	 * @param bool $isFullKey Specifies whether $key is a two part key "msg/lang".
 	 *
 	 * @throws MWException When given an invalid key
-	 * @return string|bool False if the message doesn't exist, otherwise the
+	 * @return false|string False if the message doesn't exist, otherwise the
 	 *   message (which can be empty)
 	 */
 	function get( $key, $useDB = true, $langcode = true, $isFullKey = false ) {
@@ -799,7 +799,7 @@ 
 	 * the site language.
 	 *
 	 * @see MessageCache::get
-	 * @param Language|StubObject $lang Preferred language
+	 * @param Language $lang Preferred language
 	 * @param string $lckey Lowercase key for the message (as for localisation cache)
 	 * @param bool $useDB Whether to include messages from the wiki database
 	 * @return string|bool The message, or false if not found
@@ -1099,7 +1099,7 @@ 
 
 	/**
 	 * @param string $key
-	 * @return array
+	 * @return string[]
 	 */
 	public function figureMessage( $key ) {
 		global $wgLanguageCode;

includes/CategoryViewer.php

Doc Comments +4 added lines

@@ -188,6 +188,10 @@
 			$this->getSubcategorySortChar( $cat->getTitle(), $sortkey );
 	}
 
+	/**
+	 * @param string $type
+	 * @param string $html
+	 */
 	function generateLink( $type, Title $title, $isRedirect, $html = null ) {
 		$link = null;
 		Hooks::run( 'CategoryViewer::generateLink', array( $type, $title, $html, &$link ) );