From: Sam Reed <reedy@users.mediawiki.org>
Date: Fri, 25 Mar 2011 11:21:53 +0000 (+0000)
Subject: Add/update/improve various bits of documentation
X-Git-Tag: 1.31.0-rc.0~31193
X-Git-Url: https://git.cyclocoop.org/%7B%24www_url%7Dadmin/compta/banques/ajouter.php?a=commitdiff_plain;h=d3f043c53a0b95947ac2f97178d214481891a24e;p=lhc%2Fweb%2Fwiklou.git

Add/update/improve various bits of documentation
---

diff --git a/includes/GlobalFunctions.php b/includes/GlobalFunctions.php
index 18d08ea2aa..6604435037 100644
--- a/includes/GlobalFunctions.php
+++ b/includes/GlobalFunctions.php
@@ -3369,7 +3369,7 @@ function wfArrayMap( $function, $input ) {
 
 /**
  * Get a cache object.
- * @param $inputType Cache type, one the the CACHE_* constants.
+ * @param integer $inputType Cache type, one the the CACHE_* constants.
  *
  * @return BagOStuff
  */
diff --git a/includes/job/UploadFromUrlJob.php b/includes/job/UploadFromUrlJob.php
index d48104b927..3f91524505 100644
--- a/includes/job/UploadFromUrlJob.php
+++ b/includes/job/UploadFromUrlJob.php
@@ -18,7 +18,14 @@
 class UploadFromUrlJob extends Job {
 	const SESSION_KEYNAME = 'wsUploadFromUrlJobData';
 
+	/**
+	 * @var UploadFromUrl
+	 */
 	public $upload;
+
+	/**
+	 * @var User
+	 */
 	protected $user;
 
 	public function __construct( $title, $params, $id = 0 ) {
diff --git a/includes/search/SearchEngine.php b/includes/search/SearchEngine.php
index 141f67278d..5ed470bba4 100644
--- a/includes/search/SearchEngine.php
+++ b/includes/search/SearchEngine.php
@@ -630,9 +630,23 @@ class SearchResultTooMany {
  * @ingroup Search
  */
 class SearchResult {
+
+	/**
+	 * @var Revision
+	 */
 	var $mRevision = null;
 	var $mImage = null;
 
+	/**
+	 * @var Title
+	 */
+	var $mTitle;
+
+	/**
+	 * @var String
+	 */
+	var $mText;
+
 	/**
 	 * Return a new SearchResult and initializes it with a title.
 	 * 
diff --git a/includes/upload/UploadStash.php b/includes/upload/UploadStash.php
index dfcfec0d77..7a3c01baba 100644
--- a/includes/upload/UploadStash.php
+++ b/includes/upload/UploadStash.php
@@ -16,8 +16,12 @@ class UploadStash {
 	// Format of the key for files -- has to be suitable as a filename itself (e.g. ab12cd34ef.jpg)
 	const KEY_FORMAT_REGEX = '/^[\w-]+\.\w+$/';
 
-	// repository that this uses to store temp files
-	// public because we sometimes need to get a LocalFile within the same repo.
+	/**
+	 * repository that this uses to store temp files
+	 * public because we sometimes need to get a LocalFile within the same repo.
+	 *
+	 * @var LocalRepo
+	 */
 	public $repo;
 
 	// array of initialized objects obtained from session (lazily initialized upon getFile())
@@ -235,7 +239,7 @@ class UploadStashFile extends UnregisteredLocalFile {
 	 * Arguably UnregisteredLocalFile should be handling its own file repo but that class is a bit retarded currently
 	 *
 	 * @param $stash UploadStash: useful for obtaining config, stashing transformed files
-	 * @param $repo FileRepo: repository where we should find the path
+	 * @param $repo FSRepo: repository where we should find the path
 	 * @param $path String: path to file
 	 * @param $key String: key to store the path and any stashed data under
 	 * @param $data String: any other data we want stored with this file