Merge "[FileBackend] Improved getFileProps() docs a bit."
authorASchulz <aschulz@wikimedia.org>
Thu, 22 Nov 2012 22:09:26 +0000 (22:09 +0000)
committerGerrit Code Review <gerrit@wikimedia.org>
Thu, 22 Nov 2012 22:09:26 +0000 (22:09 +0000)
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 );