[MediaWiki-commits] [Gerrit] More specific types in doc tags in the Html class - change (mediawiki/core)
Thiemo Mättig (WMDE) has uploaded a new change for review.
https://gerrit.wikimedia.org/r/199845
Change subject: More specific types in doc tags in the Html class
..
More specific types in doc tags in the Html class
This is a pure inline-documentation patch. It fixes a few actual
mistakes in documentation tags and makes some generic array types
more specific, if that's possible.
Change-Id: Id02e1e936624b845316b8ce99f8b8d2a1f829e97
---
M includes/Html.php
1 file changed, 9 insertions(+), 8 deletions(-)
git pull ssh://gerrit.wikimedia.org:29418/mediawiki/core
refs/changes/45/199845/1
diff --git a/includes/Html.php b/includes/Html.php
index ed77729..c172ae0 100644
--- a/includes/Html.php
+++ b/includes/Html.php
@@ -104,7 +104,8 @@
/**
* Modifies a set of attributes meant for button elements
* and apply a set of default attributes when
$wgUseMediaWikiUIEverywhere enabled.
-* @param array $modifiers to add to the button
+* @param array $attrs
+* @param string[] $modifiers to add to the button
* @see https://tools.wmflabs.org/styleguide/desktop/index.html for
guidance on available modifiers
* @return array $attrs A modified attribute array
*/
@@ -164,7 +165,7 @@
* @param array $attrs Associative array of attributes, e.g., array(
* 'href' = 'http://www.mediawiki.org/' ). See expandAttributes() for
* further documentation.
-* @param array $modifiers to add to the button
+* @param string[] $modifiers to add to the button
* @see http://tools.wmflabs.org/styleguide/desktop/index.html for
guidance on available modifiers
* @return string Raw HTML
*/
@@ -184,7 +185,7 @@
* @param array $attrs Associative array of attributes, e.g., array(
* 'href' = 'http://www.mediawiki.org/' ). See expandAttributes() for
* further documentation.
-* @param array $modifiers to add to the button
+* @param string[] $modifiers to add to the button
* @see http://tools.wmflabs.org/styleguide/desktop/index.html for
guidance on available modifiers
* @return string Raw HTML
*/
@@ -704,7 +705,7 @@
* new HTML5 input types and attributes.
*
* @param string $name Name attribute
-* @param array $value Value attribute
+* @param string $value Value attribute
* @param string $type Type attribute
* @param array $attribs Associative array of miscellaneous extra
* attributes, passed to Html::element()
@@ -726,7 +727,7 @@
* @param string $name Name attribute
* @param bool $checked Whether the checkbox is checked or not
* @param array $attribs Array of additional attributes
-* @return string
+* @return string Raw HTML
*/
public static function check( $name, $checked = false, array $attribs =
array() ) {
if ( isset( $attribs['value'] ) ) {
@@ -749,7 +750,7 @@
* @param string $name Name attribute
* @param bool $checked Whether the checkbox is checked or not
* @param array $attribs Array of additional attributes
-* @return string
+* @return string Raw HTML
*/
public static function radio( $name, $checked = false, array $attribs =
array() ) {
if ( isset( $attribs['value'] ) ) {
@@ -772,7 +773,7 @@
* @param string $label Contents of the label
* @param string $id ID of the element being labeled
* @param array $attribs Additional attributes
-* @return string
+* @return string Raw HTML
*/
public static function label( $label, $id, array $attribs = array() ) {
$attribs += array(
@@ -1025,7 +1026,7 @@
* to URLs. Note that srcset supports width and height values as well,
which
* are not used here.
*
-* @param array $urls
+* @param string[] $urls
* @return string
*/
static function srcSet( $urls ) {
--
To view, visit https://gerrit.wikimedia.org/r/199845
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: Id02e1e936624b845316b8ce99f8b8d2a1f829e97
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/core
Gerrit-Branch: master
Gerrit-Owner: Thiemo Mättig (WMDE) thiemo.maet...@wikimedia.de
___
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
[MediaWiki-commits] [Gerrit] More specific types in doc tags in the Html class - change (mediawiki/core)
jenkins-bot has submitted this change and it was merged.
Change subject: More specific types in doc tags in the Html class
..
More specific types in doc tags in the Html class
This is a pure inline-documentation patch. It fixes a few actual
mistakes in documentation tags and makes some generic array types
more specific, if that's possible.
Change-Id: Id02e1e936624b845316b8ce99f8b8d2a1f829e97
---
M includes/Html.php
1 file changed, 9 insertions(+), 8 deletions(-)
Approvals:
Hoo man: Looks good to me, approved
jenkins-bot: Verified
diff --git a/includes/Html.php b/includes/Html.php
index ed77729..c172ae0 100644
--- a/includes/Html.php
+++ b/includes/Html.php
@@ -104,7 +104,8 @@
/**
* Modifies a set of attributes meant for button elements
* and apply a set of default attributes when
$wgUseMediaWikiUIEverywhere enabled.
-* @param array $modifiers to add to the button
+* @param array $attrs
+* @param string[] $modifiers to add to the button
* @see https://tools.wmflabs.org/styleguide/desktop/index.html for
guidance on available modifiers
* @return array $attrs A modified attribute array
*/
@@ -164,7 +165,7 @@
* @param array $attrs Associative array of attributes, e.g., array(
* 'href' = 'http://www.mediawiki.org/' ). See expandAttributes() for
* further documentation.
-* @param array $modifiers to add to the button
+* @param string[] $modifiers to add to the button
* @see http://tools.wmflabs.org/styleguide/desktop/index.html for
guidance on available modifiers
* @return string Raw HTML
*/
@@ -184,7 +185,7 @@
* @param array $attrs Associative array of attributes, e.g., array(
* 'href' = 'http://www.mediawiki.org/' ). See expandAttributes() for
* further documentation.
-* @param array $modifiers to add to the button
+* @param string[] $modifiers to add to the button
* @see http://tools.wmflabs.org/styleguide/desktop/index.html for
guidance on available modifiers
* @return string Raw HTML
*/
@@ -704,7 +705,7 @@
* new HTML5 input types and attributes.
*
* @param string $name Name attribute
-* @param array $value Value attribute
+* @param string $value Value attribute
* @param string $type Type attribute
* @param array $attribs Associative array of miscellaneous extra
* attributes, passed to Html::element()
@@ -726,7 +727,7 @@
* @param string $name Name attribute
* @param bool $checked Whether the checkbox is checked or not
* @param array $attribs Array of additional attributes
-* @return string
+* @return string Raw HTML
*/
public static function check( $name, $checked = false, array $attribs =
array() ) {
if ( isset( $attribs['value'] ) ) {
@@ -749,7 +750,7 @@
* @param string $name Name attribute
* @param bool $checked Whether the checkbox is checked or not
* @param array $attribs Array of additional attributes
-* @return string
+* @return string Raw HTML
*/
public static function radio( $name, $checked = false, array $attribs =
array() ) {
if ( isset( $attribs['value'] ) ) {
@@ -772,7 +773,7 @@
* @param string $label Contents of the label
* @param string $id ID of the element being labeled
* @param array $attribs Additional attributes
-* @return string
+* @return string Raw HTML
*/
public static function label( $label, $id, array $attribs = array() ) {
$attribs += array(
@@ -1025,7 +1026,7 @@
* to URLs. Note that srcset supports width and height values as well,
which
* are not used here.
*
-* @param array $urls
+* @param string[] $urls
* @return string
*/
static function srcSet( $urls ) {
--
To view, visit https://gerrit.wikimedia.org/r/199845
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: Id02e1e936624b845316b8ce99f8b8d2a1f829e97
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/core
Gerrit-Branch: master
Gerrit-Owner: Thiemo Mättig (WMDE) thiemo.maet...@wikimedia.de
Gerrit-Reviewer: Daniel Friesen dan...@nadir-seen-fire.com
Gerrit-Reviewer: Hoo man h...@online.de
Gerrit-Reviewer: Jdlrobson jrob...@wikimedia.org
Gerrit-Reviewer: Jeroen De Dauw jeroended...@gmail.com
Gerrit-Reviewer: jenkins-bot
___
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
