Improve PARAM_HELP_MSG_PER_VALUE documentation
authorLucas Werkmeister <lucas.werkmeister@wikimedia.de>
Thu, 11 Jan 2018 17:02:04 +0000 (18:02 +0100)
committerLucas Werkmeister <lucas.werkmeister@wikimedia.de>
Thu, 11 Jan 2018 17:07:26 +0000 (18:07 +0100)
Per-value documentation is only generated if this option is specified,
even if it is only set to an empty array (i. e., when using the default
key for all values). Attempt to make this more clear.

Change-Id: I844df226271aadb1f06b3cc00ba32cc6c06ec76a

includes/api/ApiBase.php

index 83d2ae9..4d7ef28 100644 (file)
@@ -155,6 +155,7 @@ abstract class ApiBase extends ContextSource {
         * ((string|array|Message)[]) When PARAM_TYPE is an array, this is an array
         * mapping those values to $msg for ApiBase::makeMessage(). Any value not
         * having a mapping will use apihelp-{$path}-paramvalue-{$param}-{$value}.
+        * Specify an empty array to use the default message key for all values.
         * @since 1.25
         */
        const PARAM_HELP_MSG_PER_VALUE = 14;