From: Siebrand Mazeland <s.mazeland@xs4all.nl>
Date: Mon, 30 Dec 2013 17:32:53 +0000 (+0100)
Subject: Random documentation tweaks
X-Git-Tag: 1.31.0-rc.0~17411^2
X-Git-Url: http://git.heureux-cyclage.org/?a=commitdiff_plain;h=8a096e3444d592e442f62d035bcd4048f32b72e3;p=lhc%2Fweb%2Fwiklou.git

Random documentation tweaks

Change-Id: I57c3bde6551c14324cf34e4db003a319d6cebc47
---

diff --git a/includes/actions/HistoryAction.php b/includes/actions/HistoryAction.php
index 34db1d2172..8e800f9c8e 100644
--- a/includes/actions/HistoryAction.php
+++ b/includes/actions/HistoryAction.php
@@ -260,6 +260,7 @@ class HistoryAction extends FormlessAction {
 		}
 		$request = $this->getRequest();
 
+		/** @var RSSFeed|AtomFeed $feed */
 		$feed = new $wgFeedClasses[$type](
 			$this->getTitle()->getPrefixedText() . ' - ' .
 			$this->msg( 'history-feed-title' )->inContentLanguage()->text(),
diff --git a/includes/actions/RollbackAction.php b/includes/actions/RollbackAction.php
index d48a0ea227..617f1c9998 100644
--- a/includes/actions/RollbackAction.php
+++ b/includes/actions/RollbackAction.php
@@ -62,6 +62,7 @@ class RollbackAction extends FormlessAction {
 			$this->getOutput()->addWikiMsgArray( $errMsg, $errArray );
 
 			if ( isset( $details['current'] ) ) {
+				/** @var Revision $current */
 				$current = $details['current'];
 
 				if ( $current->getComment() != '' ) {
@@ -85,6 +86,7 @@ class RollbackAction extends FormlessAction {
 			throw new ErrorPageError( 'rollbackfailed', $error[0], array_slice( $error, 1 ) );
 		}
 
+		/** @var Revision $current */
 		$current = $details['current'];
 		$target = $details['target'];
 		$newId = $details['newid'];
diff --git a/includes/api/ApiFileRevert.php b/includes/api/ApiFileRevert.php
index dc5e24e717..a3fa5f9c87 100644
--- a/includes/api/ApiFileRevert.php
+++ b/includes/api/ApiFileRevert.php
@@ -28,13 +28,13 @@
  * @ingroup API
  */
 class ApiFileRevert extends ApiBase {
-
-	/**
-	 * @var File
-	 */
+	/** @var LocalFile */
 	protected $file;
+
+	/** @var string */
 	protected $archiveName;
 
+	/** @var array */
 	protected $params;
 
 	public function execute() {
diff --git a/includes/api/ApiPageSet.php b/includes/api/ApiPageSet.php
index e95e680b03..0d733a2784 100644
--- a/includes/api/ApiPageSet.php
+++ b/includes/api/ApiPageSet.php
@@ -308,7 +308,7 @@ class ApiPageSet extends ApiBase {
 
 	/**
 	 * All Title objects provided.
-	 * @return array of Title objects
+	 * @return Title[]
 	 */
 	public function getTitles() {
 		return $this->mTitles;
@@ -324,7 +324,7 @@ class ApiPageSet extends ApiBase {
 
 	/**
 	 * Title objects that were found in the database.
-	 * @return array page_id (int) => Title (obj)
+	 * @return Title[] Array page_id (int) => Title (obj)
 	 */
 	public function getGoodTitles() {
 		return $this->mGoodTitles;
@@ -341,7 +341,7 @@ class ApiPageSet extends ApiBase {
 	/**
 	 * Title objects that were NOT found in the database.
 	 * The array's index will be negative for each item
-	 * @return array of Title objects
+	 * @return Title[]
 	 */
 	public function getMissingTitles() {
 		return $this->mMissingTitles;
@@ -350,7 +350,7 @@ class ApiPageSet extends ApiBase {
 	/**
 	 * Titles that were deemed invalid by Title::newFromText()
 	 * The array's index will be unique and negative for each item
-	 * @return array of strings (not Title objects)
+	 * @return string[] Array of strings (not Title objects)
 	 */
 	public function getInvalidTitles() {
 		return $this->mInvalidTitles;
diff --git a/includes/api/ApiUpload.php b/includes/api/ApiUpload.php
index 1a642b9cda..7d0d78e1e8 100644
--- a/includes/api/ApiUpload.php
+++ b/includes/api/ApiUpload.php
@@ -28,10 +28,7 @@
  * @ingroup API
  */
 class ApiUpload extends ApiBase {
-
-	/**
-	 * @var UploadBase
-	 */
+	/** @var UploadBase */
 	protected $mUpload = null;
 
 	protected $mParams;
diff --git a/includes/cache/CacheDependency.php b/includes/cache/CacheDependency.php
index b7d0a7cc7d..28889b50c7 100644
--- a/includes/cache/CacheDependency.php
+++ b/includes/cache/CacheDependency.php
@@ -29,13 +29,14 @@
  */
 class DependencyWrapper {
 	private $value;
+	/** @var CacheDependency[] */
 	private $deps;
 
 	/**
 	 * Create an instance.
 	 * @param $value Mixed: the user-supplied value
-	 * @param $deps Mixed: a dependency or dependency array. All dependencies
-	 *        must be objects implementing CacheDependency.
+	 * @param CacheDependency|CacheDependency[] $deps A dependency or dependency
+	 *   array. All dependencies must be objects implementing CacheDependency.
 	 */
 	function __construct( $value = false, $deps = array() ) {
 		$this->value = $value;
diff --git a/includes/cache/LocalisationCache.php b/includes/cache/LocalisationCache.php
index 47a5904d08..cba2ba7932 100644
--- a/includes/cache/LocalisationCache.php
+++ b/includes/cache/LocalisationCache.php
@@ -1232,9 +1232,16 @@ class LCStoreDB implements LCStore {
  * See Cdb.php and http://cr.yp.to/cdb.html
  */
 class LCStoreCDB implements LCStore {
+	/** @var CdbReader[] */
 	private $readers;
+
+	/** @var CdbWriter */
 	private $writer;
+
+	/** @var string Current language code */
 	private $currentLang;
+
+	/** @var bool|string Cache directory. False if not set */
 	private $directory;
 
 	function __construct( $conf = array() ) {
diff --git a/includes/cache/MessageCache.php b/includes/cache/MessageCache.php
index 8b52728e03..3dee806208 100644
--- a/includes/cache/MessageCache.php
+++ b/includes/cache/MessageCache.php
@@ -124,7 +124,7 @@ class MessageCache {
 	}
 
 	/**
-	 * @param ObjectCache $memCached A cache instance. If none, fall back to CACHE_NONE.
+	 * @param BagOStuff $memCached A cache instance. If none, fall back to CACHE_NONE.
 	 * @param bool $useDB
 	 * @param int $expiry Lifetime for cache. @see $mExpiry.
 	 */
diff --git a/includes/parser/Parser.php b/includes/parser/Parser.php
index 27065e588d..d81ad98df8 100644
--- a/includes/parser/Parser.php
+++ b/includes/parser/Parser.php
@@ -3079,8 +3079,6 @@ class Parser {
 	 * cache may be implemented at a later date which takes further advantage of these strict
 	 * dependency requirements.
 	 *
-	 * @private
-	 *
 	 * @return PPNode
 	 */
 	function preprocessToDom( $text, $flags = 0 ) {