Hoo man has submitted this change and it was merged.
Change subject: Fix broken @see and @return tags in ApiWikibase modules
......................................................................
Fix broken @see and @return tags in ApiWikibase modules
This patch focuses on:
1. Doc of the ApiWikibase::getRequiredPermissions() method.
2. Docs in subclasses of ModifyEntity.
This is split from Ic506adc.
Change-Id: I42b0c8e8af71cdcffe782a86d9d2138a90d91df5
---
M repo/includes/api/ApiWikibase.php
M repo/includes/api/ModifyTerm.php
M repo/includes/api/SetAliases.php
M repo/includes/api/SetDescription.php
M repo/includes/api/SetLabel.php
M repo/includes/api/SetSiteLink.php
6 files changed, 13 insertions(+), 13 deletions(-)
Approvals:
Hoo man: Verified; Looks good to me, approved
diff --git a/repo/includes/api/ApiWikibase.php
b/repo/includes/api/ApiWikibase.php
index ed45145..c294d42 100644
--- a/repo/includes/api/ApiWikibase.php
+++ b/repo/includes/api/ApiWikibase.php
@@ -210,7 +210,7 @@
* @param Entity $entity The entity to check permissions for
* @param array $params Arguments for the module, describing the
operation to be performed
*
- * @return array A list of permissions
+ * @return string[] A list of permissions
*/
protected function getRequiredPermissions( Entity $entity, array
$params ) {
$permissions = array();
diff --git a/repo/includes/api/ModifyTerm.php b/repo/includes/api/ModifyTerm.php
index 5e21138..526ef62 100644
--- a/repo/includes/api/ModifyTerm.php
+++ b/repo/includes/api/ModifyTerm.php
@@ -45,13 +45,13 @@
}
/**
- * @see ModifyEntity::getRequiredPermissions()
+ * @see ApiWikibase::getRequiredPermissions
*
* @param Entity $entity
* @param array $params
*
- * @throws \InvalidArgumentException
- * @return array|Status
+ * @throws InvalidArgumentException
+ * @return string[]
*/
protected function getRequiredPermissions( Entity $entity, array
$params ) {
$permissions = parent::getRequiredPermissions( $entity, $params
);
diff --git a/repo/includes/api/SetAliases.php b/repo/includes/api/SetAliases.php
index c82908d..06c0ec5 100644
--- a/repo/includes/api/SetAliases.php
+++ b/repo/includes/api/SetAliases.php
@@ -47,13 +47,13 @@
}
/**
- * @see ModifyEntity::getRequiredPermissions()
+ * @see ApiWikibase::getRequiredPermissions
*
* @param Entity $entity
* @param array $params
*
- * @throws \InvalidArgumentException
- * @return array|Status
+ * @throws InvalidArgumentException
+ * @return string[]
*/
protected function getRequiredPermissions( Entity $entity, array
$params ) {
$permissions = parent::getRequiredPermissions( $entity, $params
);
@@ -69,7 +69,7 @@
}
/**
- * @see ModifyEntity::validateParameters()
+ * @see ModifyEntity::validateParameters
*/
protected function validateParameters( array $params ) {
parent::validateParameters( $params );
@@ -80,14 +80,14 @@
}
/**
- * @see ApiModifyEntity::createEntity()
+ * @see ModifyEntity::createEntity
*/
protected function createEntity( array $params ) {
$this->dieError( 'Could not find an existing entity' ,
'no-such-entity' );
}
/**
- * @see ModifyEntity::modifyEntity()
+ * @see ModifyEntity::modifyEntity
*/
protected function modifyEntity( Entity &$entity, array $params,
$baseRevId ) {
wfProfileIn( __METHOD__ );
diff --git a/repo/includes/api/SetDescription.php
b/repo/includes/api/SetDescription.php
index 117a5ad..4cd5101 100644
--- a/repo/includes/api/SetDescription.php
+++ b/repo/includes/api/SetDescription.php
@@ -39,7 +39,7 @@
}
/**
- * @see \Wikibase\Api\ModifyEntity::modifyEntity()
+ * @see ModifyEntity::modifyEntity
*/
protected function modifyEntity( Entity &$entity, array $params,
$baseRevId ) {
wfProfileIn( __METHOD__ );
diff --git a/repo/includes/api/SetLabel.php b/repo/includes/api/SetLabel.php
index 4625557..cf2f823 100644
--- a/repo/includes/api/SetLabel.php
+++ b/repo/includes/api/SetLabel.php
@@ -39,7 +39,7 @@
}
/**
- * @see \Wikibase\Api\ModifyEntity::modifyEntity()
+ * @see ModifyEntity::modifyEntity
*/
protected function modifyEntity( Entity &$entity, array $params,
$baseRevId ) {
wfProfileIn( __METHOD__ );
diff --git a/repo/includes/api/SetSiteLink.php
b/repo/includes/api/SetSiteLink.php
index f4bebd4..eaf1781 100644
--- a/repo/includes/api/SetSiteLink.php
+++ b/repo/includes/api/SetSiteLink.php
@@ -73,7 +73,7 @@
}
/**
- * @see ApiModifyEntity::modifyEntity()
+ * @see ModifyEntity::modifyEntity
*/
protected function modifyEntity( Entity &$entity, array $params,
$baseRevId ) {
wfProfileIn( __METHOD__ );
--
To view, visit https://gerrit.wikimedia.org/r/189924
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: I42b0c8e8af71cdcffe782a86d9d2138a90d91df5
Gerrit-PatchSet: 3
Gerrit-Project: mediawiki/extensions/Wikibase
Gerrit-Branch: master
Gerrit-Owner: Thiemo Mättig (WMDE) <[email protected]>
Gerrit-Reviewer: Hoo man <[email protected]>
Gerrit-Reviewer: JanZerebecki <[email protected]>
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
