diff options
| author | Bartosz Dziewoński <dziewonski@fastmail.fm> | 2024-04-03 20:49:04 +0200 |
|---|---|---|
| committer | Bartosz Dziewoński <dziewonski@fastmail.fm> | 2024-04-09 20:25:18 +0200 |
| commit | 02044a5ba1a4355d9cd7c8b5f8f3f884728f1194 (patch) | |
| tree | 81c59b4056503c41bedfed97f8f3b9ca2647bc25 /includes/api | |
| parent | da9ac63105617e5b2ce0a555dd291c62dbdd4237 (diff) | |
| download | mediawikicore-02044a5ba1a4355d9cd7c8b5f8f3f884728f1194.tar.gz mediawikicore-02044a5ba1a4355d9cd7c8b5f8f3f884728f1194.zip | |
Document more methods that accept MessageSpecifier, not just Message
These methods can already handle any MessageSpecifier, but their
documentation didn't show this.
Change-Id: I1323d18baf17a8a27cc9bed31860c4cc89e61a22
Diffstat (limited to 'includes/api')
| -rw-r--r-- | includes/api/ApiBase.php | 4 | ||||
| -rw-r--r-- | includes/api/ApiErrorFormatter.php | 4 | ||||
| -rw-r--r-- | includes/api/ApiMessage.php | 6 |
3 files changed, 7 insertions, 7 deletions
diff --git a/includes/api/ApiBase.php b/includes/api/ApiBase.php index c001ef4aed42..ce6e43b9ce43 100644 --- a/includes/api/ApiBase.php +++ b/includes/api/ApiBase.php @@ -1444,7 +1444,7 @@ abstract class ApiBase extends ContextSource { * message key by stripping any "apiwarn-" or "apierror-" prefix. * * @since 1.29 - * @param string|array|Message $msg See ApiErrorFormatter::addWarning() + * @param string|array|MessageSpecifier $msg See ApiErrorFormatter::addWarning() * @param string|null $code See ApiErrorFormatter::addWarning() * @param array|null $data See ApiErrorFormatter::addWarning() */ @@ -1458,7 +1458,7 @@ abstract class ApiBase extends ContextSource { * A combination of $this->addWarning() and $this->logFeatureUsage() * * @since 1.29 - * @param string|array|Message $msg See ApiErrorFormatter::addWarning() + * @param string|array|MessageSpecifier $msg See ApiErrorFormatter::addWarning() * @param string|null $feature See ApiBase::logFeatureUsage() * @param array|null $data See ApiErrorFormatter::addWarning() */ diff --git a/includes/api/ApiErrorFormatter.php b/includes/api/ApiErrorFormatter.php index cfdc3ec348b3..f3db31db4a4f 100644 --- a/includes/api/ApiErrorFormatter.php +++ b/includes/api/ApiErrorFormatter.php @@ -150,7 +150,7 @@ class ApiErrorFormatter { /** * Add a warning to the result * @param string|null $modulePath - * @param Message|array|string $msg Warning message. See ApiMessage::create(). + * @param MessageSpecifier|array|string $msg Warning message. See ApiMessage::create(). * @param string|null $code See ApiMessage::create(). * @param array|null $data See ApiMessage::create(). */ @@ -165,7 +165,7 @@ class ApiErrorFormatter { /** * Add an error to the result * @param string|null $modulePath - * @param Message|array|string $msg Warning message. See ApiMessage::create(). + * @param MessageSpecifier|array|string $msg Warning message. See ApiMessage::create(). * @param string|null $code See ApiMessage::create(). * @param array|null $data See ApiMessage::create(). */ diff --git a/includes/api/ApiMessage.php b/includes/api/ApiMessage.php index b5ba0ea17579..b2dd8107ccdc 100644 --- a/includes/api/ApiMessage.php +++ b/includes/api/ApiMessage.php @@ -36,7 +36,7 @@ class ApiMessage extends Message implements IApiMessage { * $msg is a RawMessage, or calls 'new ApiMessage' in all other cases. * * @stable to call - * @param Message|RawMessage|array|string $msg + * @param MessageSpecifier|array|string $msg * @param string|null $code * @param array|null $data * @return IApiMessage @@ -65,10 +65,10 @@ class ApiMessage extends Message implements IApiMessage { } /** - * @param Message|string|array $msg + * @param MessageSpecifier|string|array $msg * - Message: is cloned * - array: first element is $key, rest are $params to Message::__construct - * - string: passed to Message::__construct + * - string, any other MessageSpecifier: passed to Message::__construct * @param string|null $code * @param array|null $data */ |