jenkins-bot has submitted this change and it was merged. (
https://gerrit.wikimedia.org/r/402647 )
Change subject: Improve some parameter docs
......................................................................
Improve some parameter docs
Change-Id: Ic445760aa7afec15cf56222a7053c3f9de6f559d
---
M .phpcs.xml
M ApiQueryProofread.php
M ApiQueryProofreadInfo.php
M ProofreadPage.body.php
M includes/Index/CustomIndexFieldsParser.php
M includes/Index/DatabaseIndexContentLookup.php
M includes/Index/EditIndexPage.php
M includes/Index/IndexContent.php
M includes/Index/IndexContentHandler.php
M includes/Index/IndexContentLookup.php
M includes/Index/IndexDifferenceEngine.php
M includes/Index/IndexRedirectContent.php
M includes/Page/DatabaseIndexForPageLookup.php
M includes/Page/EditPagePage.php
M includes/Page/IndexForPageLookup.php
M includes/Page/PageContent.php
M includes/Page/PageContentHandler.php
M includes/Page/PageDifferenceEngine.php
M includes/Page/PageDisplayHandler.php
M includes/Pagination/FilePagination.php
M includes/Pagination/PagePagination.php
M includes/Pagination/Pagination.php
M includes/Parser/PagelistTagParser.php
M includes/Parser/PagequalityTagParser.php
M includes/Parser/PagesTagParser.php
M includes/Parser/TagParser.php
M maintenance/fixProofreadIndexPagesContentModel.php
M maintenance/fixProofreadPagePagesContentModel.php
M tests/phpunit/FileProviderMock.php
M tests/phpunit/Index/IndexContentLookupMock.php
M tests/phpunit/Page/IndexForPageLookupMock.php
31 files changed, 110 insertions(+), 104 deletions(-)
Approvals:
jenkins-bot: Verified
Tpt: Looks good to me, approved
diff --git a/.phpcs.xml b/.phpcs.xml
index 2855261..9b83b12 100644
--- a/.phpcs.xml
+++ b/.phpcs.xml
@@ -4,15 +4,10 @@
<exclude
name="MediaWiki.Commenting.FunctionComment.MissingDocumentationProtected" />
<exclude
name="MediaWiki.Commenting.FunctionComment.MissingDocumentationPublic" />
<exclude
name="MediaWiki.Commenting.FunctionComment.MissingParamComment" />
- <exclude
name="MediaWiki.Commenting.FunctionComment.MissingParamTag" />
- <exclude
name="MediaWiki.Commenting.FunctionComment.MissingReturn" />
<exclude
name="MediaWiki.ControlStructures.AssignmentInControlStructures.AssignmentInControlStructures"
/>
<exclude name="MediaWiki.Files.ClassMatchesFilename.NotMatch" />
<exclude
name="MediaWiki.VariableAnalysis.ForbiddenGlobalVariables.ForbiddenGlobal$wgTitle"
/>
<exclude
name="MediaWiki.WhiteSpace.SpaceBeforeSingleLineComment.NewLineComment"/>
- </rule>
- <rule ref="MediaWiki.Files.ClassMatchesFilename.WrongCase">
- <exclude-pattern>*/maintenance/*</exclude-pattern>
</rule>
<rule ref="MediaWiki.NamingConventions.ValidGlobalName">
<properties>
diff --git a/ApiQueryProofread.php b/ApiQueryProofread.php
index a2b0583..36893eb 100644
--- a/ApiQueryProofread.php
+++ b/ApiQueryProofread.php
@@ -114,7 +114,7 @@
}
/**
- * @see ApiBase::getExamplesMessages()
+ * @inheritDoc
*/
protected function getExamplesMessages() {
return [
diff --git a/ApiQueryProofreadInfo.php b/ApiQueryProofreadInfo.php
index a5c1fb2..18689a4 100644
--- a/ApiQueryProofreadInfo.php
+++ b/ApiQueryProofreadInfo.php
@@ -88,7 +88,7 @@
}
/**
- * @see ApiBase::getExamplesMessages()
+ * @inheritDoc
*/
protected function getExamplesMessages() {
return [
diff --git a/ProofreadPage.body.php b/ProofreadPage.body.php
index b50dea5..b467703 100644
--- a/ProofreadPage.body.php
+++ b/ProofreadPage.body.php
@@ -618,6 +618,8 @@
/**
* Adds canonical namespaces.
+ * @param array &$list
+ * @return true
*/
public static function addCanonicalNamespaces( &$list ) {
$list[self::getPageNamespaceId()] = 'Page';
@@ -661,6 +663,7 @@
* Add the links to previous, next, index page and scan image to Page:
pages.
* @param SkinTemplate &$skin
* @param array &$links Structured navigation links
+ * @return true
*/
public static function onSkinTemplateNavigation( SkinTemplate &$skin,
array &$links ) {
$title = $skin->getTitle();
@@ -751,6 +754,7 @@
* Add proofreading status to action=info
* @param IContextSource $context
* @param array &$pageInfo The page information
+ * @return true
*/
public static function onInfoAction( IContextSource $context, array
&$pageInfo ) {
if ( !$context->canUseWikiPage() ) {
diff --git a/includes/Index/CustomIndexFieldsParser.php
b/includes/Index/CustomIndexFieldsParser.php
index c7673b0..570e394 100644
--- a/includes/Index/CustomIndexFieldsParser.php
+++ b/includes/Index/CustomIndexFieldsParser.php
@@ -156,6 +156,7 @@
/**
* Return metadata from the index page that have to be given to header
template.
+ * @param IndexContent $content
* @return CustomIndexField[]
*/
public function parseCustomIndexFieldsForHeader( IndexContent $content
) {
@@ -172,6 +173,8 @@
/**
* Return the index entry with the same name or null if it's not found
* Note: the comparison is case insensitive
+ * @param IndexContent $content
+ * @param string $fieldName
* @return CustomIndexField
* @throws OutOfBoundsException
*/
diff --git a/includes/Index/DatabaseIndexContentLookup.php
b/includes/Index/DatabaseIndexContentLookup.php
index 36cd727..9827776 100644
--- a/includes/Index/DatabaseIndexContentLookup.php
+++ b/includes/Index/DatabaseIndexContentLookup.php
@@ -15,7 +15,7 @@
private $cache = [];
/**
- * @see IndexContentLookup::getIndexContentForTitle
+ * @inheritDoc
*/
public function getIndexContentForTitle( Title $indexTitle ) {
$cacheKey = $indexTitle->getDBkey();
diff --git a/includes/Index/EditIndexPage.php b/includes/Index/EditIndexPage.php
index f1e0008..14d620e 100644
--- a/includes/Index/EditIndexPage.php
+++ b/includes/Index/EditIndexPage.php
@@ -30,21 +30,21 @@
}
/**
- * @see EditPage::isSectionEditSupported
+ * @inheritDoc
*/
protected function isSectionEditSupported() {
return false; // sections and forms don't mix
}
/**
- * @see EditPage::isSupportedContentModel
+ * @inheritDoc
*/
public function isSupportedContentModel( $modelId ) {
return $modelId === CONTENT_MODEL_PROOFREAD_INDEX;
}
/**
- * @see EditPage::showContentForm
+ * @inheritDoc
*/
protected function showContentForm() {
$pageLang = $this->getTitle()->getPageLanguage();
@@ -138,7 +138,7 @@
}
/**
- * @see EditPage::importContentFormData
+ * @inheritDoc
*/
protected function importContentFormData( &$request ) {
if ( $this->textbox1 !== '' ) {
diff --git a/includes/Index/IndexContent.php b/includes/Index/IndexContent.php
index adae342..72f9e41 100644
--- a/includes/Index/IndexContent.php
+++ b/includes/Index/IndexContent.php
@@ -49,7 +49,7 @@
}
/**
- * @see Content:isEmpty
+ * @inheritDoc
*/
public function isEmpty() {
foreach ( $this->fields as $value ) {
@@ -62,7 +62,7 @@
}
/**
- * @see Content::equals
+ * @inheritDoc
*/
public function equals( Content $that = null ) {
if ( !( $that instanceof IndexContent ) || $that->getModel()
!== $this->getModel() ) {
@@ -89,28 +89,28 @@
}
/**
- * @see Content::getWikitextForTransclusion
+ * @inheritDoc
*/
public function getWikitextForTransclusion() {
return $this->serialize( CONTENT_FORMAT_WIKITEXT );
}
/**
- * @see Content::getNativeData
+ * @inheritDoc
*/
public function getNativeData() {
return $this->serialize();
}
/**
- * @see Content::getTextForSummary
+ * @inheritDoc
*/
public function getTextForSummary( $maxlength = 250 ) {
return '';
}
/**
- * @see Content::preSaveTransform
+ * @inheritDoc
*/
public function preSaveTransform( Title $title, User $user,
ParserOptions $popts ) {
$fields = [];
@@ -123,7 +123,7 @@
}
/**
- * @see Content::preloadTransform
+ * @inheritDoc
*/
public function preloadTransform( Title $title, ParserOptions $popts,
$params = [] ) {
$fields = [];
@@ -136,7 +136,7 @@
}
/**
- * @see Content::prepareSave
+ * @inheritDoc
*/
public function prepareSave( WikiPage $page, $flags, $parentRevId, User
$user ) {
if ( !$this->isValid() ) {
@@ -160,7 +160,7 @@
}
/**
- * @see Content::getSize
+ * @inheritDoc
*/
public function getSize() {
$size = 0;
@@ -173,7 +173,7 @@
}
/**
- * @see Content::isCountable
+ * @inheritDoc
*/
public function isCountable( $hasLinks = null, Title $title = null ) {
foreach ( $this->fields as $value ) {
@@ -186,7 +186,7 @@
}
/**
- * @see Content::matchMagicWord
+ * @inheritDoc
*/
public function matchMagicWord( MagicWord $word ) {
foreach ( $this->fields as $value ) {
@@ -199,7 +199,7 @@
}
/**
- * @see AbstractContent::fillParserOutput
+ * @inheritDoc
*/
protected function fillParserOutput( Title $title, $revId,
ParserOptions $options, $generateHtml, ParserOutput &$output
diff --git a/includes/Index/IndexContentHandler.php
b/includes/Index/IndexContentHandler.php
index c461c7e..c3184c8 100644
--- a/includes/Index/IndexContentHandler.php
+++ b/includes/Index/IndexContentHandler.php
@@ -54,7 +54,7 @@
}
/**
- * @see ContentHandler::canBeUsedOn
+ * @inheritDoc
*/
public function canBeUsedOn( Title $title ) {
return parent::canBeUsedOn( $title ) &&
@@ -62,7 +62,7 @@
}
/**
- * @see ContentHandler::serializeContent
+ * @inheritDoc
*/
public function serializeContent( Content $content, $format = null ) {
$this->checkFormat( $format );
@@ -91,7 +91,7 @@
}
/**
- * @see ContentHandler::unserializeContent
+ * @inheritDoc
*/
public function unserializeContent( $text, $format = null ) {
$this->checkFormat( $format );
@@ -127,7 +127,7 @@
}
/**
- * @see ContentHandler::getActionOverrides
+ * @inheritDoc
*/
public function getActionOverrides() {
return [
@@ -137,21 +137,21 @@
}
/**
- * @see ContentHandler::getDiffEngineClass
+ * @inheritDoc
*/
protected function getDiffEngineClass() {
return IndexDifferenceEngine::class;
}
/**
- * @see ContentHandler::makeEmptyContent
+ * @inheritDoc
*/
public function makeEmptyContent() {
return new IndexContent( [] );
}
/**
- * @see ContentHandler::merge3
+ * @inheritDoc
*/
public function merge3( Content $oldContent, Content $myContent,
Content $yourContent ) {
$this->checkModelID( $oldContent->getModel() );
@@ -190,21 +190,21 @@
}
/**
- * @see ContentHandler::makeRedirectContent
+ * @inheritDoc
*/
public function makeRedirectContent( Title $destination, $text = '' ) {
return new IndexRedirectContent( $destination );
}
/**
- * @see ContentHandler::supportsRedirects
+ * @inheritDoc
*/
public function supportsRedirects() {
return true;
}
/**
- * @see ContentHandler::isParserCacheSupported
+ * @inheritDoc
*/
public function isParserCacheSupported() {
return true;
diff --git a/includes/Index/IndexContentLookup.php
b/includes/Index/IndexContentLookup.php
index e644cb1..cff2990 100644
--- a/includes/Index/IndexContentLookup.php
+++ b/includes/Index/IndexContentLookup.php
@@ -13,6 +13,7 @@
/**
* Returns content of the page
+ * @param Title $indexTitle
* @return IndexContent
*/
public function getIndexContentForTitle( Title $indexTitle );
diff --git a/includes/Index/IndexDifferenceEngine.php
b/includes/Index/IndexDifferenceEngine.php
index ae4488d..68f81d6 100644
--- a/includes/Index/IndexDifferenceEngine.php
+++ b/includes/Index/IndexDifferenceEngine.php
@@ -25,7 +25,7 @@
private $customIndexFieldsParser;
/**
- * @see DifferenceEngine::__construct
+ * @inheritDoc
*/
public function __construct(
$context = null, $old = 0, $new = 0, $rcid = 0, $refreshCache =
false, $unhide = false,
@@ -39,7 +39,7 @@
}
/**
- * @see DifferenceEngine::generateContentDiffBody
+ * @inheritDoc
*/
public function generateContentDiffBody( Content $old, Content $new ) {
if ( $old instanceof IndexRedirectContent ) {
diff --git a/includes/Index/IndexRedirectContent.php
b/includes/Index/IndexRedirectContent.php
index b9060f6..5db7de4 100644
--- a/includes/Index/IndexRedirectContent.php
+++ b/includes/Index/IndexRedirectContent.php
@@ -38,21 +38,21 @@
}
/**
- * @see Content::isValid
+ * @inheritDoc
*/
public function isValid() {
return true;
}
/**
- * @see Content::getSize
+ * @inheritDoc
*/
public function getSize() {
return strlen( $this->redirectionTarget->getFullText() );
}
/**
- * @see Content::equals
+ * @inheritDoc
*/
public function equals( Content $that = null ) {
return $that instanceof IndexRedirectContent &&
@@ -60,14 +60,14 @@
}
/**
- * @see Content::getTextForSummary
+ * @inheritDoc
*/
public function getTextForSummary( $maxlength = 250 ) {
return '';
}
/**
- * @see Content::getRedirectTarget
+ * @inheritDoc
* @return Title
*/
public function getRedirectTarget() {
@@ -75,14 +75,14 @@
}
/**
- * @see Content::updateRedirect
+ * @inheritDoc
*/
public function updateRedirect( Title $target ) {
return new self( $target );
}
/**
- * @see AbstractContent::fillParserOutput
+ * @inheritDoc
*/
protected function fillParserOutput( Title $title, $revId,
ParserOptions $options, $generateHtml, ParserOutput &$output
diff --git a/includes/Page/DatabaseIndexForPageLookup.php
b/includes/Page/DatabaseIndexForPageLookup.php
index 3e0125b..e7e9a79 100644
--- a/includes/Page/DatabaseIndexForPageLookup.php
+++ b/includes/Page/DatabaseIndexForPageLookup.php
@@ -34,7 +34,7 @@
}
/**
- * @see IndexForPageLookup::getIndexForPageTitle
+ * @inheritDoc
*/
public function getIndexForPageTitle( Title $pageTitle ) {
$cacheKey = $pageTitle->getDBkey();
diff --git a/includes/Page/EditPagePage.php b/includes/Page/EditPagePage.php
index c8e3802..06af497 100644
--- a/includes/Page/EditPagePage.php
+++ b/includes/Page/EditPagePage.php
@@ -38,14 +38,14 @@
}
/**
- * @see EditPage::isSectionEditSupported
+ * @inheritDoc
*/
protected function isSectionEditSupported() {
return false; // sections and forms don't mix
}
/**
- * @see EditPage::isSupportedContentModel
+ * @inheritDoc
*/
public function isSupportedContentModel( $modelId ) {
return $modelId === CONTENT_MODEL_PROOFREAD_PAGE;
@@ -54,7 +54,7 @@
/**
* Load the content before edit
*
- * @see EditPage::showContentForm
+ * @inheritDoc
*/
protected function getContentObject( $defContent = null ) {
if ( !$this->mTitle->exists() ) {
@@ -64,7 +64,7 @@
}
/**
- * @see EditPage::showContentForm
+ * @inheritDoc
*/
protected function showContentForm() {
$out = $this->context->getOutput();
@@ -137,7 +137,7 @@
/**
* Sets the checkboxes for the proofreading status of the page.
*
- * @see EditPage::getCheckboxesWidget
+ * @inheritDoc
*/
public function getCheckboxesWidget( &$tabindex, $checked ) {
$checkboxes = parent::getCheckboxesWidget( $tabindex, $checked
);
@@ -192,7 +192,7 @@
}
/**
- * @see EditPage::importContentFormData
+ * @inheritDoc
*/
protected function importContentFormData( &$request ) {
/** @var PageContent $currentContent */
diff --git a/includes/Page/IndexForPageLookup.php
b/includes/Page/IndexForPageLookup.php
index 8f92da3..9a174da 100644
--- a/includes/Page/IndexForPageLookup.php
+++ b/includes/Page/IndexForPageLookup.php
@@ -13,6 +13,7 @@
/**
* Return index of the page
+ * @param Title $pageTitle
* @return Title|null
*/
public function getIndexForPageTitle( Title $pageTitle );
diff --git a/includes/Page/PageContent.php b/includes/Page/PageContent.php
index 01a85c0..fb804dd 100644
--- a/includes/Page/PageContent.php
+++ b/includes/Page/PageContent.php
@@ -93,7 +93,7 @@
}
/**
- * @see Content:isValid
+ * @inheritDoc
*/
public function isValid() {
return $this->header->isValid() &&
@@ -103,14 +103,14 @@
}
/**
- * @see Content:isEmpty
+ * @inheritDoc
*/
public function isEmpty() {
return $this->body->isEmpty();
}
/**
- * @see Content::equals
+ * @inheritDoc
*/
public function equals( Content $that = null ) {
if ( !( $that instanceof PageContent ) || $that->getModel() !==
$this->getModel() ) {
@@ -124,28 +124,28 @@
}
/**
- * @see Content::getWikitextForTransclusion
+ * @inheritDoc
*/
public function getWikitextForTransclusion() {
return $this->body->getWikitextForTransclusion();
}
/**
- * @see Content::getNativeData
+ * @inheritDoc
*/
public function getNativeData() {
return $this->serialize();
}
/**
- * @see Content::getTextForSummary
+ * @inheritDoc
*/
public function getTextForSummary( $maxlength = 250 ) {
return $this->body->getTextForSummary( $maxlength );
}
/**
- * @see Content::preSaveTransform
+ * @inheritDoc
*/
public function preSaveTransform( Title $title, User $user,
ParserOptions $popts ) {
return new self(
@@ -157,7 +157,7 @@
}
/**
- * @see Content::preloadTransform
+ * @inheritDoc
*/
public function preloadTransform( Title $title, ParserOptions $popts,
$params = [] ) {
return new self(
@@ -169,7 +169,7 @@
}
/**
- * @see Content::prepareSave
+ * @inheritDoc
*/
public function prepareSave( WikiPage $page, $flags, $parentRevId, User
$user ) {
if ( !$this->isValid() ) {
@@ -205,14 +205,14 @@
}
/**
- * @see Content::getRedirectTarget
+ * @inheritDoc
*/
public function getRedirectTarget() {
return $this->body->getRedirectTarget();
}
/**
- * @see Content::updateRedirect
+ * @inheritDoc
*/
public function updateRedirect( Title $target ) {
if ( !$this->isRedirect() ) {
@@ -228,7 +228,7 @@
}
/**
- * @see Content::getSize
+ * @inheritDoc
*/
public function getSize() {
return $this->header->getSize() +
@@ -237,7 +237,7 @@
}
/**
- * @see Content::isCountable
+ * @inheritDoc
*/
public function isCountable( $hasLinks = null, Title $title = null ) {
return $this->header->isCountable( $hasLinks, $title ) ||
@@ -246,7 +246,7 @@
}
/**
- * @see Content::matchMagicWord
+ * @inheritDoc
*/
public function matchMagicWord( MagicWord $word ) {
return $this->header->matchMagicWord( $word ) ||
@@ -255,7 +255,7 @@
}
/**
- * @see Content::getParserOutput
+ * @inheritDoc
*/
public function getParserOutput(
Title $title, $revId = null, ParserOptions $options = null,
$generateHtml = true
diff --git a/includes/Page/PageContentHandler.php
b/includes/Page/PageContentHandler.php
index 99b8b0b..43f4376 100644
--- a/includes/Page/PageContentHandler.php
+++ b/includes/Page/PageContentHandler.php
@@ -34,7 +34,7 @@
}
/**
- * @see ContentHandler::canBeUsedOn
+ * @inheritDoc
*/
public function canBeUsedOn( Title $title ) {
return parent::canBeUsedOn( $title ) &&
@@ -42,7 +42,7 @@
}
/**
- * @see ContentHandler::serializeContent
+ * @inheritDoc
*/
public function serializeContent( Content $content, $format = null ) {
$this->checkFormat( $format );
@@ -94,7 +94,7 @@
}
/**
- * @see ContentHandler::unserializeContent
+ * @inheritDoc
*/
public function unserializeContent( $text, $format = null ) {
if ( $format === null ) {
@@ -220,7 +220,7 @@
}
/**
- * @see ContentHandler::getActionOverrides
+ * @inheritDoc
*/
public function getActionOverrides() {
return [
@@ -231,14 +231,14 @@
}
/**
- * @see ContentHandler::getDiffEngineClass
+ * @inheritDoc
*/
protected function getDiffEngineClass() {
return PageDifferenceEngine::class;
}
/**
- * @see ContentHandler::makeEmptyContent
+ * @inheritDoc
*/
public function makeEmptyContent() {
return new PageContent(
@@ -250,7 +250,7 @@
}
/**
- * @see ContentHandler::merge3
+ * @inheritDoc
*/
public function merge3( Content $oldContent, Content $myContent,
Content $yourContent ) {
$this->checkModelID( $oldContent->getModel() );
@@ -288,7 +288,7 @@
}
/**
- * @see ContentHandler::getAutosummary
+ * @inheritDoc
*/
public function getAutosummary(
Content $oldContent = null, Content $newContent = null, $flags
= 0
@@ -307,7 +307,7 @@
}
/**
- * @see ContentHandler::makeRedirectContent
+ * @inheritDoc
* @todo is it the right content for redirects?
*/
public function makeRedirectContent( Title $destination, $text = '' ) {
@@ -320,14 +320,14 @@
}
/**
- * @see ContentHandler::supportsRedirects
+ * @inheritDoc
*/
public function supportsRedirects() {
return true;
}
/**
- * @see ContentHandler::isParserCacheSupported
+ * @inheritDoc
*/
public function isParserCacheSupported() {
return true;
diff --git a/includes/Page/PageDifferenceEngine.php
b/includes/Page/PageDifferenceEngine.php
index 2f9c77c..cc333a5 100644
--- a/includes/Page/PageDifferenceEngine.php
+++ b/includes/Page/PageDifferenceEngine.php
@@ -20,7 +20,7 @@
private $diffFormatterUtils;
/**
- * @see DifferenceEngine::__construct
+ * @inheritDoc
*/
public function __construct(
$context = null, $old = 0, $new = 0, $rcid = 0, $refreshCache =
false, $unhide = false
@@ -31,7 +31,7 @@
}
/**
- * @see DifferenceEngine::generateContentDiffBody
+ * @inheritDoc
*/
public function generateContentDiffBody( Content $old, Content $new ) {
if ( !( $old instanceof PageContent ) || !( $new instanceof
PageContent ) ) {
diff --git a/includes/Page/PageDisplayHandler.php
b/includes/Page/PageDisplayHandler.php
index 85ea436..be0336e 100644
--- a/includes/Page/PageDisplayHandler.php
+++ b/includes/Page/PageDisplayHandler.php
@@ -91,7 +91,8 @@
}
/**
- * Return the part of the page container that after page cnotent
+ * Return the part of the page container that after page content
+ * @param Title $pageTitle
* @return string
*/
public function buildPageContainerEnd( Title $pageTitle ) {
diff --git a/includes/Pagination/FilePagination.php
b/includes/Pagination/FilePagination.php
index 5eee3c8..df2251e 100644
--- a/includes/Pagination/FilePagination.php
+++ b/includes/Pagination/FilePagination.php
@@ -59,7 +59,7 @@
}
/**
- * @see ProofreadPagination::getPageNumber
+ * @inheritDoc
*/
public function getPageNumber( Title $pageTitle ) {
$indexTitle =
$this->context->getIndexForPageLookup()->getIndexForPageTitle( $pageTitle );
@@ -78,7 +78,7 @@
}
/**
- * @see ProofreadPagination::getDisplayedPageNumber
+ * @inheritDoc
*/
public function getDisplayedPageNumber( $pageNumber ) {
if ( !$this->pageNumberExists( $pageNumber ) ) {
@@ -90,14 +90,14 @@
}
/**
- * @see ProofreadPagination::getNumberOfPages
+ * @inheritDoc
*/
public function getNumberOfPages() {
return $this->numberOfPages;
}
/**
- * @see ProofreadPagination::getPageTitle
+ * @inheritDoc
*/
public function getPageTitle( $pageNumber ) {
if ( !$this->pageNumberExists( $pageNumber ) ) {
@@ -144,7 +144,7 @@
}
/**
- * @see ProofreadPagination::pageNumExists
+ * @inheritDoc
*/
protected function pageNumberExists( $pageNumber ) {
return 1 <= $pageNumber && $pageNumber <= $this->numberOfPages;
diff --git a/includes/Pagination/PagePagination.php
b/includes/Pagination/PagePagination.php
index b276ed2..209645d 100644
--- a/includes/Pagination/PagePagination.php
+++ b/includes/Pagination/PagePagination.php
@@ -39,7 +39,7 @@
}
/**
- * @see ProofreadPagination::getPageNumber
+ * @inheritDoc
*/
public function getPageNumber( Title $pageTitle ) {
foreach ( $this->pages as $i => $pageTitle2 ) {
@@ -51,7 +51,7 @@
}
/**
- * @see ProofreadPagination::getDisplayedPageNumber
+ * @inheritDoc
*/
public function getDisplayedPageNumber( $pageNumber ) {
if ( !$this->pageNumberExists( $pageNumber ) ) {
@@ -63,14 +63,14 @@
}
/**
- * @see ProofreadPagination::getNumberOfPages
+ * @inheritDoc
*/
public function getNumberOfPages() {
return count( $this->pages );
}
/**
- * @see ProofreadPagination::getPageTitle
+ * @inheritDoc
*/
public function getPageTitle( $pageNumber ) {
if ( !$this->pageNumberExists( $pageNumber ) ) {
@@ -82,7 +82,7 @@
}
/**
- * @see ProofreadPagination::pageNumExists
+ * @inheritDoc
*/
protected function pageNumberExists( $pageNumber ) {
return array_key_exists( $pageNumber - 1, $this->pages );
diff --git a/includes/Pagination/Pagination.php
b/includes/Pagination/Pagination.php
index f226c01..8c7ed45 100644
--- a/includes/Pagination/Pagination.php
+++ b/includes/Pagination/Pagination.php
@@ -61,28 +61,28 @@
abstract protected function pageNumberExists( $pageNumber );
/**
- * @see Iterator::rewind
+ * @inheritDoc
*/
public function rewind() {
$this->position = 1; // pages numbers starts with 1
}
/**
- * @see Iterator::key
+ * @inheritDoc
*/
public function key() {
return $this->position;
}
/**
- * @see Iterator::next
+ * @inheritDoc
*/
public function next() {
$this->position++;
}
/**
- * @see Iterator::current
+ * @inheritDoc
*
* @return Title
*/
@@ -91,7 +91,7 @@
}
/**
- * @see Iterator::valid
+ * @inheritDoc
*/
public function valid() {
return $this->pageNumberExists( $this->position );
diff --git a/includes/Parser/PagelistTagParser.php
b/includes/Parser/PagelistTagParser.php
index 999f7d4..4d7cd91 100644
--- a/includes/Parser/PagelistTagParser.php
+++ b/includes/Parser/PagelistTagParser.php
@@ -15,7 +15,7 @@
class PagelistTagParser extends TagParser {
/**
- * @see TagParser::render
+ * @inheritDoc
*/
public function render( $input, array $args ) {
$title = $this->parser->getTitle();
diff --git a/includes/Parser/PagequalityTagParser.php
b/includes/Parser/PagequalityTagParser.php
index 84b312c..71b1aff 100644
--- a/includes/Parser/PagequalityTagParser.php
+++ b/includes/Parser/PagequalityTagParser.php
@@ -12,7 +12,7 @@
class PagequalityTagParser extends TagParser {
/**
- * @see TagParser::render
+ * @inheritDoc
*/
public function render( $input, array $args ) {
if ( !array_key_exists( 'level', $args ) || !is_numeric(
$args['level'] ) ||
diff --git a/includes/Parser/PagesTagParser.php
b/includes/Parser/PagesTagParser.php
index 9232f96..751606d 100644
--- a/includes/Parser/PagesTagParser.php
+++ b/includes/Parser/PagesTagParser.php
@@ -16,7 +16,7 @@
class PagesTagParser extends TagParser {
/**
- * @see TagParser::render
+ * @inheritDoc
*/
public function render( $input, array $args ) {
// abort if this is nested <pages> call
diff --git a/includes/Parser/TagParser.php b/includes/Parser/TagParser.php
index e68821e..05f7111 100644
--- a/includes/Parser/TagParser.php
+++ b/includes/Parser/TagParser.php
@@ -24,6 +24,7 @@
/**
* @param Parser $parser the current parser
+ * @param Context $context
*/
public function __construct( Parser $parser, Context $context ) {
$this->parser = $parser;
diff --git a/maintenance/fixProofreadIndexPagesContentModel.php
b/maintenance/fixProofreadIndexPagesContentModel.php
index 68969d2..d596105 100644
--- a/maintenance/fixProofreadIndexPagesContentModel.php
+++ b/maintenance/fixProofreadIndexPagesContentModel.php
@@ -39,7 +39,7 @@
}
/**
- * @see LoggedUpdateMaintenance::doDBUpdates
+ * @inheritDoc
*/
public function doDBUpdates() {
$dbw = wfGetDB( DB_MASTER );
@@ -82,7 +82,7 @@
}
/**
- * @see LoggedUpdateMaintenance::getUpdateKey
+ * @inheritDoc
*/
public function getUpdateKey() {
return 'FixIndexPagesContentModel';
diff --git a/maintenance/fixProofreadPagePagesContentModel.php
b/maintenance/fixProofreadPagePagesContentModel.php
index 0c3d03c..f179ad9 100644
--- a/maintenance/fixProofreadPagePagesContentModel.php
+++ b/maintenance/fixProofreadPagePagesContentModel.php
@@ -38,7 +38,7 @@
}
/**
- * @see LoggedUpdateMaintenance::doDBUpdates
+ * @inheritDoc
*/
public function doDBUpdates() {
$db = wfGetDB( DB_MASTER );
@@ -65,7 +65,7 @@
}
/**
- * @see LoggedUpdateMaintenance::getUpdateKey
+ * @inheritDoc
*/
public function getUpdateKey() {
return 'FixPagePagesContentModel';
diff --git a/tests/phpunit/FileProviderMock.php
b/tests/phpunit/FileProviderMock.php
index 32d7734..cf8c896 100644
--- a/tests/phpunit/FileProviderMock.php
+++ b/tests/phpunit/FileProviderMock.php
@@ -27,7 +27,7 @@
}
/**
- * @see FileProvider::getFileFromTitle
+ * @inheritDoc
*/
public function getFileFromTitle( Title $title ) {
$key = $title->getDBkey();
diff --git a/tests/phpunit/Index/IndexContentLookupMock.php
b/tests/phpunit/Index/IndexContentLookupMock.php
index 0299cd7..c9daf27 100644
--- a/tests/phpunit/Index/IndexContentLookupMock.php
+++ b/tests/phpunit/Index/IndexContentLookupMock.php
@@ -16,7 +16,7 @@
}
/**
- * @see IndexContentLookup::getIndexContentForTitle
+ * @inheritDoc
*/
public function getIndexContentForTitle( Title $indexTitle ) {
if ( !array_key_exists( $indexTitle->getDBkey(),
$this->contentForIndex ) ) {
diff --git a/tests/phpunit/Page/IndexForPageLookupMock.php
b/tests/phpunit/Page/IndexForPageLookupMock.php
index 52f4241..b69f298 100644
--- a/tests/phpunit/Page/IndexForPageLookupMock.php
+++ b/tests/phpunit/Page/IndexForPageLookupMock.php
@@ -18,7 +18,7 @@
}
/**
- * @see IndexForPageLookup::getIndexForPageTitle
+ * @inheritDoc
*/
public function getIndexForPageTitle( Title $pageTitle ) {
if ( !array_key_exists( $pageTitle->getDBkey(),
$this->indexForPage ) ) {
--
To view, visit https://gerrit.wikimedia.org/r/402647
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: Ic445760aa7afec15cf56222a7053c3f9de6f559d
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/ProofreadPage
Gerrit-Branch: master
Gerrit-Owner: Umherirrender <umherirrender_de...@web.de>
Gerrit-Reviewer: Tpt <thoma...@hotmail.fr>
Gerrit-Reviewer: jenkins-bot <>
_______________________________________________
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
