Improve getErrorsByType() docs

Change-Id: I235a82ee1036d59a0f4929fc2170f261280f9b4d

diff --git a/includes/Status.php b/includes/Status.php
index cc7abc8..3d2c887 100644 (file)
--- a/includes/Status.php
+++ b/includes/Status.php
@@ -420,8 +420,11 @@ class Status {
         * Returns a list of status messages of the given type, with message and
         * params left untouched, like a sane version of getStatusArray
         *
-        * @param string $type
+        * Each entry is a map of:
+        *   - message: string message key or MessageSpecifier
+        *   - params: array list of parameters
         *
+        * @param string $type
         * @return array
         */
        public function getErrorsByType( $type ) {

diff --git a/includes/libs/StatusValue.php b/includes/libs/StatusValue.php
index 10d4c71..1d23f9d 100644 (file)
--- a/includes/libs/StatusValue.php
+++ b/includes/libs/StatusValue.php
@@ -197,7 +197,9 @@ class StatusValue {
        /**
         * Returns a list of status messages of the given type
         *
-        * Each entry is a map of (message:string or MessageSpecifier,params:array))
+        * Each entry is a map of:
+        *   - message: string message key or MessageSpecifier
+        *   - params: array list of parameters
         *
         * @param string $type
         * @return array