Merge "Improve getErrorsByType() docs"
authorjenkins-bot <jenkins-bot@gerrit.wikimedia.org>
Thu, 21 Apr 2016 21:25:39 +0000 (21:25 +0000)
committerGerrit Code Review <gerrit@wikimedia.org>
Thu, 21 Apr 2016 21:25:39 +0000 (21:25 +0000)
includes/Status.php
includes/libs/StatusValue.php

index cc7abc8..3d2c887 100644 (file)
@@ -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 ) {
index 10d4c71..1d23f9d 100644 (file)
@@ -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