From: ASchulz <aschulz@wikimedia.org>
Date: Wed, 21 Nov 2012 23:30:54 +0000 (-0800)
Subject: [FileBackend] Improved getFileProps() docs a bit.
X-Git-Tag: 1.31.0-rc.0~21539^2
X-Git-Url: http://git.cyclocoop.org/%24action?a=commitdiff_plain;h=ef1bb48307af193b7bca4a00b501449cc507d79c;p=lhc%2Fweb%2Fwiklou.git

[FileBackend] Improved getFileProps() docs a bit.

Change-Id: I37dfc6c90829aa63511570c4576666e41764b6df
---

diff --git a/includes/filebackend/FileBackend.php b/includes/filebackend/FileBackend.php
index 678491edfc..26270f79ab 100644
--- a/includes/filebackend/FileBackend.php
+++ b/includes/filebackend/FileBackend.php
@@ -884,13 +884,13 @@ abstract class FileBackend {
 
 	/**
 	 * Get the properties of the file at a storage path in the backend.
-	 * Returns FSFile::placeholderProps() on failure.
+	 * This gives the result of FSFile::getProps() on a local copy of the file.
 	 *
 	 * @param $params Array
 	 * $params include:
 	 *   - src    : source storage path
 	 *   - latest : use the latest available data
-	 * @return Array
+	 * @return Array Returns FSFile::placeholderProps() on failure
 	 */
 	abstract public function getFileProps( array $params );