wikimedia / mediawiki

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/LocalisationCache.php

Doc Comments +9 added lines, -1 removed lines

@@ -692,7 +692,7 @@ 
 	 *
 	 * @param string $code
 	 * @param array $deps
-	 * @return array
+	 * @return string
 	 */
 	protected function readSourceFilesAndRegisterDeps( $code, &$deps ) {
 		global $IP;
@@ -1125,11 +1125,13 @@ 
 	/**
 	 * Start a write transaction.
 	 * @param string $code Language code
+	 * @return void
 	 */
 	function startWrite( $code );
 
 	/**
 	 * Finish a write transaction.
+	 * @return void
 	 */
 	function finishWrite();
 
@@ -1138,6 +1140,7 @@ 
 	 * is called, and finishWrite() must be called afterwards.
 	 * @param string $key
 	 * @param mixed $value
+	 * @return void
 	 */
 	function set( $key, $value );
 }
@@ -1346,6 +1349,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/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/Category.php

Doc Comments +8 added lines, -8 removed lines

@@ -126,7 +126,7 @@ 
 	 * Factory function.
 	 *
 	 * @param Title $title Title for the category page
-	 * @return Category|bool On a totally invalid name
+	 * @return Category On a totally invalid name
 	 */
 	public static function newFromTitle( $title ) {
 		$cat = new self();
@@ -196,42 +196,42 @@ 
 	}
 
 	/**
-	 * @return mixed DB key name, or false on failure
+	 * @return boolean DB key name, or false on failure
 	 */
 	public function getName() {
 		return $this->getX( 'mName' );
 	}
 
 	/**
-	 * @return mixed Category ID, or false on failure
+	 * @return boolean Category ID, or false on failure
 	 */
 	public function getID() {
 		return $this->getX( 'mID' );
 	}
 
 	/**
-	 * @return mixed Total number of member pages, or false on failure
+	 * @return boolean Total number of member pages, or false on failure
 	 */
 	public function getPageCount() {
 		return $this->getX( 'mPages' );
 	}
 
 	/**
-	 * @return mixed Number of subcategories, or false on failure
+	 * @return boolean Number of subcategories, or false on failure
 	 */
 	public function getSubcatCount() {
 		return $this->getX( 'mSubcats' );
 	}
 
 	/**
-	 * @return mixed Number of member files, or false on failure
+	 * @return boolean Number of member files, or false on failure
 	 */
 	public function getFileCount() {
 		return $this->getX( 'mFiles' );
 	}
 
 	/**
-	 * @return Title|bool Title for this category, or false on failure.
+	 * @return Title Title for this category, or false on failure.
 	 */
 	public function getTitle() {
 		if ( $this->mTitle ) {
@@ -251,7 +251,7 @@ 
 	 * category sort key $offset.
 	 * @param int $limit
 	 * @param string $offset
-	 * @return TitleArray TitleArray object for category members.
+	 * @return TitleArrayFromResult|null TitleArray object for category members.
 	 */
 	public function getMembers( $limit = false, $offset = '' ) {
 

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 ) );

includes/changes/CategoryMembershipChange.php

Doc Comments +1 added lines, -1 removed lines

@@ -207,7 +207,7 @@
 	 * False will be returned if the user name specified in the
 	 * 'autochange-username' message is invalid.
 	 *
-	 * @return User|bool
+	 * @return null|User
 	 */
 	private function getUser() {
 		if ( $this->revision ) {

includes/changes/EnhancedChangesList.php

Doc Comments +1 added lines, -1 removed lines

@@ -447,7 +447,7 @@
 	/**
 	 * Generates amount of changes (linking to diff ) & link to history.
 	 *
-	 * @param array $block
+	 * @param RCCacheEntry[] $block
 	 * @param array $queryParams
 	 * @param bool $allLogs
 	 * @param bool $isnew

includes/changes/OldChangesList.php

Doc Comments +1 added lines, -1 removed lines

@@ -29,7 +29,7 @@
 	 * @param bool $watched (default false)
 	 * @param int $linenumber (default null)
 	 *
-	 * @return string|bool
+	 * @return false|string
 	 */
 	public function recentChangesLine( &$rc, $watched = false, $linenumber = null ) {