These methods have confusing names, at least document them better.
Follows-up
ef8f440de.
Change-Id: Ia2d6bf474d65829d91cae3aeef7ab2d09c4023cf
- * Set the introductory message, overwriting any existing message.
+ * Set the introductory message HTML, overwriting any existing 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)
*/
*
* @return HTMLForm $this for chaining calls (since 1.20)
*/
- * 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)
*/
*
* @return HTMLForm $this for chaining calls (since 1.20)
*/
- * 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)
* @param string|null $section The section to add the header to
*
* @return HTMLForm $this for chaining calls (since 1.20)
* Set header text, inside the form.
* @since 1.19
*
* 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)
* @param string|null $section The section to add the header to
*
* @return HTMLForm $this for chaining calls (since 1.20)
*
* @param string|null $section The section to get the header text for
* @since 1.26
*
* @param string|null $section The section to get the header text for
* @since 1.26
*/
function getHeaderText( $section = null ) {
if ( is_null( $section ) ) {
*/
function getHeaderText( $section = null ) {
if ( is_null( $section ) ) {
*
* @param bool|string|array|Status $submitResult Output from HTMLForm::trySubmit()
*
*
* @param bool|string|array|Status $submitResult Output from HTMLForm::trySubmit()
*
*/
function getHTML( $submitResult ) {
# For good measure (it is the default)
*/
function getHTML( $submitResult ) {
# For good measure (it is the default)