From: Bartosz Dziewoński <matma.rex@gmail.com>
Date: Mon, 20 Jul 2015 13:54:06 +0000 (+0200)
Subject: Correct documentation of ChangeTags::buildTagFilterSelector
X-Git-Tag: 1.31.0-rc.0~10686^2
X-Git-Url: http://git.cyclocoop.org//%27%40script%40/%27?a=commitdiff_plain;h=bc1b025e8b391b16bad2648a3b705d11b56ed761;p=lhc%2Fweb%2Fwiklou.git

Correct documentation of ChangeTags::buildTagFilterSelector

Less duplication, more facts.

Change-Id: I4d97d0be25d0cb271ca07fa63f16a5e2abfe8762
---

diff --git a/includes/changetags/ChangeTags.php b/includes/changetags/ChangeTags.php
index 95f48161d9..1e26caa019 100644
--- a/includes/changetags/ChangeTags.php
+++ b/includes/changetags/ChangeTags.php
@@ -611,14 +611,11 @@ class ChangeTags {
 	 * Build a text box to select a change tag
 	 *
 	 * @param string $selected Tag to select by default
-	 * @param bool $fullForm
-	 *        - if false, then it returns an array of (label, form).
-	 *        - if true, it returns an entire form around the selector.
-	 * @param Title $title Title object to send the form to.
-	 *        Used when, and only when $fullForm is true.
+	 * @param bool $fullForm Affects return value, see below
+	 * @param Title $title Title object to send the form to. Used only if $fullForm is true.
 	 * @return string|array
-	 *        - if $fullForm is false: Array with
-	 *        - if $fullForm is true: String, html fragment
+	 *        - if $fullForm is false: an array of (label, selector).
+	 *        - if $fullForm is true: HTML of entire form built around the selector.
 	 */
 	public static function buildTagFilterSelector( $selected = '',
 		$fullForm = false, Title $title = null