Reformatted some array parameter docs.

Change-Id: Ie9eefd3693e82f483a9ef0da3f972452ae7bf49e

diff --git a/includes/filebackend/FileBackend.php b/includes/filebackend/FileBackend.php
index 00fd6fb..f40b8c1 100644 (file)
--- a/includes/filebackend/FileBackend.php
+++ b/includes/filebackend/FileBackend.php
@@ -684,7 +684,7 @@ abstract class FileBackend {
         * except they are only applied *if* the directory/container had to be created.
         * These flags should always be set for directories that have private files.
         *
-        * @param $params Array
+        * @param array $params
         * $params include:
         *   - dir            : storage directory
         *   - noAccess       : try to deny file access (since 1.20)
@@ -712,7 +712,7 @@ abstract class FileBackend {
         * access to the storage user representing end-users in web requests.
         * This is not guaranteed to actually do anything.
         *
-        * @param $params Array
+        * @param array $params
         * $params include:
         *   - dir            : storage directory
         *   - noAccess       : try to deny file access
@@ -740,7 +740,7 @@ abstract class FileBackend {
         * access to the storage user representing end-users in web requests.
         * This essentially can undo the result of secure() calls.
         *
-        * @param $params Array
+        * @param array $params
         * $params include:
         *   - dir            : storage directory
         *   - access         : try to allow file access
@@ -767,7 +767,7 @@ abstract class FileBackend {
         * Backends using key/value stores may do nothing unless the directory
         * is that of an empty container, in which case it will be deleted.
         *
-        * @param $params Array
+        * @param array $params
         * $params include:
         *   - dir            : storage directory
         *   - recursive      : recursively delete empty subdirectories first (since 1.20)
@@ -806,7 +806,7 @@ abstract class FileBackend {
         * Check if a file exists at a storage path in the backend.
         * This returns false if only a directory exists at the path.
         *
-        * @param $params Array
+        * @param array $params
         * $params include:
         *   - src    : source storage path
         *   - latest : use the latest available data
@@ -817,7 +817,7 @@ abstract class FileBackend {
        /**
         * Get the last-modified timestamp of the file at a storage path.
         *
-        * @param $params Array
+        * @param array $params
         * $params include:
         *   - src    : source storage path
         *   - latest : use the latest available data
@@ -829,7 +829,7 @@ abstract class FileBackend {
         * Get the contents of a file at a storage path in the backend.
         * This should be avoided for potentially large files.
         *
-        * @param $params Array
+        * @param array $params
         * $params include:
         *   - src    : source storage path
         *   - latest : use the latest available data
@@ -849,7 +849,7 @@ abstract class FileBackend {
         *
         * @see FileBackend::getFileContents()
         *
-        * @param $params Array
+        * @param array $params
         * $params include:
         *   - srcs        : list of source storage paths
         *   - latest      : use the latest available data
@@ -862,7 +862,7 @@ abstract class FileBackend {
        /**
         * Get the size (bytes) of a file at a storage path in the backend.
         *
-        * @param $params Array
+        * @param array $params
         * $params include:
         *   - src    : source storage path
         *   - latest : use the latest available data
@@ -878,7 +878,7 @@ abstract class FileBackend {
         *   - size   : the file size (bytes)
         * Additional values may be included for internal use only.
         *
-        * @param $params Array
+        * @param array $params
         * $params include:
         *   - src    : source storage path
         *   - latest : use the latest available data
@@ -889,7 +889,7 @@ abstract class FileBackend {
        /**
         * Get a SHA-1 hash of the file at a storage path in the backend.
         *
-        * @param $params Array
+        * @param array $params
         * $params include:
         *   - src    : source storage path
         *   - latest : use the latest available data
@@ -901,7 +901,7 @@ abstract class FileBackend {
         * Get the properties of the file at a storage path in the backend.
         * This gives the result of FSFile::getProps() on a local copy of the file.
         *
-        * @param $params Array
+        * @param array $params
         * $params include:
         *   - src    : source storage path
         *   - latest : use the latest available data
@@ -916,7 +916,7 @@ abstract class FileBackend {
         * will be sent if streaming began, while none will be sent otherwise.
         * Implementations should flush the output buffer before sending data.
         *
-        * @param $params Array
+        * @param array $params
         * $params include:
         *   - src     : source storage path
         *   - headers : list of additional HTTP headers to send on success
@@ -938,7 +938,7 @@ abstract class FileBackend {
         * In that later case, there are copies of the file that must stay in sync.
         * Additionally, further calls to this function may return the same file.
         *
-        * @param $params Array
+        * @param array $params
         * $params include:
         *   - src    : source storage path
         *   - latest : use the latest available data
@@ -958,7 +958,7 @@ abstract class FileBackend {
         *
         * @see FileBackend::getLocalReference()
         *
-        * @param $params Array
+        * @param array $params
         * $params include:
         *   - srcs        : list of source storage paths
         *   - latest      : use the latest available data
@@ -973,7 +973,7 @@ abstract class FileBackend {
         * The temporary copy will have the same file extension as the source.
         * Temporary files may be purged when the file object falls out of scope.
         *
-        * @param $params Array
+        * @param array $params
         * $params include:
         *   - src    : source storage path
         *   - latest : use the latest available data
@@ -993,7 +993,7 @@ abstract class FileBackend {
         *
         * @see FileBackend::getLocalCopy()
         *
-        * @param $params Array
+        * @param array $params
         * $params include:
         *   - srcs        : list of source storage paths
         *   - latest      : use the latest available data
@@ -1013,7 +1013,7 @@ abstract class FileBackend {
         * Otherwise, one would need to use getLocalReference(), which involves loading
         * the entire file on to local disk.
         *
-        * @param $params Array
+        * @param array $params
         * $params include:
         *   - src : source storage path
         *   - ttl : lifetime (seconds) if pre-authenticated; default is 1 day

diff --git a/includes/filebackend/FileBackendStore.php b/includes/filebackend/FileBackendStore.php
index 3723df0..3f1d185 100644 (file)
--- a/includes/filebackend/FileBackendStore.php
+++ b/includes/filebackend/FileBackendStore.php
@@ -100,7 +100,7 @@ abstract class FileBackendStore extends FileBackend {
         *   - dstExists   : Whether a file exists at the destination (optimization).
         *                   Callers can use "false" if no existing file is being changed.
         *
-        * @param $params Array
+        * @param array $params
         * @return Status
         */
        final public function createInternal( array $params ) {
@@ -143,7 +143,7 @@ abstract class FileBackendStore extends FileBackend {
         *   - dstExists   : Whether a file exists at the destination (optimization).
         *                   Callers can use "false" if no existing file is being changed.
         *
-        * @param $params Array
+        * @param array $params
         * @return Status
         */
        final public function storeInternal( array $params ) {
@@ -186,7 +186,7 @@ abstract class FileBackendStore extends FileBackend {
         *   - dstExists           : Whether a file exists at the destination (optimization).
         *                           Callers can use "false" if no existing file is being changed.
         *
-        * @param $params Array
+        * @param array $params
         * @return Status
         */
        final public function copyInternal( array $params ) {
@@ -219,7 +219,7 @@ abstract class FileBackendStore extends FileBackend {
         *                           If the status is OK, then its value field will be
         *                           set to a FileBackendStoreOpHandle object.
         *
-        * @param $params Array
+        * @param array $params
         * @return Status
         */
        final public function deleteInternal( array $params ) {
@@ -255,7 +255,7 @@ abstract class FileBackendStore extends FileBackend {
         *   - dstExists           : Whether a file exists at the destination (optimization).
         *                           Callers can use "false" if no existing file is being changed.
         *
-        * @param $params Array
+        * @param array $params
         * @return Status
         */
        final public function moveInternal( array $params ) {
@@ -300,7 +300,7 @@ abstract class FileBackendStore extends FileBackend {
         *                     If the status is OK, then its value field will be
         *                     set to a FileBackendStoreOpHandle object.
         *
-        * @param $params Array
+        * @param array $params
         * @return Status
         */
        final public function describeInternal( array $params ) {
@@ -326,7 +326,7 @@ abstract class FileBackendStore extends FileBackend {
         * No-op file operation that does nothing.
         * Do not call this function from places outside FileBackend and FileOp.
         *
-        * @param $params Array
+        * @param array $params
         * @return Status
         */
        final public function nullInternal( array $params ) {
@@ -971,7 +971,7 @@ abstract class FileBackendStore extends FileBackend {
         *
         * @param string $container Resolved container name
         * @param string $dir Resolved path relative to container
-        * @param $params Array
+        * @param array $params
         * @return bool|null
         */
        abstract protected function doDirectoryExists( $container, $dir, array $params );
@@ -1004,7 +1004,7 @@ abstract class FileBackendStore extends FileBackend {
         *
         * @param string $container Resolved container name
         * @param string $dir Resolved path relative to container
-        * @param $params Array
+        * @param array $params
         * @return Traversable|Array|null Returns null on failure
         */
        abstract public function getDirectoryListInternal( $container, $dir, array $params );
@@ -1037,7 +1037,7 @@ abstract class FileBackendStore extends FileBackend {
         *
         * @param string $container Resolved container name
         * @param string $dir Resolved path relative to container
-        * @param $params Array
+        * @param array $params
         * @return Traversable|Array|null Returns null on failure
         */
        abstract public function getFileListInternal( $container, $dir, array $params );
@@ -1809,7 +1809,7 @@ abstract class FileBackendStoreShardListIterator implements Iterator {
         * @param string $container Full storage container name
         * @param string $dir Storage directory relative to container
         * @param array $suffixes List of container shard suffixes
-        * @param $params Array
+        * @param array $params
         */
        public function __construct(
                FileBackendStore $backend, $container, $dir, array $suffixes, array $params
@@ -1937,7 +1937,7 @@ abstract class FileBackendStoreShardListIterator implements Iterator {
         *
         * @param string $container Resolved container name
         * @param string $dir Resolved path relative to container
-        * @param $params Array
+        * @param array $params
         * @return Traversable|Array|null
         */
        abstract protected function listFromShard( $container, $dir, array $params );

diff --git a/includes/filebackend/SwiftFileBackend.php b/includes/filebackend/SwiftFileBackend.php
index 78386e0..6357b86 100644 (file)
--- a/includes/filebackend/SwiftFileBackend.php
+++ b/includes/filebackend/SwiftFileBackend.php
@@ -1257,7 +1257,7 @@ class SwiftFileBackend extends FileBackendStore {
         * on a FileBackend params array, e.g. that of getLocalCopy().
         * $params is currently only checked for a 'latest' flag.
         *
-        * @param $params Array
+        * @param array $params
         * @return Array
         */
        protected function headersFromParams( array $params ) {
@@ -1514,7 +1514,7 @@ class SwiftFileBackend extends FileBackendStore {
         * @param $e Exception
         * @param $status Status|null
         * @param $func string
-        * @param $params Array
+        * @param array $params
         * @return void
         */
        protected function handleException( Exception $e, $status, $func, array $params ) {
@@ -1583,7 +1583,7 @@ abstract class SwiftFileBackendList implements Iterator {
         * @param $backend SwiftFileBackend
         * @param string $fullCont Resolved container name
         * @param string $dir Resolved directory relative to container
-        * @param $params Array
+        * @param array $params
         */
        public function __construct( SwiftFileBackend $backend, $fullCont, $dir, array $params ) {
                $this->backend = $backend;
@@ -1656,7 +1656,7 @@ abstract class SwiftFileBackendList implements Iterator {
         * @param string $dir Resolved path relative to container
         * @param $after string|null
         * @param $limit integer
-        * @param $params Array
+        * @param array $params
         * @return Traversable|Array|null Returns null on failure
         */
        abstract protected function pageFromList( $container, $dir, &$after, $limit, array $params );