From: Umherirrender <umherirrender_de.wp@web.de>
Date: Mon, 13 Aug 2018 07:16:11 +0000 (+0200)
Subject: Expand documentation about options in HTMLForm
X-Git-Tag: 1.34.0-rc.0~4308^2
X-Git-Url: http://git.cyclocoop.org/%27%20.%20%24prefix%20.%20Wiki::transformTitleToURI%28%24matches%5B1%5D%29%20.%20%27?a=commitdiff_plain;h=7b01567b00420fc66ad8d084d55ec4b085641bb3;p=lhc%2Fweb%2Fwiklou.git

Expand documentation about options in HTMLForm

Change-Id: Ia170f07f994680dca105981a14ad5a0d98b57a26
---

diff --git a/includes/htmlform/HTMLForm.php b/includes/htmlform/HTMLForm.php
index 442a7cf6fa..c546b49ecb 100644
--- a/includes/htmlform/HTMLForm.php
+++ b/includes/htmlform/HTMLForm.php
@@ -57,10 +57,12 @@ use Wikimedia\ObjectFactory;
  *    'cssclass'            -- CSS class
  *    'csshelpclass'        -- CSS class used to style help text
  *    'dir'                 -- Direction of the element.
- *    'options'             -- associative array mapping labels to values.
+ *    'options'             -- associative array mapping raw text labels to values.
  *                             Some field types support multi-level arrays.
+ *                             Overwrites 'options-message'.
  *    'options-messages'    -- associative array mapping message keys to values.
  *                             Some field types support multi-level arrays.
+ *                             Overwrites 'options' and 'options-message'.
  *    'options-message'     -- message key or object to be parsed to extract the list of
  *                             options (like 'ipbreason-dropdown').
  *    'label-message'       -- message key or object for a message to use as the label.