[FileBackend] Improved getFileProps() docs a bit.
authorASchulz <aschulz@wikimedia.org>
Wed, 21 Nov 2012 23:30:54 +0000 (15:30 -0800)
committerASchulz <aschulz@wikimedia.org>
Wed, 21 Nov 2012 23:30:54 +0000 (15:30 -0800)
Change-Id: I37dfc6c90829aa63511570c4576666e41764b6df

includes/filebackend/FileBackend.php

index 678491e..26270f7 100644 (file)
@@ -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 );