Ricordisamoa has uploaded a new change for review.
https://gerrit.wikimedia.org/r/286269
Change subject: Standardize Doxygen @param tags
......................................................................
Standardize Doxygen @param tags
Use "@param datatype $paramname description" format.
Change-Id: If52c7f971575584028f5192a1fa87b0fda434ff0
---
M client/WikibaseClient.hooks.php
M lib/includes/LanguageWithConversion.php
M repo/Wikibase.hooks.php
M repo/includes/Actions/EditEntityAction.php
M repo/includes/Api/ApiErrorReporter.php
M repo/includes/Api/ModifyEntity.php
M repo/includes/Api/ResultBuilder.php
M repo/includes/Content/EntityHandler.php
M repo/includes/Diff/EntityContentDiffView.php
M repo/includes/Specials/SpecialSetSiteLink.php
M repo/tests/phpunit/includes/Api/EntityTestHelper.php
M repo/tests/phpunit/includes/Api/IndependentWikibaseApiTestCase.php
M view/src/EntityTermsView.php
M view/src/Template/TemplateFactory.php
14 files changed, 30 insertions(+), 30 deletions(-)
git pull ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/Wikibase
refs/changes/69/286269/1
diff --git a/client/WikibaseClient.hooks.php b/client/WikibaseClient.hooks.php
index 2705020..bd2faa2 100644
--- a/client/WikibaseClient.hooks.php
+++ b/client/WikibaseClient.hooks.php
@@ -347,7 +347,7 @@
/**
* Register the parser functions.
*
- * @param $parser Parser
+ * @param Parser $parser
*
* @return bool
*/
diff --git a/lib/includes/LanguageWithConversion.php
b/lib/includes/LanguageWithConversion.php
index 6f66ed4..1c59a4f 100644
--- a/lib/includes/LanguageWithConversion.php
+++ b/lib/includes/LanguageWithConversion.php
@@ -240,7 +240,7 @@
*
* Does nothing if this is not a converted language.
*
- * @param $text String
+ * @param string $text
*/
private function prepareForTranslate( $text ) {
if ( $this->parentLanguage ) {
diff --git a/repo/Wikibase.hooks.php b/repo/Wikibase.hooks.php
index 25ade02..0788182 100644
--- a/repo/Wikibase.hooks.php
+++ b/repo/Wikibase.hooks.php
@@ -303,7 +303,7 @@
*
* @todo: find a better way to do this!
*
- * @param $recentChange RecentChange
+ * @param RecentChange $recentChange
* @return bool
*/
public static function onRecentChangeSave( RecentChange $recentChange )
{
diff --git a/repo/includes/Actions/EditEntityAction.php
b/repo/includes/Actions/EditEntityAction.php
index 75a3b8c..ddf01da 100644
--- a/repo/includes/Actions/EditEntityAction.php
+++ b/repo/includes/Actions/EditEntityAction.php
@@ -434,8 +434,8 @@
/**
* Generate standard summary input and label (wgSummary), compatible to
EditPage.
*
- * @param $summary string The value of the summary input
- * @param $labelText string The html to place inside the label
+ * @param string $summary The value of the summary input
+ * @param string $labelText The html to place inside the label
*
* @return array An array in the format array( $label, $input )
*/
diff --git a/repo/includes/Api/ApiErrorReporter.php
b/repo/includes/Api/ApiErrorReporter.php
index 11f4ce3..8db020d 100644
--- a/repo/includes/Api/ApiErrorReporter.php
+++ b/repo/includes/Api/ApiErrorReporter.php
@@ -340,7 +340,7 @@
* This provides support for message lists coming from
Status::getErrorsByType() as well as
* Title::getUserPermissionsErrors() etc.
*
- * @param $messageSpecs array a list of errors, as returned by
Status::getErrorsByType()
+ * @param array $messageSpecs a list of errors, as returned by
Status::getErrorsByType()
* or Title::getUserPermissionsErrors()
*
* @return array a result structure containing the messages from
$errors as well as what
@@ -383,7 +383,7 @@
*
* @see convertToMessage()
*
- * @param $messageSpecs array a list of errors, as returned by
Status::getErrorsByType()
+ * @param array $messageSpecs a list of errors, as returned by
Status::getErrorsByType()
* or Title::getUserPermissionsErrors().
*
* @return array a result structure containing the messages from
$errors as well as what
diff --git a/repo/includes/Api/ModifyEntity.php
b/repo/includes/Api/ModifyEntity.php
index 376fd40..f93d709 100644
--- a/repo/includes/Api/ModifyEntity.php
+++ b/repo/includes/Api/ModifyEntity.php
@@ -464,8 +464,8 @@
/**
* Check the rights for the user accessing the module.
*
- * @param $entity EntityDocument the entity to check
- * @param $user User doing the action
+ * @param EntityDocument $entity the entity to check
+ * @param User $user User doing the action
*
* @return Status the check's result
*/
diff --git a/repo/includes/Api/ResultBuilder.php
b/repo/includes/Api/ResultBuilder.php
index 8db5cfe..f25712b 100644
--- a/repo/includes/Api/ResultBuilder.php
+++ b/repo/includes/Api/ResultBuilder.php
@@ -118,7 +118,7 @@
/**
* @since 0.5
*
- * @param $success bool|int|null
+ * @param bool|int|null $success
*/
public function markSuccess( $success = true ) {
$value = (int)$success;
@@ -145,9 +145,9 @@
*
* @since 0.5
*
- * @param $path array|string|null
- * @param $name string
- * @param $values array
+ * @param array|string|null $path
+ * @param string $name
+ * @param array $values
* @param string $tag tag name to use for elements of $values if not
already present
*/
public function setList( $path, $name, array $values, $tag ) {
@@ -178,9 +178,9 @@
*
* @since 0.5
*
- * @param $path array|string|null
- * @param $name string
- * @param $value mixed
+ * @param array|string|null $path
+ * @param string $name
+ * @param mixed $value
*/
public function setValue( $path, $name, $value ) {
$this->checkPathType( $path );
@@ -204,10 +204,10 @@
*
* @since 0.5
*
- * @param $path array|string|null
- * @param $key int|string|null the key to use when appending, or null
for automatic.
+ * @param array|string|null $path
+ * @param int|string|null $key the key to use when appending, or null
for automatic.
* May be ignored even if given, based on $this->addMetaData.
- * @param $value mixed
+ * @param mixed $value
* @param string $tag tag name to use for $value in indexed mode
*/
public function appendValue( $path, $key, $value, $tag ) {
@@ -234,7 +234,7 @@
}
/**
- * @param $key int|string|null the key to use when appending, or null
for automatic.
+ * @param int|string|null $key the key to use when appending, or null
for automatic.
*/
private function checkKeyType( $key ) {
Assert::parameter(
diff --git a/repo/includes/Content/EntityHandler.php
b/repo/includes/Content/EntityHandler.php
index 024fdf9..bc37db8 100644
--- a/repo/includes/Content/EntityHandler.php
+++ b/repo/includes/Content/EntityHandler.php
@@ -556,9 +556,9 @@
*
* @since 0.4
*
- * @param $latestRevision Revision The current text
- * @param $newerRevision Revision The revision to undo
- * @param $olderRevision Revision Must be an earlier revision than $undo
+ * @param Revision $latestRevision The current text
+ * @param Revision $newerRevision The revision to undo
+ * @param Revision $olderRevision Must be an earlier revision than $undo
*
* @return Content|bool Content on success, false on failure
*/
diff --git a/repo/includes/Diff/EntityContentDiffView.php
b/repo/includes/Diff/EntityContentDiffView.php
index a6a56eb..e6e7420 100644
--- a/repo/includes/Diff/EntityContentDiffView.php
+++ b/repo/includes/Diff/EntityContentDiffView.php
@@ -127,7 +127,7 @@
/**
* Get a header for a specified revision.
*
- * @param $rev Revision
+ * @param Revision $rev
* @param string $complete 'complete' to get the header wrapped
depending
* the visibility of the revision and a link to edit the page.
*
diff --git a/repo/includes/Specials/SpecialSetSiteLink.php
b/repo/includes/Specials/SpecialSetSiteLink.php
index cd1f02c..82df22d 100644
--- a/repo/includes/Specials/SpecialSetSiteLink.php
+++ b/repo/includes/Specials/SpecialSetSiteLink.php
@@ -194,7 +194,7 @@
/**
* Checks if the site id is valid.
*
- * @param $siteId string the site id
+ * @param string $siteId the site id
*
* @return bool
*/
diff --git a/repo/tests/phpunit/includes/Api/EntityTestHelper.php
b/repo/tests/phpunit/includes/Api/EntityTestHelper.php
index 2b01d80..0e0242b 100644
--- a/repo/tests/phpunit/includes/Api/EntityTestHelper.php
+++ b/repo/tests/phpunit/includes/Api/EntityTestHelper.php
@@ -392,7 +392,7 @@
}
/**
- * @param $id string of entityid
+ * @param string $id string of entityid
* @return null|string id of current handle (if active)
*/
public static function getHandle( $id ) {
diff --git a/repo/tests/phpunit/includes/Api/IndependentWikibaseApiTestCase.php
b/repo/tests/phpunit/includes/Api/IndependentWikibaseApiTestCase.php
index 964dea5..6bd5df8 100644
--- a/repo/tests/phpunit/includes/Api/IndependentWikibaseApiTestCase.php
+++ b/repo/tests/phpunit/includes/Api/IndependentWikibaseApiTestCase.php
@@ -66,8 +66,8 @@
* @since 0.5
*
* Do the test for exceptions from Api queries.
- * @param $params array of params for the api query
- * @param $exception array details of the exception to expect
(type,code,message)
+ * @param array $params array of params for the api query
+ * @param array $exception details of the exception to expect
(type,code,message)
*/
public function doTestQueryExceptions( $params, $exception ) {
try {
diff --git a/view/src/EntityTermsView.php b/view/src/EntityTermsView.php
index 372a3e4..2fd21f6 100644
--- a/view/src/EntityTermsView.php
+++ b/view/src/EntityTermsView.php
@@ -163,7 +163,7 @@
}
/**
- * @param $languageCode The language for which terms should be edited
+ * @param string $languageCode The language for which terms should be
edited
* @param EntityId|null $entityId
*
* @return string HTML
diff --git a/view/src/Template/TemplateFactory.php
b/view/src/Template/TemplateFactory.php
index c9c0bb1..389fd44 100644
--- a/view/src/Template/TemplateFactory.php
+++ b/view/src/Template/TemplateFactory.php
@@ -63,7 +63,7 @@
*
* @since 0.2
*
- * @param $key string template key
+ * @param string $key template key
* Varargs: normal template parameters
*
* @return string
--
To view, visit https://gerrit.wikimedia.org/r/286269
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: If52c7f971575584028f5192a1fa87b0fda434ff0
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/Wikibase
Gerrit-Branch: master
Gerrit-Owner: Ricordisamoa <[email protected]>
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
