From 5db865d4535492c367630a1ce3ce090343e5d15a Mon Sep 17 00:00:00 2001 From: Aryeh Gregor Date: Wed, 23 Sep 2009 15:16:05 +0000 Subject: [PATCH] Improve $attribs documentation in Html As suggested by Nikerabbit on code review for r56778, noted how boolean attributes are handled in a function-level comment. Also adjusted comments to reduce duplication by referring to other functions' comments. --- includes/Html.php | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/includes/Html.php b/includes/Html.php index 821822c038..1998283ce1 100644 --- a/includes/Html.php +++ b/includes/Html.php @@ -99,8 +99,8 @@ class Html { * * @param $element string The element's name, e.g., 'a' * @param $attribs array Associative array of attributes, e.g., array( - * 'href' => 'http://www.mediawiki.org/' ). Values will be HTML-escaped. - * A value of false means to omit the attribute. + * 'href' => 'http://www.mediawiki.org/' ). See expandAttributes() for + * further documentation. * @param $contents string The raw HTML contents of the element: *not* * escaped! * @return string Raw HTML @@ -192,7 +192,8 @@ class Html { * * @param $element string Name of the element, e.g., 'a' * @param $attribs array Associative array of attributes, e.g., array( - * 'href' => 'http://www.mediawiki.org/' ). + * 'href' => 'http://www.mediawiki.org/' ). See expandAttributes() for + * further documentation. * @return array An array of attributes functionally identical to $attribs */ private static function dropDefaults( $element, $attribs ) { @@ -290,7 +291,9 @@ class Html { * * @param $attribs array Associative array of attributes, e.g., array( * 'href' => 'http://www.mediawiki.org/' ). Values will be HTML-escaped. - * A value of false means to omit the attribute. + * A value of false means to omit the attribute. For boolean attributes, + * you can omit the key, e.g., array( 'checked' ) instead of + * array( 'checked' => 'checked' ) or such. * @return string HTML fragment that goes between element name and '>' * (starting with a space if at least one attribute is output) */ -- 2.20.1