From: Aryeh Gregor <simetrical@users.mediawiki.org>
Date: Wed, 23 Sep 2009 15:16:05 +0000 (+0000)
Subject: Improve $attribs documentation in Html
X-Git-Tag: 1.31.0-rc.0~39558
X-Git-Url: http://git.cyclocoop.org/%22%2C%20generer_url_ecrire%28?a=commitdiff_plain;h=5db865d4535492c367630a1ce3ce090343e5d15a;p=lhc%2Fweb%2Fwiklou.git

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.
---

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)
 	 */