From 75752d58ee8eade43eaf05f720bf6f620d30a6af Mon Sep 17 00:00:00 2001 From: Aaron Schulz Date: Mon, 18 Apr 2016 09:08:26 -0700 Subject: [PATCH] Improve getErrorsByType() docs Change-Id: I235a82ee1036d59a0f4929fc2170f261280f9b4d --- includes/Status.php | 5 ++++- includes/libs/StatusValue.php | 4 +++- 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/includes/Status.php b/includes/Status.php index cc7abc8200..3d2c887126 100644 --- 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 10d4c7135b..1d23f9d368 100644 --- 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 -- 2.20.1