[MediaWiki-commits] [Gerrit] Cleanup some docs (includes/[s-z]) - change (mediawiki/core)
jenkins-bot has submitted this change and it was merged.
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(-)
Approvals:
Aaron Schulz: Looks good to me, approved
jenkins-bot: Verified
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
[MediaWiki-commits] [Gerrit] Cleanup some docs (includes/[s-z]) - change (mediawiki/core)
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
*/
