From: Matthew Flaschen <mflaschen@wikimedia.org>
Date: Tue, 2 May 2017 20:06:37 +0000 (-0400)
Subject: Document "What's This" group UI feature
X-Git-Tag: 1.31.0-rc.0~3367^2
X-Git-Url: http://git.cyclocoop.org/%7B%7B%20url_for%28%27admin_vote_add%27%29%20%7D%7D?a=commitdiff_plain;h=7c161ad4c61ee5579136a371e045e0564a01c8ec;p=lhc%2Fweb%2Fwiklou.git

Document "What's This" group UI feature

Bug: T163069
Change-Id: I1100dbea1549ee208dc0a1e9bcd56d8c93775302
---

diff --git a/includes/changes/ChangesListBooleanFilterGroup.php b/includes/changes/ChangesListBooleanFilterGroup.php
index 1fdcd0021e..1f4b211f0c 100644
--- a/includes/changes/ChangesListBooleanFilterGroup.php
+++ b/includes/changes/ChangesListBooleanFilterGroup.php
@@ -26,6 +26,14 @@ class ChangesListBooleanFilterGroup extends ChangesListFilterGroup {
 	 * *  is an associative array to be passed to the filter constructor.  However,
 	 * *  'priority' is optional for the filters.  Any filter that has priority unset
 	 * *  will be put to the bottom, in the order given.
+	 * * $groupDefinition['whatsThisHeader'] string i18n key for header of "What's
+	 * *  This" popup (optional).
+	 * * $groupDefinition['whatsThisBody'] string i18n key for body of "What's This"
+	 * *  popup (optional).
+	 * * $groupDefinition['whatsThisUrl'] string URL for main link of "What's This"
+	 * *  popup (optional).
+	 * * $groupDefinition['whatsThisLinkText'] string i18n key of text for main link of
+	 * *  "What's This" popup (optional).
 	 */
 	public function __construct( array $groupDefinition ) {
 		$groupDefinition['isFullCoverage'] = true;
diff --git a/includes/changes/ChangesListFilterGroup.php b/includes/changes/ChangesListFilterGroup.php
index 0cdc24a41f..71c474ac0f 100644
--- a/includes/changes/ChangesListFilterGroup.php
+++ b/includes/changes/ChangesListFilterGroup.php
@@ -142,6 +142,14 @@ abstract class ChangesListFilterGroup {
 	 * * $groupDefinition['isFullCoverage'] bool Whether the group is full coverage;
 	 * *  if true, this means that checking every item in the group means no
 	 * *  changes list entries are filtered out.
+	 * * $groupDefinition['whatsThisHeader'] string i18n key for header of "What's
+	 * *  This" popup (optional).
+	 * * $groupDefinition['whatsThisBody'] string i18n key for body of "What's This"
+	 * *  popup (optional).
+	 * * $groupDefinition['whatsThisUrl'] string URL for main link of "What's This"
+	 * *  popup (optional).
+	 * * $groupDefinition['whatsThisLinkText'] string i18n key of text for main link of
+	 * *  "What's This" popup (optional).
 	 */
 	public function __construct( array $groupDefinition ) {
 		if ( strpos( $groupDefinition['name'], self::RESERVED_NAME_CHAR ) !== false ) {
diff --git a/includes/changes/ChangesListStringOptionsFilterGroup.php b/includes/changes/ChangesListStringOptionsFilterGroup.php
index 723ef3986d..1abf637804 100644
--- a/includes/changes/ChangesListStringOptionsFilterGroup.php
+++ b/includes/changes/ChangesListStringOptionsFilterGroup.php
@@ -107,6 +107,14 @@ class ChangesListStringOptionsFilterGroup extends ChangesListFilterGroup {
 	 * *  array &$query_options Array of query options; see IDatabase::select $options
 	 * *  array &$join_conds Array of join conditions; see IDatabase::select $join_conds
 	 * *  array $selectedValues The allowed and requested values, lower-cased and sorted
+	 * * $groupDefinition['whatsThisHeader'] string i18n key for header of "What's
+	 * *  This" popup (optional).
+	 * * $groupDefinition['whatsThisBody'] string i18n key for body of "What's This"
+	 * *  popup (optional).
+	 * * $groupDefinition['whatsThisUrl'] string URL for main link of "What's This"
+	 * *  popup (optional).
+	 * * $groupDefinition['whatsThisLinkText'] string i18n key of text for main link of
+	 * *  "What's This" popup (optional).
 	 */
 	public function __construct( array $groupDefinition ) {
 		if ( !isset( $groupDefinition['isFullCoverage'] ) ) {