Umherirrender has uploaded a new change for review.
https://gerrit.wikimedia.org/r/149065
Change subject: Cleanup some docs (includes/[s-z])
......................................................................
Cleanup some docs (includes/[s-z])
- Swap "$variable type" to "type $variable"
- Added missing types
- Fixed spacing inside docs
- Makes beginning of @param/@return/@var/@throws in capital
- Changed some types to match the more common spelling
Change-Id: Ie419638e909a47aa72a274043604247830ee1a81
---
M includes/search/SearchHighlighter.php
M includes/search/SearchResult.php
M includes/site/SiteList.php
M includes/specialpage/SpecialPage.php
M includes/specials/SpecialAllPages.php
M includes/specials/SpecialBlock.php
M includes/specials/SpecialChangePassword.php
M includes/specials/SpecialEditWatchlist.php
M includes/specials/SpecialEmailuser.php
M includes/specials/SpecialExpandTemplates.php
M includes/specials/SpecialExport.php
M includes/specials/SpecialFileDuplicateSearch.php
M includes/specials/SpecialJavaScriptTest.php
M includes/specials/SpecialListgrouprights.php
M includes/specials/SpecialListusers.php
M includes/specials/SpecialLog.php
M includes/specials/SpecialMergeHistory.php
M includes/specials/SpecialMovepage.php
M includes/specials/SpecialMyLanguage.php
M includes/specials/SpecialPageLanguage.php
M includes/specials/SpecialPagesWithProp.php
M includes/specials/SpecialRandomInCategory.php
M includes/specials/SpecialRedirect.php
M includes/specials/SpecialSearch.php
M includes/specials/SpecialUpload.php
M includes/specials/SpecialUploadStash.php
M includes/specials/SpecialUserlogin.php
M includes/specials/SpecialUserrights.php
M includes/specials/SpecialVersion.php
M includes/specials/SpecialWatchlist.php
M includes/title/MediaWikiPageLinkRenderer.php
M includes/title/MediaWikiTitleCodec.php
M includes/title/PageLinkRenderer.php
M includes/title/TitleFormatter.php
M includes/title/TitleParser.php
M includes/upload/UploadBase.php
M includes/upload/UploadFromChunks.php
M includes/upload/UploadStash.php
M includes/utils/ArrayUtils.php
39 files changed, 77 insertions(+), 78 deletions(-)
git pull ssh://gerrit.wikimedia.org:29418/mediawiki/core
refs/changes/65/149065/1
diff --git a/includes/search/SearchHighlighter.php
b/includes/search/SearchHighlighter.php
index 7923699..57cdaf4 100644
--- a/includes/search/SearchHighlighter.php
+++ b/includes/search/SearchHighlighter.php
@@ -295,7 +295,7 @@
/**
* Split text into lines and add it to extracts array
*
- * @param array $extracts index -> $line
+ * @param array $extracts Index -> $line
* @param int $count
* @param string $text
*/
diff --git a/includes/search/SearchResult.php b/includes/search/SearchResult.php
index 56ae2ff..453211b 100644
--- a/includes/search/SearchResult.php
+++ b/includes/search/SearchResult.php
@@ -217,7 +217,7 @@
}
/**
- * @return string timestamp
+ * @return string Timestamp
*/
function getTimestamp() {
if ( $this->mRevision ) {
diff --git a/includes/site/SiteList.php b/includes/site/SiteList.php
index ecc38e2..2d9f22d 100644
--- a/includes/site/SiteList.php
+++ b/includes/site/SiteList.php
@@ -277,7 +277,7 @@
$group = new self();
/**
- * @var \Site $site
+ * @var Site $site
*/
foreach ( $this as $site ) {
if ( $site->getGroup() === $groupName ) {
diff --git a/includes/specialpage/SpecialPage.php
b/includes/specialpage/SpecialPage.php
index f968276..0070c74 100644
--- a/includes/specialpage/SpecialPage.php
+++ b/includes/specialpage/SpecialPage.php
@@ -101,8 +101,8 @@
* @param string $name Name of the special page, as seen in links and
URLs
* @param string $restriction User right required, e.g. "block" or
"delete"
* @param bool $listed Whether the page is listed in
Special:Specialpages
- * @param callable|bool $function unused
- * @param string $file unused
+ * @param callable|bool $function Unused
+ * @param string $file Unused
* @param bool $includable Whether the page can be included in normal
pages
*/
public function __construct(
@@ -134,7 +134,7 @@
// @todo FIXME: Decide which syntax to use for this, and stick to it
/**
* Whether this special page is listed in Special:SpecialPages
- * @since r3583 (v1.3)
+ * @since 1.3 (r3583)
* @return bool
*/
function isListed() {
@@ -328,7 +328,7 @@
* - `prefixSearchSubpages( "" )` should return `array( foo", "bar",
"baz" )`
*
* @param string $search Prefix to search for
- * @param integer $limit Maximum number of results to return
+ * @param int $limit Maximum number of results to return
* @return string[] Matching subpages
*/
public function prefixSearchSubpages( $search, $limit = 10 ) {
diff --git a/includes/specials/SpecialAllPages.php
b/includes/specials/SpecialAllPages.php
index e4b606d..04e2f11 100644
--- a/includes/specials/SpecialAllPages.php
+++ b/includes/specials/SpecialAllPages.php
@@ -45,7 +45,7 @@
/**
* Constructor
*
- * @param string $name name of the special page, as seen in links and
URLs (default: 'Allpages')
+ * @param string $name Name of the special page, as seen in links and
URLs (default: 'Allpages')
*/
function __construct( $name = 'Allpages' ) {
parent::__construct( $name );
@@ -54,7 +54,7 @@
/**
* Entry point : initialise variables and call subfunctions.
*
- * @param string $par becomes "FOO" when called like
Special:Allpages/FOO (default null)
+ * @param string $par Becomes "FOO" when called like
Special:Allpages/FOO (default null)
*/
function execute( $par ) {
$request = $this->getRequest();
diff --git a/includes/specials/SpecialBlock.php
b/includes/specials/SpecialBlock.php
index 8c46a93..f8b2e8d 100644
--- a/includes/specials/SpecialBlock.php
+++ b/includes/specials/SpecialBlock.php
@@ -28,7 +28,7 @@
* @ingroup SpecialPage
*/
class SpecialBlock extends FormSpecialPage {
- /** @var User user to be blocked, as passed either by parameter
(url?wpTarget=Foo)
+ /** @var User User to be blocked, as passed either by parameter
(url?wpTarget=Foo)
* or as subpage (Special:Block/Foo) */
protected $target;
@@ -454,7 +454,7 @@
/**
* Determine the target of the block, and the type of target
* @todo Should be in Block.php?
- * @param string $par subpage parameter passed to setup, or data value
from
+ * @param string $par Subpage parameter passed to setup, or data value
from
* the HTMLForm
* @param WebRequest $request Optionally try and get data from a
request too
* @return array( User|string|null, Block::TYPE_ constant|null )
diff --git a/includes/specials/SpecialChangePassword.php
b/includes/specials/SpecialChangePassword.php
index ba5c7ec..ad1d597 100644
--- a/includes/specials/SpecialChangePassword.php
+++ b/includes/specials/SpecialChangePassword.php
@@ -61,7 +61,7 @@
/**
* Set a message at the top of the Change Password form
* @since 1.23
- * @param Message $msg to parse and add to the form header
+ * @param Message $msg Message to parse and add to the form header
*/
public function setChangeMessage( Message $msg ) {
$this->mPreTextMessage = $msg;
@@ -230,7 +230,7 @@
}
/**
- * @throws PasswordError when cannot set the new password because
requirements not met.
+ * @throws PasswordError When cannot set the new password because
requirements not met.
*/
protected function attemptReset( $oldpass, $newpass, $retype ) {
global $wgPasswordAttemptThrottle;
diff --git a/includes/specials/SpecialEditWatchlist.php
b/includes/specials/SpecialEditWatchlist.php
index 355726a..0896929 100644
--- a/includes/specials/SpecialEditWatchlist.php
+++ b/includes/specials/SpecialEditWatchlist.php
@@ -121,7 +121,7 @@
* Return an array of subpages beginning with $search that this special
page will accept.
*
* @param string $search Prefix to search for
- * @param integer $limit Maximum number of results to return
+ * @param int $limit Maximum number of results to return
* @return string[] Matching subpages
*/
public function prefixSearchSubpages( $search, $limit = 10 ) {
@@ -763,8 +763,8 @@
* form is open (bug 32126), but we know that invalid items will
* be harmless so we can override it here.
*
- * @param string $value the value the field was submitted with
- * @param array $alldata the data collected from the form
+ * @param string $value The value the field was submitted with
+ * @param array $alldata The data collected from the form
* @return bool|string Bool true on success, or String error to display.
*/
function validate( $value, $alldata ) {
diff --git a/includes/specials/SpecialEmailuser.php
b/includes/specials/SpecialEmailuser.php
index 0062211..0958126 100644
--- a/includes/specials/SpecialEmailuser.php
+++ b/includes/specials/SpecialEmailuser.php
@@ -175,7 +175,7 @@
/**
* Validate target User
*
- * @param string $target target user name
+ * @param string $target Target user name
* @return User User object on success or a string on error
*/
public static function getTarget( $target ) {
diff --git a/includes/specials/SpecialExpandTemplates.php
b/includes/specials/SpecialExpandTemplates.php
index 35a3ba1..ecbd353 100644
--- a/includes/specials/SpecialExpandTemplates.php
+++ b/includes/specials/SpecialExpandTemplates.php
@@ -41,7 +41,7 @@
/** @var bool Whether or not to remove <nowiki> tags in the expanded
wikitext */
protected $removeNowiki;
- /** @var maximum size in bytes to include. 50MB allows fixing those
huge pages */
+ /** @var int Maximum size in bytes to include. 50MB allows fixing those
huge pages */
const MAX_INCLUDE_SIZE = 50000000;
function __construct() {
diff --git a/includes/specials/SpecialExport.php
b/includes/specials/SpecialExport.php
index bc8e728..2cf5bfe 100644
--- a/includes/specials/SpecialExport.php
+++ b/includes/specials/SpecialExport.php
@@ -302,7 +302,7 @@
/**
* Do the actual page exporting
*
- * @param string $page user input on what page(s) to export
+ * @param string $page User input on what page(s) to export
* @param int $history One of the WikiExporter history export constants
* @param bool $list_authors Whether to add distinct author list (when
* not returning full history)
@@ -536,7 +536,7 @@
* @param array $inputPages List of titles to look up
* @param array $pageSet Associative array indexed by titles for output
*
- * @return array associative array index by titles
+ * @return array Associative array index by titles
*/
private function getImages( $inputPages, $pageSet ) {
return $this->getLinks(
diff --git a/includes/specials/SpecialFileDuplicateSearch.php
b/includes/specials/SpecialFileDuplicateSearch.php
index b6c9d55..354960b 100644
--- a/includes/specials/SpecialFileDuplicateSearch.php
+++ b/includes/specials/SpecialFileDuplicateSearch.php
@@ -59,7 +59,7 @@
/**
* Fetch dupes from all connected file repositories.
*
- * @return array of File objects
+ * @return array Array of File objects
*/
function getDupes() {
return RepoGroup::singleton()->findBySha1( $this->hash );
@@ -67,7 +67,7 @@
/**
*
- * @param array $dupes of File objects
+ * @param array $dupes Array of File objects
*/
function showList( $dupes ) {
$html = array();
diff --git a/includes/specials/SpecialJavaScriptTest.php
b/includes/specials/SpecialJavaScriptTest.php
index 03b3688..a67d3c0 100644
--- a/includes/specials/SpecialJavaScriptTest.php
+++ b/includes/specials/SpecialJavaScriptTest.php
@@ -177,7 +177,7 @@
* Return an array of subpages beginning with $search that this special
page will accept.
*
* @param string $search Prefix to search for
- * @param integer $limit Maximum number of results to return
+ * @param int $limit Maximum number of results to return
* @return string[] Matching subpages
*/
public function prefixSearchSubpages( $search, $limit = 10 ) {
diff --git a/includes/specials/SpecialListgrouprights.php
b/includes/specials/SpecialListgrouprights.php
index a77b70c..582f743 100644
--- a/includes/specials/SpecialListgrouprights.php
+++ b/includes/specials/SpecialListgrouprights.php
@@ -217,12 +217,12 @@
/**
* Create a user-readable list of permissions from the given array.
*
- * @param array $permissions of permission => bool (from
$wgGroupPermissions items)
- * @param array $revoke of permission => bool (from
$wgRevokePermissions items)
- * @param array $add of groups this group is allowed to add or true
- * @param array $remove of groups this group is allowed to remove or
true
- * @param array $addSelf of groups this group is allowed to add to self
or true
- * @param array $removeSelf of group this group is allowed to remove
from self or true
+ * @param array $permissions Array of permission => bool (from
$wgGroupPermissions items)
+ * @param array $revoke Array of permission => bool (from
$wgRevokePermissions items)
+ * @param array $add Array of groups this group is allowed to add or
true
+ * @param array $remove Array of groups this group is allowed to remove
or true
+ * @param array $addSelf Array of groups this group is allowed to add
to self or true
+ * @param array $removeSelf Array of group this group is allowed to
remove from self or true
* @return string List of all granted permissions, separated by comma
separator
*/
private function formatPermissions( $permissions, $revoke, $add,
$remove, $addSelf, $removeSelf ) {
diff --git a/includes/specials/SpecialListusers.php
b/includes/specials/SpecialListusers.php
index 53dddc7..feeafbc 100644
--- a/includes/specials/SpecialListusers.php
+++ b/includes/specials/SpecialListusers.php
@@ -403,7 +403,7 @@
* Return an array of subpages beginning with $search that this special
page will accept.
*
* @param string $search Prefix to search for
- * @param integer $limit Maximum number of results to return
+ * @param int $limit Maximum number of results to return
* @return string[] Matching subpages
*/
public function prefixSearchSubpages( $search, $limit = 10 ) {
diff --git a/includes/specials/SpecialLog.php b/includes/specials/SpecialLog.php
index ced5d25..36abeb0 100644
--- a/includes/specials/SpecialLog.php
+++ b/includes/specials/SpecialLog.php
@@ -119,7 +119,7 @@
* Return an array of subpages beginning with $search that this special
page will accept.
*
* @param string $search Prefix to search for
- * @param integer $limit Maximum number of results to return
+ * @param int $limit Maximum number of results to return
* @return string[] Matching subpages
*/
public function prefixSearchSubpages( $search, $limit = 10 ) {
diff --git a/includes/specials/SpecialMergeHistory.php
b/includes/specials/SpecialMergeHistory.php
index a6c40d7..e1700de 100644
--- a/includes/specials/SpecialMergeHistory.php
+++ b/includes/specials/SpecialMergeHistory.php
@@ -335,7 +335,7 @@
* The user may have to "undo" the redirect manually to finish the
"unmerge".
* Maybe this should delete redirects at the target page of merges?
*
- * @return boolean Success
+ * @return bool Success
*/
function merge() {
# Get the titles directly from the IDs, in case the target page
params
diff --git a/includes/specials/SpecialMovepage.php
b/includes/specials/SpecialMovepage.php
index 7223efd..ee144d6 100644
--- a/includes/specials/SpecialMovepage.php
+++ b/includes/specials/SpecialMovepage.php
@@ -126,7 +126,7 @@
/**
* Show the form
*
- * @param array $err error messages. Each item is an error message.
+ * @param array $err Error messages. Each item is an error message.
* It may either be a string message name or array message name and
* parameters, like the second argument to OutputPage::wrapWikiMsg().
*/
diff --git a/includes/specials/SpecialMyLanguage.php
b/includes/specials/SpecialMyLanguage.php
index 01bf0ec..cef0411 100644
--- a/includes/specials/SpecialMyLanguage.php
+++ b/includes/specials/SpecialMyLanguage.php
@@ -59,7 +59,7 @@
* it returns Page/fi if it exists, otherwise Page/de if it exists,
* otherwise Page.
*
- * @param $par
+ * @param string $par
* @return Title|null
*/
public function findTitle( $par ) {
diff --git a/includes/specials/SpecialPageLanguage.php
b/includes/specials/SpecialPageLanguage.php
index 24eca07..75880d1 100644
--- a/includes/specials/SpecialPageLanguage.php
+++ b/includes/specials/SpecialPageLanguage.php
@@ -30,7 +30,7 @@
*/
class SpecialPageLanguage extends FormSpecialPage {
/**
- * @var $goToUrl URL to go to if language change successful
+ * @var string URL to go to if language change successful
*/
private $goToUrl;
diff --git a/includes/specials/SpecialPagesWithProp.php
b/includes/specials/SpecialPagesWithProp.php
index 05f0b2b..f5b19cc 100644
--- a/includes/specials/SpecialPagesWithProp.php
+++ b/includes/specials/SpecialPagesWithProp.php
@@ -82,7 +82,7 @@
* Return an array of subpages beginning with $search that this special
page will accept.
*
* @param string $search Prefix to search for
- * @param integer $limit Maximum number of results to return
+ * @param int $limit Maximum number of results to return
* @return string[] Matching subpages
*/
public function prefixSearchSubpages( $search, $limit = 10 ) {
diff --git a/includes/specials/SpecialRandomInCategory.php
b/includes/specials/SpecialRandomInCategory.php
index 2707916..8c01ef2 100644
--- a/includes/specials/SpecialRandomInCategory.php
+++ b/includes/specials/SpecialRandomInCategory.php
@@ -239,7 +239,7 @@
*
* @param Title $category
* @return array The lowest and highest timestamp
- * @throws MWException if category has no entries.
+ * @throws MWException If category has no entries.
*/
protected function getMinAndMaxForCat( Title $category ) {
$dbr = wfGetDB( DB_SLAVE );
diff --git a/includes/specials/SpecialRedirect.php
b/includes/specials/SpecialRedirect.php
index 4926d6d..774fd80 100644
--- a/includes/specials/SpecialRedirect.php
+++ b/includes/specials/SpecialRedirect.php
@@ -66,7 +66,7 @@
/**
* Handle Special:Redirect/user/xxxx (by redirecting to User:YYYY)
*
- * @return string|null url to redirect to, or null if $mValue is
invalid.
+ * @return string|null Url to redirect to, or null if $mValue is
invalid.
*/
function dispatchUser() {
if ( !ctype_digit( $this->mValue ) ) {
@@ -85,7 +85,7 @@
/**
* Handle Special:Redirect/file/xxxx
*
- * @return string|null url to redirect to, or null if $mValue is not
found.
+ * @return string|null Url to redirect to, or null if $mValue is not
found.
*/
function dispatchFile() {
$title = Title::makeTitleSafe( NS_FILE, $this->mValue );
@@ -121,7 +121,7 @@
* Handle Special:Redirect/revision/xxx
* (by redirecting to index.php?oldid=xxx)
*
- * @return string|null url to redirect to, or null if $mValue is
invalid.
+ * @return string|null Url to redirect to, or null if $mValue is
invalid.
*/
function dispatchRevision() {
$oldid = $this->mValue;
@@ -141,7 +141,7 @@
/**
* Handle Special:Redirect/page/xxx (by redirecting to
index.php?curid=xxx)
*
- * @return string|null url to redirect to, or null if $mValue is
invalid.
+ * @return string|null Url to redirect to, or null if $mValue is
invalid.
*/
function dispatchPage() {
$curid = $this->mValue;
@@ -164,7 +164,7 @@
* or do nothing (if $mValue wasn't set) allowing the form to be
* displayed.
*
- * @return bool true if a redirect was successfully handled.
+ * @return bool True if a redirect was successfully handled.
*/
function dispatch() {
// the various namespaces supported by Special:Redirect
diff --git a/includes/specials/SpecialSearch.php
b/includes/specials/SpecialSearch.php
index 15a7b59..541faa1 100644
--- a/includes/specials/SpecialSearch.php
+++ b/includes/specials/SpecialSearch.php
@@ -406,7 +406,7 @@
* @param Title $title
* @param int $num The number of search results found
* @param null|SearchResultSet $titleMatches Results from title search
- * @param null|SearchResultSet $textMatches Results from text search
+ * @param null|SearchResultSet $textMatches Results from text search
*/
protected function showCreateLink( $title, $num, $titleMatches,
$textMatches ) {
// show direct page/create link if applicable
@@ -798,7 +798,7 @@
* @param SearchResult $result
* @param string $lastInterwiki
* @param string $query
- * @param array $customCaptions iw prefix -> caption
+ * @param array $customCaptions Interwiki prefix -> caption
*
* @return string
*/
diff --git a/includes/specials/SpecialUpload.php
b/includes/specials/SpecialUpload.php
index fc18706..4fd7cd4 100644
--- a/includes/specials/SpecialUpload.php
+++ b/includes/specials/SpecialUpload.php
@@ -1144,7 +1144,7 @@
/**
* Empty function; submission is handled elsewhere.
*
- * @return bool false
+ * @return bool False
*/
function trySubmit() {
return false;
diff --git a/includes/specials/SpecialUploadStash.php
b/includes/specials/SpecialUploadStash.php
index 75ab19f..cb821cb 100644
--- a/includes/specials/SpecialUploadStash.php
+++ b/includes/specials/SpecialUploadStash.php
@@ -57,7 +57,7 @@
/**
* Execute page -- can output a file directly or show a listing of them.
*
- * @param string $subPage subpage, e.g. in
+ * @param string $subPage Subpage, e.g. in
* http://example.com/wiki/Special:UploadStash/foo.jpg, the "foo.jpg"
part
* @return bool Success
*/
@@ -75,7 +75,7 @@
* If file available in stash, cats it out to the client as a simple
HTTP response.
* n.b. Most sanity checking done in UploadStashLocalFile, so this is
straightforward.
*
- * @param string $key the key of a particular requested file
+ * @param string $key The key of a particular requested file
* @throws HttpError
* @return bool
*/
@@ -227,7 +227,7 @@
* @param array $params Scaling parameters ( e.g. array( width => '50'
) );
* @param int $flags Scaling flags ( see File:: constants )
* @throws MWException
- * @return bool success
+ * @return bool Success
*/
private function outputRemoteScaledThumb( $file, $params, $flags ) {
// This global probably looks something like
diff --git a/includes/specials/SpecialUserlogin.php
b/includes/specials/SpecialUserlogin.php
index 1ef96c3..0b11968 100644
--- a/includes/specials/SpecialUserlogin.php
+++ b/includes/specials/SpecialUserlogin.php
@@ -1048,7 +1048,7 @@
/**
* Display a "successful action" page.
*
- * @param string $type condition of return to; see `executeReturnTo`
+ * @param string $type Condition of return to; see `executeReturnTo`
* @param string|Message $title Page's title
* @param string $msgname
* @param string $injected_html
diff --git a/includes/specials/SpecialUserrights.php
b/includes/specials/SpecialUserrights.php
index 411970e..0ec85ba 100644
--- a/includes/specials/SpecialUserrights.php
+++ b/includes/specials/SpecialUserrights.php
@@ -715,7 +715,7 @@
/**
* Returns $this->getUser()->changeableGroups()
*
- * @return array array(
+ * @return array Array(
* 'add' => array( addablegroups ),
* 'remove' => array( removablegroups ),
* 'add-self' => array( addablegroups to self ),
diff --git a/includes/specials/SpecialVersion.php
b/includes/specials/SpecialVersion.php
index 28ad0f4..8ca9e23 100644
--- a/includes/specials/SpecialVersion.php
+++ b/includes/specials/SpecialVersion.php
@@ -307,7 +307,7 @@
}
/**
- * @return string wgVersion + a link to subversion revision of svn BASE
+ * @return string Global wgVersion + a link to subversion revision of
svn BASE
*/
private static function getVersionLinkedSvn() {
global $IP;
@@ -349,7 +349,7 @@
/**
* @since 1.22 Returns the HEAD date in addition to the sha1 and link
- * @return bool|string wgVersion + HEAD sha1 stripped to the first 7
chars
+ * @return bool|string Global wgVersion + HEAD sha1 stripped to the
first 7 chars
* with link and date, or false on failure
*/
private static function getVersionLinkedGit() {
diff --git a/includes/specials/SpecialWatchlist.php
b/includes/specials/SpecialWatchlist.php
index 94de5ce..e338295 100644
--- a/includes/specials/SpecialWatchlist.php
+++ b/includes/specials/SpecialWatchlist.php
@@ -83,7 +83,7 @@
* Return an array of subpages beginning with $search that this special
page will accept.
*
* @param string $search Prefix to search for
- * @param integer $limit Maximum number of results to return
+ * @param int $limit Maximum number of results to return
* @return string[] Matching subpages
*/
public function prefixSearchSubpages( $search, $limit = 10 ) {
diff --git a/includes/title/MediaWikiPageLinkRenderer.php
b/includes/title/MediaWikiPageLinkRenderer.php
index c593dca..f46cb5e 100644
--- a/includes/title/MediaWikiPageLinkRenderer.php
+++ b/includes/title/MediaWikiPageLinkRenderer.php
@@ -45,7 +45,7 @@
* HtmlPageLinkRenderer, we will be using them, so it seems prudent to
* already declare the dependency and inject them.
*
- * @param TitleFormatter $formatter formatter for generating the target
title string
+ * @param TitleFormatter $formatter Formatter for generating the target
title string
* @param string $baseUrl (currently unused, pending refactoring of
Linker).
* Defaults to $wgArticlePath.
*/
@@ -62,7 +62,7 @@
* Returns the (partial) URL for the given page (including any section
identifier).
*
* @param TitleValue $page The link's target
- * @param array $params any additional URL parameters.
+ * @param array $params Any additional URL parameters.
*
* @return string
*/
diff --git a/includes/title/MediaWikiTitleCodec.php
b/includes/title/MediaWikiTitleCodec.php
index 3a9ab40..12b7143 100644
--- a/includes/title/MediaWikiTitleCodec.php
+++ b/includes/title/MediaWikiTitleCodec.php
@@ -49,8 +49,8 @@
protected $localInterwikis;
/**
- * @param Language $language the language object to use for localizing
namespace names.
- * @param GenderCache $genderCache the gender cache for generating
gendered namespace names
+ * @param Language $language The language object to use for localizing
namespace names.
+ * @param GenderCache $genderCache The gender cache for generating
gendered namespace names
* @param string[]|string $localInterwikis
*/
public function __construct( Language $language, GenderCache
$genderCache,
@@ -67,7 +67,7 @@
* @param int $namespace
* @param string $text
*
- * @throws InvalidArgumentException if the namespace is invalid
+ * @throws InvalidArgumentException If the namespace is invalid
* @return string
*/
public function getNamespaceName( $namespace, $text ) {
@@ -97,7 +97,7 @@
* Underscores will be replaced.
* @param string $fragment The fragment name (may be empty).
*
- * @throws InvalidArgumentException if the namespace is invalid
+ * @throws InvalidArgumentException If the namespace is invalid
* @return string
*/
public function formatTitle( $namespace, $text, $fragment = '' ) {
diff --git a/includes/title/PageLinkRenderer.php
b/includes/title/PageLinkRenderer.php
index a277594..fb1096e 100644
--- a/includes/title/PageLinkRenderer.php
+++ b/includes/title/PageLinkRenderer.php
@@ -37,7 +37,7 @@
* @todo expand this to cover the functionality of Linker::linkUrl
*
* @param TitleValue $page The link's target
- * @param array $params any additional URL parameters.
+ * @param array $params Any additional URL parameters.
*
* @return string
*/
diff --git a/includes/title/TitleFormatter.php
b/includes/title/TitleFormatter.php
index cb28028..7c71ef5 100644
--- a/includes/title/TitleFormatter.php
+++ b/includes/title/TitleFormatter.php
@@ -50,7 +50,7 @@
*
* @note Only minimal normalization is applied. Consider using
TitleValue::getText() directly.
*
- * @param TitleValue $title the title to format
+ * @param TitleValue $title The title to format
*
* @return string
*/
@@ -59,7 +59,7 @@
/**
* Returns the title formatted for display, including the namespace
name.
*
- * @param TitleValue $title the title to format
+ * @param TitleValue $title The title to format
*
* @return string
*/
@@ -68,7 +68,7 @@
/**
* Returns the title formatted for display, with namespace and fragment.
*
- * @param TitleValue $title the title to format
+ * @param TitleValue $title The title to format
*
* @return string
*/
diff --git a/includes/title/TitleParser.php b/includes/title/TitleParser.php
index d548663..0635ee8 100644
--- a/includes/title/TitleParser.php
+++ b/includes/title/TitleParser.php
@@ -37,8 +37,8 @@
*
* @note this only parses local page links, interwiki-prefixes etc. are
not considered!
*
- * @param string $text the text to parse
- * @param int $defaultNamespace namespace to assume per default
(usually NS_MAIN)
+ * @param string $text The text to parse
+ * @param int $defaultNamespace Namespace to assume per default
(usually NS_MAIN)
*
* @throws MalformedTitleException If the text is not a valid
representation of a page title.
* @return TitleValue
diff --git a/includes/upload/UploadBase.php b/includes/upload/UploadBase.php
index 5defd45..24a93e4 100644
--- a/includes/upload/UploadBase.php
+++ b/includes/upload/UploadBase.php
@@ -283,7 +283,7 @@
/**
* Verify whether the upload is sane.
- * @return mixed self::OK or else an array with error information
+ * @return mixed Const self::OK or else an array with error information
*/
public function verifyUpload() {
wfProfileIn( __METHOD__ );
@@ -593,7 +593,7 @@
* isAllowed() should be called as well for generic is-user-blocked or
* can-user-upload checking.
*
- * @param User $user object to verify the permissions against
+ * @param User $user User object to verify the permissions against
* @return mixed An array as returned by getUserPermissionsErrors or
true
* in case the user has proper permissions.
*/
@@ -1276,8 +1276,8 @@
/**
* Callback to filter SVG Processing Instructions.
- * @param string $target processing instruction name
- * @param string $data processing instruction attribute and value
+ * @param string $target Processing instruction name
+ * @param string $data Processing instruction attribute and value
* @return bool (true if the filter identified something bad)
*/
public static function checkSvgPICallback( $target, $data ) {
diff --git a/includes/upload/UploadFromChunks.php
b/includes/upload/UploadFromChunks.php
index 6f90280..bea7128 100644
--- a/includes/upload/UploadFromChunks.php
+++ b/includes/upload/UploadFromChunks.php
@@ -68,7 +68,7 @@
* Calls the parent stashFile and updates the uploadsession table to
handle "chunks"
*
* @param User|null $user
- * @return UploadStashFile stashed file
+ * @return UploadStashFile Stashed file
*/
public function stashFile( User $user = null ) {
// Stash file is the called on creating a new chunk session:
@@ -201,9 +201,9 @@
/**
* Add a chunk to the temporary directory
*
- * @param string $chunkPath path to temporary chunk file
- * @param int $chunkSize size of the current chunk
- * @param int $offset offset of current chunk ( mutch match database
chunk offset )
+ * @param string $chunkPath Path to temporary chunk file
+ * @param int $chunkSize Size of the current chunk
+ * @param int $offset Offset of current chunk ( mutch match database
chunk offset )
* @return Status
*/
public function addChunk( $chunkPath, $chunkSize, $offset ) {
diff --git a/includes/upload/UploadStash.php b/includes/upload/UploadStash.php
index a7e7100..23a7a3a 100644
--- a/includes/upload/UploadStash.php
+++ b/includes/upload/UploadStash.php
@@ -167,7 +167,7 @@
/**
* Getter for file metadata.
*
- * @param string $key key under which file information is stored
+ * @param string $key Key under which file information is stored
* @return array
*/
public function getMetadata( $key ) {
@@ -179,7 +179,7 @@
/**
* Getter for fileProps
*
- * @param string $key key under which file information is stored
+ * @param string $key Key under which file information is stored
* @return array
*/
public function getFileProps( $key ) {
@@ -523,7 +523,7 @@
/**
* Helper function: Initialize the UploadStashFile for a given file.
*
- * @param string $key key under which to store the object
+ * @param string $key Key under which to store the object
* @throws UploadStashZeroLengthFileException
* @return bool
*/
diff --git a/includes/utils/ArrayUtils.php b/includes/utils/ArrayUtils.php
index b6df18b..1e521cb 100644
--- a/includes/utils/ArrayUtils.php
+++ b/includes/utils/ArrayUtils.php
@@ -151,8 +151,7 @@
* @since 1.23
*
* @param array $array1 The array to compare from
- * @param array $array2 An array to compare against
- * @param array ... More arrays to compare against
+ * @param array $array2,... More arrays to compare against
* @return array An array containing all the values from array1
* that are not present in any of the other arrays.
*/
--
To view, visit https://gerrit.wikimedia.org/r/149065
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: Ie419638e909a47aa72a274043604247830ee1a81
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/core
Gerrit-Branch: master
Gerrit-Owner: Umherirrender <umherirrender_de...@web.de>
_______________________________________________
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
