From eebc6782c4907889d5ee986273a581161d025506 Mon Sep 17 00:00:00 2001 From: Timo Tijhof Date: Tue, 5 Jan 2016 16:46:24 -0800 Subject: [PATCH] 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 --- includes/htmlform/HTMLForm.php | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) 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) -- 2.20.1