jenkins-bot has submitted this change and it was merged. ( https://gerrit.wikimedia.org/r/337790 )
Change subject: Fix various incomplete/out of sync PHPDoc blocks in client/repo ...................................................................... Fix various incomplete/out of sync PHPDoc blocks in client/repo Change-Id: I6c03c67595fb0ddf4595224a55f7f33216b0b278 --- M client/includes/Specials/SpecialPagesWithBadges.php M client/includes/WikibaseClient.php M repo/includes/Api/SearchEntities.php M repo/includes/ChangeOp/NullChangeOp.php M repo/includes/Hooks/LinkBeginHookHandler.php M repo/includes/Specials/HTMLForm/HTMLAliasesField.php M repo/includes/Specials/HTMLForm/HTMLContentLanguageField.php M repo/includes/Specials/HTMLForm/HTMLItemReferenceField.php M repo/includes/Store/Sql/PropertyInfoTableBuilder.php M repo/includes/Store/Sql/SqlStore.php M repo/includes/WikibaseRepo.php 11 files changed, 38 insertions(+), 7 deletions(-) Approvals: Aleksey Bekh-Ivanov (WMDE): Looks good to me, approved jenkins-bot: Verified Thiemo Mättig (WMDE): Looks good to me, approved diff --git a/client/includes/Specials/SpecialPagesWithBadges.php b/client/includes/Specials/SpecialPagesWithBadges.php index b6722d6..beecd8e 100644 --- a/client/includes/Specials/SpecialPagesWithBadges.php +++ b/client/includes/Specials/SpecialPagesWithBadges.php @@ -43,7 +43,6 @@ /** * @see SpecialPage::__construct * - * @param string $name * @param LanguageFallbackLabelDescriptionLookupFactory $labelDescriptionLookupFactory * @param string[] $badgeIds * @param string $siteId @@ -53,12 +52,11 @@ array $badgeIds, $siteId ) { + parent::__construct( 'PagesWithBadges' ); + $this->labelDescriptionLookupFactory = $labelDescriptionLookupFactory; $this->badgeIds = $badgeIds; $this->siteId = $siteId; - - parent::__construct( 'PagesWithBadges' ); - } /** diff --git a/client/includes/WikibaseClient.php b/client/includes/WikibaseClient.php index 94df27a..9735971 100644 --- a/client/includes/WikibaseClient.php +++ b/client/includes/WikibaseClient.php @@ -626,6 +626,7 @@ } /** + * @throws MWException when called to early * @return Language */ public function getContentLanguage() { @@ -645,6 +646,7 @@ } /** + * @throws MWException when called to early * @return Language */ private function getUserLanguage() { diff --git a/repo/includes/Api/SearchEntities.php b/repo/includes/Api/SearchEntities.php index 33e7634..a676d06 100644 --- a/repo/includes/Api/SearchEntities.php +++ b/repo/includes/Api/SearchEntities.php @@ -45,6 +45,7 @@ /** * @param ApiMain $mainModule * @param string $moduleName + * @param EntitySearchHelper $entitySearchHelper * @param EntityTitleLookup $entityTitleLookup * @param ContentLanguages $termLanguages * @param string[] $entityTypes diff --git a/repo/includes/ChangeOp/NullChangeOp.php b/repo/includes/ChangeOp/NullChangeOp.php index 60fcf58..7d30f60 100644 --- a/repo/includes/ChangeOp/NullChangeOp.php +++ b/repo/includes/ChangeOp/NullChangeOp.php @@ -13,14 +13,21 @@ class NullChangeOp implements ChangeOp { /** - * @see ChangeOp::validate() + * @see ChangeOp::validate + * + * @param EntityDocument $entity Unused + * + * @return Result Always valid */ public function validate( EntityDocument $entity ) { return Result::newSuccess(); } /** - * @see ChangeOp::apply() + * @see ChangeOp::apply + * + * @param EntityDocument $entity Unused + * @param Summary|null $summary Unused */ public function apply( EntityDocument $entity, Summary $summary = null ) { // no op diff --git a/repo/includes/Hooks/LinkBeginHookHandler.php b/repo/includes/Hooks/LinkBeginHookHandler.php index d97f53a..e0934fa 100644 --- a/repo/includes/Hooks/LinkBeginHookHandler.php +++ b/repo/includes/Hooks/LinkBeginHookHandler.php @@ -118,6 +118,7 @@ * @param EntityNamespaceLookup $entityNamespaceLookup * @param LanguageFallbackChain $languageFallback * @param Language $pageLanguage + * @param LinkRenderer $linkRenderer * * @todo: Would be nicer to take a LabelDescriptionLookup instead of TermLookup + FallbackChain. */ diff --git a/repo/includes/Specials/HTMLForm/HTMLAliasesField.php b/repo/includes/Specials/HTMLForm/HTMLAliasesField.php index c35bc1e..9440a97 100644 --- a/repo/includes/Specials/HTMLForm/HTMLAliasesField.php +++ b/repo/includes/Specials/HTMLForm/HTMLAliasesField.php @@ -11,6 +11,7 @@ * @license GPL-2.0+ */ class HTMLAliasesField extends HTMLTextField { + const DELIMITER = '|'; /** @@ -55,6 +56,7 @@ /** * @param string $value * @param array $alldata + * * @return array */ public function filter( $value, $alldata ) { @@ -67,6 +69,7 @@ /** * @param array $value * @param array $alldata + * * @return bool|\Message|string */ public function validate( $value, $alldata ) { @@ -82,6 +85,7 @@ /** * @param array $value + * * @return \OOUI\ActionFieldLayout|\OOUI\FieldLayout */ public function getOOUI( $value ) { @@ -92,6 +96,7 @@ /** * @param array $value + * * @return string */ public function getTableRow( $value ) { @@ -102,6 +107,7 @@ /** * @param array $value + * * @return string */ public function getDiv( $value ) { @@ -112,6 +118,7 @@ /** * @param array $value + * * @return string */ public function getRaw( $value ) { @@ -122,6 +129,7 @@ /** * @param array $value + * * @return string */ public function getVForm( $value ) { @@ -132,6 +140,7 @@ /** * @param array $value + * * @return string */ public function getInline( $value ) { @@ -142,6 +151,7 @@ /** * @param array $value + * * @return string */ private function arrayToString( $value ) { diff --git a/repo/includes/Specials/HTMLForm/HTMLContentLanguageField.php b/repo/includes/Specials/HTMLForm/HTMLContentLanguageField.php index 28e5a05..737f397 100644 --- a/repo/includes/Specials/HTMLForm/HTMLContentLanguageField.php +++ b/repo/includes/Specials/HTMLForm/HTMLContentLanguageField.php @@ -55,6 +55,7 @@ /** * @param string[] $languageCodes * @param LanguageNameLookup $lookup + * * @return array For details see {@see \HTMLForm} "options" parameter description */ private function constructOptions( array $languageCodes, LanguageNameLookup $lookup ) { diff --git a/repo/includes/Specials/HTMLForm/HTMLItemReferenceField.php b/repo/includes/Specials/HTMLForm/HTMLItemReferenceField.php index 556f49e..36270f3 100644 --- a/repo/includes/Specials/HTMLForm/HTMLItemReferenceField.php +++ b/repo/includes/Specials/HTMLForm/HTMLItemReferenceField.php @@ -2,6 +2,7 @@ namespace Wikibase\Repo\Specials\HTMLForm; +use Message; use Wikibase\DataModel\Entity\ItemId; use Wikibase\DataModel\Services\Lookup\EntityLookup; use Wikibase\Repo\WikibaseRepo; @@ -12,6 +13,7 @@ * @license GPL-2.0+ */ class HTMLItemReferenceField extends \HTMLTextField { + /** * @var EntityLookup */ @@ -42,6 +44,11 @@ /** * @see \HTMLFormField::validate + * + * @param string $value + * @param array $alldata + * + * @return bool|string|Message */ public function validate( $value, $alldata ) { $required = isset( $this->mParams['required'] ) && $this->mParams['required'] !== false; diff --git a/repo/includes/Store/Sql/PropertyInfoTableBuilder.php b/repo/includes/Store/Sql/PropertyInfoTableBuilder.php index 4f34cce..82c8997 100644 --- a/repo/includes/Store/Sql/PropertyInfoTableBuilder.php +++ b/repo/includes/Store/Sql/PropertyInfoTableBuilder.php @@ -74,6 +74,7 @@ * @param PropertyInfoTable $propertyInfoTable * @param EntityLookup $entityLookup * @param PropertyInfoBuilder $propertyInfoBuilder + * @param EntityIdComposer $entityIdComposer */ public function __construct( PropertyInfoTable $propertyInfoTable, diff --git a/repo/includes/Store/Sql/SqlStore.php b/repo/includes/Store/Sql/SqlStore.php index ab91f6a..530079a 100644 --- a/repo/includes/Store/Sql/SqlStore.php +++ b/repo/includes/Store/Sql/SqlStore.php @@ -432,7 +432,8 @@ * Creates a strongly connected pair of EntityRevisionLookup services, the first being the * non-caching lookup, the second being the caching lookup. * - * @return [ EntityRevisionLookup, CachingEntityRevisionLookup ] + * @return EntityRevisionLookup[] A two-element array with a "raw", non-caching and a caching + * EntityRevisionLookup. */ private function newEntityRevisionLookup() { // NOTE: Keep cache key in sync with DirectSqlStore::newEntityRevisionLookup in WikibaseClient diff --git a/repo/includes/WikibaseRepo.php b/repo/includes/WikibaseRepo.php index ee8ce12..7786178 100644 --- a/repo/includes/WikibaseRepo.php +++ b/repo/includes/WikibaseRepo.php @@ -513,6 +513,7 @@ } /** + * @throws MWException when called to early * @return Language */ private function getContentLanguage() { @@ -532,6 +533,7 @@ } /** + * @throws MWException when called to early * @return Language */ public function getUserLanguage() { -- To view, visit https://gerrit.wikimedia.org/r/337790 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: merged Gerrit-Change-Id: I6c03c67595fb0ddf4595224a55f7f33216b0b278 Gerrit-PatchSet: 2 Gerrit-Project: mediawiki/extensions/Wikibase Gerrit-Branch: master Gerrit-Owner: Thiemo Mättig (WMDE) <thiemo.maet...@wikimedia.de> Gerrit-Reviewer: Aleksey Bekh-Ivanov (WMDE) <aleksey.bekh-iva...@wikimedia.de> Gerrit-Reviewer: Thiemo Mättig (WMDE) <thiemo.maet...@wikimedia.de> Gerrit-Reviewer: jenkins-bot <> _______________________________________________ MediaWiki-commits mailing list MediaWiki-commits@lists.wikimedia.org https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits