From: Timo Tijhof <krinklemail@gmail.com>
Date: Wed, 6 Jan 2016 00:46:24 +0000 (-0800)
Subject: htmform: Document "text" methods that take HTML as such
X-Git-Tag: 1.31.0-rc.0~8432^2
X-Git-Url: http://git.cyclocoop.org/%22%20.%20generer_url_ecrire%28%22sites_tous%22%29%20.%20%22?a=commitdiff_plain;h=eebc6782c4907889d5ee986273a581161d025506;p=lhc%2Fweb%2Fwiklou.git

htmform: Document "text" methods that take HTML as such

These methods have confusing names, at least document them better.

Follows-up ef8f440de.

Change-Id: Ia2d6bf474d65829d91cae3aeef7ab2d09c4023cf
---

diff --git a/includes/htmlform/HTMLForm.php b/includes/htmlform/HTMLForm.php
index 8bb1bba97d..ee7faa5a16 100644
--- a/includes/htmlform/HTMLForm.php
+++ b/includes/htmlform/HTMLForm.php
@@ -671,10 +671,10 @@ class HTMLForm extends ContextSource {
 	}
 
 	/**
-	 * Set the introductory message, overwriting any existing message.
+	 * Set the introductory message HTML, overwriting any existing message.
 	 * @since 1.19
 	 *
-	 * @param string $msg Complete text of message to display
+	 * @param string $msg Complete HTML of message to display
 	 *
 	 * @return HTMLForm $this for chaining calls (since 1.20)
 	 */
@@ -685,9 +685,9 @@ class HTMLForm extends ContextSource {
 	}
 
 	/**
-	 * Add introductory text.
+	 * Add HTML to introductory message.
 	 *
-	 * @param string $msg Complete text of message to display
+	 * @param string $msg Complete HTML of message to display
 	 *
 	 * @return HTMLForm $this for chaining calls (since 1.20)
 	 */
@@ -698,9 +698,9 @@ class HTMLForm extends ContextSource {
 	}
 
 	/**
-	 * Add header text, inside the form.
+	 * Add HTML to the header, inside the form.
 	 *
-	 * @param string $msg Complete text of message to display
+	 * @param string $msg Additional HTML to display in header
 	 * @param string|null $section The section to add the header to
 	 *
 	 * @return HTMLForm $this for chaining calls (since 1.20)
@@ -722,7 +722,7 @@ class HTMLForm extends ContextSource {
 	 * Set header text, inside the form.
 	 * @since 1.19
 	 *
-	 * @param string $msg Complete text of message to display
+	 * @param string $msg Complete HTML of header to display
 	 * @param string|null $section The section to add the header to
 	 *
 	 * @return HTMLForm $this for chaining calls (since 1.20)
@@ -742,7 +742,7 @@ class HTMLForm extends ContextSource {
 	 *
 	 * @param string|null $section The section to get the header text for
 	 * @since 1.26
-	 * @return string
+	 * @return string HTML
 	 */
 	function getHeaderText( $section = null ) {
 		if ( is_null( $section ) ) {
@@ -957,7 +957,7 @@ class HTMLForm extends ContextSource {
 	 *
 	 * @param bool|string|array|Status $submitResult Output from HTMLForm::trySubmit()
 	 *
-	 * @return string
+	 * @return string HTML
 	 */
 	function getHTML( $submitResult ) {
 		# For good measure (it is the default)