jenkins-bot has submitted this change and it was merged.
Change subject: Update/fix docs
......................................................................
Update/fix docs
Change-Id: Ifa3cfc6fe38ea45e70b50683c36e7cbf3bb4ef82
---
M includes/specials/SpecialAllmessages.php
M includes/specials/SpecialAllpages.php
M includes/specials/SpecialEmailuser.php
M includes/specials/SpecialExport.php
M includes/specials/SpecialLinkSearch.php
M includes/specials/SpecialProtectedpages.php
M includes/specials/SpecialProtectedtitles.php
M includes/specials/SpecialRecentchanges.php
M includes/specials/SpecialStatistics.php
M includes/specials/SpecialUnblock.php
M includes/specials/SpecialUploadStash.php
M includes/specials/SpecialUserrights.php
M includes/specials/SpecialWatchlist.php
M includes/specials/SpecialWhatlinkshere.php
14 files changed, 33 insertions(+), 8 deletions(-)
Approvals:
Krinkle: Looks good to me, approved
jenkins-bot: Verified
diff --git a/includes/specials/SpecialAllmessages.php
b/includes/specials/SpecialAllmessages.php
index 855d409..7f315de 100644
--- a/includes/specials/SpecialAllmessages.php
+++ b/includes/specials/SpecialAllmessages.php
@@ -285,6 +285,9 @@
/**
* This function normally does a database query to get the results; we
need
* to make a pretend result using a FakeResultWrapper.
+ * @param string $offset
+ * @param int $limit
+ * @param bool $descending
* @return FakeResultWrapper
*/
function reallyDoQuery( $offset, $limit, $descending ) {
diff --git a/includes/specials/SpecialAllpages.php
b/includes/specials/SpecialAllpages.php
index 942b767..7505df8 100644
--- a/includes/specials/SpecialAllpages.php
+++ b/includes/specials/SpecialAllpages.php
@@ -335,7 +335,7 @@
}
/**
- * @param $namespace Integer (Default NS_MAIN)
+ * @param int $namespace Namespace (Default NS_MAIN)
* @param string $from list all pages from this name (default FALSE)
* @param string $to list all pages to this name (default FALSE)
* @param bool $hideredirects dont show redirects (default FALSE)
diff --git a/includes/specials/SpecialEmailuser.php
b/includes/specials/SpecialEmailuser.php
index 163e5c6..3607be9 100644
--- a/includes/specials/SpecialEmailuser.php
+++ b/includes/specials/SpecialEmailuser.php
@@ -264,6 +264,8 @@
* getPermissionsError(). It is probably also a good
* idea to check the edit token and ping limiter in advance.
*
+ * @param array $data
+ * @param IContextSource $context
* @return Mixed: Status object, or potentially a String on error
* or maybe even true on success if anything uses the EmailUser hook.
*/
diff --git a/includes/specials/SpecialExport.php
b/includes/specials/SpecialExport.php
index ed3321e..ef86e8e 100644
--- a/includes/specials/SpecialExport.php
+++ b/includes/specials/SpecialExport.php
@@ -526,6 +526,11 @@
/**
* Expand a list of pages to include items used in those pages.
+ * @param array $inputPages Array of page titles
+ * @param array $pageSet
+ * @param string $table
+ * @param array $fields Array of field names
+ * @param array $join
* @return array
*/
private function getLinks( $inputPages, $pageSet, $table, $fields,
$join ) {
diff --git a/includes/specials/SpecialLinkSearch.php
b/includes/specials/SpecialLinkSearch.php
index 030416f..1bd33df 100644
--- a/includes/specials/SpecialLinkSearch.php
+++ b/includes/specials/SpecialLinkSearch.php
@@ -133,6 +133,8 @@
/**
* Return an appropriately formatted LIKE query and the clause
*
+ * @param string $query
+ * @param string $prot
* @return array
*/
static function mungeQuery( $query, $prot ) {
diff --git a/includes/specials/SpecialProtectedpages.php
b/includes/specials/SpecialProtectedpages.php
index bc4f3bb..eeb89f0 100644
--- a/includes/specials/SpecialProtectedpages.php
+++ b/includes/specials/SpecialProtectedpages.php
@@ -205,6 +205,7 @@
}
/**
+ * @param bool $indefOnly
* @return string Formatted HTML
*/
protected function getExpiryCheck( $indefOnly ) {
@@ -212,6 +213,7 @@
}
/**
+ * @param bool $cascadeOnly
* @return string Formatted HTML
*/
protected function getCascadeCheck( $cascadeOnly ) {
@@ -219,6 +221,8 @@
}
/**
+ * @param string $sizetype "min" or "max"
+ * @param mixed $size
* @return string Formatted HTML
*/
protected function getSizeLimit( $sizetype, $size ) {
diff --git a/includes/specials/SpecialProtectedtitles.php
b/includes/specials/SpecialProtectedtitles.php
index a9d9cff..2a867dc 100644
--- a/includes/specials/SpecialProtectedtitles.php
+++ b/includes/specials/SpecialProtectedtitles.php
@@ -69,6 +69,7 @@
/**
* Callback function to output a restriction
*
+ * @param Object $row Database row
* @return string
*/
function formatRow( $row ) {
@@ -156,6 +157,7 @@
}
/**
+ * @param string $pr_level Determines which option is selected as
default
* @return string Formatted HTML
* @private
*/
diff --git a/includes/specials/SpecialRecentchanges.php
b/includes/specials/SpecialRecentchanges.php
index 008678f..ae3ab24 100644
--- a/includes/specials/SpecialRecentchanges.php
+++ b/includes/specials/SpecialRecentchanges.php
@@ -183,7 +183,8 @@
/**
* Return an array with a ChangesFeed object and ChannelFeed object
*
- * @return Array
+ * @param string $feedFormat Feed's format (either 'rss' or 'atom')
+ * @return array
*/
public function getFeedObject( $feedFormat ) {
$changesFeed = new ChangesFeed( $feedFormat, 'rcfeed' );
diff --git a/includes/specials/SpecialStatistics.php
b/includes/specials/SpecialStatistics.php
index bc1b600..6b85db6 100644
--- a/includes/specials/SpecialStatistics.php
+++ b/includes/specials/SpecialStatistics.php
@@ -111,7 +111,7 @@
* @param $number Float: a statistical number
* @param $trExtraParams Array: params to table row, see Html::elememt
* @param $descMsg String: message key
- * @param $descMsgParam Array: message params
+ * @param array|string $descMsgParam Message parameters
* @return string table row in HTML format
*/
private function formatRow( $text, $number, $trExtraParams = array(),
$descMsg = '', $descMsgParam = '' ) {
diff --git a/includes/specials/SpecialUnblock.php
b/includes/specials/SpecialUnblock.php
index c4a53cf..7b3ae6b 100644
--- a/includes/specials/SpecialUnblock.php
+++ b/includes/specials/SpecialUnblock.php
@@ -138,6 +138,8 @@
/**
* Submit callback for an HTMLForm object
+ * @param array $data
+ * @param HTMLForm $form
* @return Array( Array(message key, parameters)
*/
public static function processUIUnblock( array $data, HTMLForm $form ) {
diff --git a/includes/specials/SpecialUploadStash.php
b/includes/specials/SpecialUploadStash.php
index ddf0c6d..a8e140d 100644
--- a/includes/specials/SpecialUploadStash.php
+++ b/includes/specials/SpecialUploadStash.php
@@ -311,6 +311,7 @@
* Note the stash has to be recreated since this is being called in a
static context.
* This works, because there really is only one stash per logged-in
user, despite appearances.
*
+ * @param array $formData
* @return Status
*/
public static function tryClearStashedUploads( $formData ) {
diff --git a/includes/specials/SpecialUserrights.php
b/includes/specials/SpecialUserrights.php
index d4baae2..336363d 100644
--- a/includes/specials/SpecialUserrights.php
+++ b/includes/specials/SpecialUserrights.php
@@ -283,6 +283,7 @@
* return a user (or proxy) object for manipulating it.
*
* Side effects: error output for invalid access
+ * @param string $username
* @return Status object
*/
public function fetchUser( $username ) {
diff --git a/includes/specials/SpecialWatchlist.php
b/includes/specials/SpecialWatchlist.php
index 543c91e..303df34 100644
--- a/includes/specials/SpecialWatchlist.php
+++ b/includes/specials/SpecialWatchlist.php
@@ -469,6 +469,8 @@
/**
* Returns html
*
+ * @param int $days This gets overwritten, so is not used
+ * @param array $options Query parameters for URL
* @return string
*/
protected function cutoffLinks( $days, $options = array() ) {
diff --git a/includes/specials/SpecialWhatlinkshere.php
b/includes/specials/SpecialWhatlinkshere.php
index 8841af8..57bb7d0 100644
--- a/includes/specials/SpecialWhatlinkshere.php
+++ b/includes/specials/SpecialWhatlinkshere.php
@@ -94,11 +94,11 @@
}
/**
- * @param int $level Recursion level
- * @param $target Title Target title
- * @param int $limit Number of entries to display
- * @param $from Title Display from this article ID
- * @param $back Title Display from this article ID at backwards
scrolling
+ * @param int $level Recursion level
+ * @param Title $target Target title
+ * @param int $limit Number of entries to display
+ * @param int $from Display from this article ID (default: 0)
+ * @param int $back Display from this article ID at backwards scrolling
(default: 0)
*/
function showIndirectLinks( $level, $target, $limit, $from = 0, $back =
0 ) {
global $wgMaxRedirectLinksRetrieved;
--
To view, visit https://gerrit.wikimedia.org/r/56944
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: Ifa3cfc6fe38ea45e70b50683c36e7cbf3bb4ef82
Gerrit-PatchSet: 5
Gerrit-Project: mediawiki/core
Gerrit-Branch: master
Gerrit-Owner: Siebrand <[email protected]>
Gerrit-Reviewer: Alex Monk <[email protected]>
Gerrit-Reviewer: Krinkle <[email protected]>
Gerrit-Reviewer: Nikerabbit <[email protected]>
Gerrit-Reviewer: Reedy <[email protected]>
Gerrit-Reviewer: Siebrand <[email protected]>
Gerrit-Reviewer: jenkins-bot
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
