jenkins-bot has submitted this change and it was merged.

Change subject: Simplify @see ApiBase::getExamplesMessages tags
......................................................................


Simplify @see ApiBase::getExamplesMessages tags

The fact that this returns an array is not worth much. That's what
the @see is for. Making this type more specific is not possible,
because the array values can be strings, arrays and/or Message objects.

Change-Id: Icd90c6ad715acafe7af70bc9d0a8ea485fdbaded
---
M client/includes/api/PageTerms.php
M repo/includes/api/AvailableBadges.php
M repo/includes/api/CreateClaim.php
M repo/includes/api/CreateRedirectModule.php
M repo/includes/api/EditEntity.php
M repo/includes/api/FormatSnakValue.php
M repo/includes/api/GetClaims.php
M repo/includes/api/GetEntities.php
M repo/includes/api/LinkTitles.php
M repo/includes/api/MergeItems.php
M repo/includes/api/ParseValue.php
M repo/includes/api/RemoveClaims.php
M repo/includes/api/RemoveQualifiers.php
M repo/includes/api/RemoveReferences.php
M repo/includes/api/SearchEntities.php
M repo/includes/api/SetAliases.php
M repo/includes/api/SetClaim.php
M repo/includes/api/SetClaimValue.php
M repo/includes/api/SetDescription.php
M repo/includes/api/SetLabel.php
M repo/includes/api/SetQualifier.php
M repo/includes/api/SetReference.php
M repo/includes/api/SetSiteLink.php
23 files changed, 29 insertions(+), 66 deletions(-)

Approvals:
  Aude: Looks good to me, approved
  jenkins-bot: Verified



diff --git a/client/includes/api/PageTerms.php 
b/client/includes/api/PageTerms.php
index 2b8842d..d8f7c5b 100644
--- a/client/includes/api/PageTerms.php
+++ b/client/includes/api/PageTerms.php
@@ -245,6 +245,9 @@
                );
        }
 
+       /**
+        * @see ApiBase::getExamplesMessages
+        */
        protected function getExamplesMessages() {
                return array(
                        'action=query&prop=pageterms&titles=London'
diff --git a/repo/includes/api/AvailableBadges.php 
b/repo/includes/api/AvailableBadges.php
index 0f4d370..cee6e6e 100644
--- a/repo/includes/api/AvailableBadges.php
+++ b/repo/includes/api/AvailableBadges.php
@@ -33,9 +33,7 @@
        }
 
        /**
-        * @see ApiBase::getExamplesMessages()
-        *
-        * @return array
+        * @see ApiBase::getExamplesMessages
         */
        protected function getExamplesMessages() {
                return array(
diff --git a/repo/includes/api/CreateClaim.php 
b/repo/includes/api/CreateClaim.php
index 8ffdb91..8f81b62 100644
--- a/repo/includes/api/CreateClaim.php
+++ b/repo/includes/api/CreateClaim.php
@@ -137,9 +137,7 @@
        }
 
        /**
-        * @see ApiBase::getExamplesMessages()
-        *
-        * @return array
+        * @see ApiBase::getExamplesMessages
         */
        protected function getExamplesMessages() {
                return array(
@@ -153,4 +151,5 @@
                                => 'apihelp-wbcreateclaim-example-4',
                );
        }
+
 }
diff --git a/repo/includes/api/CreateRedirectModule.php 
b/repo/includes/api/CreateRedirectModule.php
index 068fab7..decfdbe 100644
--- a/repo/includes/api/CreateRedirectModule.php
+++ b/repo/includes/api/CreateRedirectModule.php
@@ -175,9 +175,7 @@
        }
 
        /**
-        * @see ApiBase::getExamplesMessages()
-        *
-        * @return array
+        * @see ApiBase::getExamplesMessages
         */
        protected function getExamplesMessages() {
                return array(
diff --git a/repo/includes/api/EditEntity.php b/repo/includes/api/EditEntity.php
index 0cf2ec5..7981a68 100644
--- a/repo/includes/api/EditEntity.php
+++ b/repo/includes/api/EditEntity.php
@@ -743,8 +743,6 @@
 
        /**
         * @see ApiBase:getExamplesMessages
-        *
-        * @return string[]
         */
        protected function getExamplesMessages() {
                return array(
diff --git a/repo/includes/api/FormatSnakValue.php 
b/repo/includes/api/FormatSnakValue.php
index a6386e1..7d1ca4d 100644
--- a/repo/includes/api/FormatSnakValue.php
+++ b/repo/includes/api/FormatSnakValue.php
@@ -194,9 +194,7 @@
        }
 
        /**
-        * @see ApiBase::getExamplesMessages()
-        *
-        * @return array
+        * @see ApiBase::getExamplesMessages
         */
        protected function getExamplesMessages() {
                $query = "action=" . $this->getModuleName() ;
diff --git a/repo/includes/api/GetClaims.php b/repo/includes/api/GetClaims.php
index c0cf852..105e900 100644
--- a/repo/includes/api/GetClaims.php
+++ b/repo/includes/api/GetClaims.php
@@ -225,9 +225,7 @@
        }
 
        /**
-        * @see ApiBase::getExamplesMessages()
-        *
-        * @return array
+        * @see ApiBase::getExamplesMessages
         */
        protected function getExamplesMessages() {
                return array(
diff --git a/repo/includes/api/GetEntities.php 
b/repo/includes/api/GetEntities.php
index 2814e2e..09a852a 100644
--- a/repo/includes/api/GetEntities.php
+++ b/repo/includes/api/GetEntities.php
@@ -343,9 +343,7 @@
        }
 
        /**
-        * @see ApiBase::getExamplesMessages()
-        *
-        * @return array
+        * @see ApiBase::getExamplesMessages
         */
        protected function getExamplesMessages() {
                return array(
diff --git a/repo/includes/api/LinkTitles.php b/repo/includes/api/LinkTitles.php
index bfea635..d162b21 100644
--- a/repo/includes/api/LinkTitles.php
+++ b/repo/includes/api/LinkTitles.php
@@ -240,9 +240,7 @@
        }
 
        /**
-        * @see ApiBase::getExamplesMessages()
-        *
-        * @return array
+        * @see ApiBase::getExamplesMessages
         */
        protected function getExamplesMessages() {
                return array(
diff --git a/repo/includes/api/MergeItems.php b/repo/includes/api/MergeItems.php
index 10b88cb..ee7fc38 100644
--- a/repo/includes/api/MergeItems.php
+++ b/repo/includes/api/MergeItems.php
@@ -204,9 +204,7 @@
        }
 
        /**
-        * @see ApiBase::getExamplesMessages()
-        *
-        * @return array
+        * @see ApiBase::getExamplesMessages
         */
        protected function getExamplesMessages() {
                return array(
diff --git a/repo/includes/api/ParseValue.php b/repo/includes/api/ParseValue.php
index 474fe67..15f04e6 100644
--- a/repo/includes/api/ParseValue.php
+++ b/repo/includes/api/ParseValue.php
@@ -169,9 +169,7 @@
        }
 
        /**
-        * @see ApiBase::getExamplesMessages()
-        *
-        * @return array
+        * @see ApiBase::getExamplesMessages
         */
        protected function getExamplesMessages() {
                return array(
@@ -180,4 +178,4 @@
                );
        }
 
-}
\ No newline at end of file
+}
diff --git a/repo/includes/api/RemoveClaims.php 
b/repo/includes/api/RemoveClaims.php
index aa86dc1..3bf891b 100644
--- a/repo/includes/api/RemoveClaims.php
+++ b/repo/includes/api/RemoveClaims.php
@@ -159,9 +159,7 @@
        }
 
        /**
-        * @see ApiBase::getExamplesMessages()
-        *
-        * @return array
+        * @see ApiBase::getExamplesMessages
         */
        protected function getExamplesMessages() {
                return array(
diff --git a/repo/includes/api/RemoveQualifiers.php 
b/repo/includes/api/RemoveQualifiers.php
index b8811c8..c6140f2 100644
--- a/repo/includes/api/RemoveQualifiers.php
+++ b/repo/includes/api/RemoveQualifiers.php
@@ -142,9 +142,7 @@
        }
 
        /**
-        * @see ApiBase::getExamplesMessages()
-        *
-        * @return array
+        * @see ApiBase::getExamplesMessages
         */
        protected function getExamplesMessages() {
                return array(
diff --git a/repo/includes/api/RemoveReferences.php 
b/repo/includes/api/RemoveReferences.php
index 7c30e4e..694d724 100644
--- a/repo/includes/api/RemoveReferences.php
+++ b/repo/includes/api/RemoveReferences.php
@@ -146,9 +146,7 @@
        }
 
        /**
-        * @see ApiBase::getExamplesMessages()
-        *
-        * @return array
+        * @see ApiBase::getExamplesMessages
         */
        protected function getExamplesMessages() {
                return array(
diff --git a/repo/includes/api/SearchEntities.php 
b/repo/includes/api/SearchEntities.php
index 45e3d84..35575f6 100644
--- a/repo/includes/api/SearchEntities.php
+++ b/repo/includes/api/SearchEntities.php
@@ -353,9 +353,7 @@
        }
 
        /**
-        * @see ApiBase::getExamplesMessages()
-        *
-        * @return array
+        * @see ApiBase::getExamplesMessages
         */
        protected function getExamplesMessages() {
                return array(
diff --git a/repo/includes/api/SetAliases.php b/repo/includes/api/SetAliases.php
index 6435e7d..9a644eb 100644
--- a/repo/includes/api/SetAliases.php
+++ b/repo/includes/api/SetAliases.php
@@ -212,9 +212,7 @@
        }
 
        /**
-        * @see ApiBase::getExamplesMessages()
-        *
-        * @return array
+        * @see ApiBase::getExamplesMessages
         */
        protected function getExamplesMessages() {
                return array(
diff --git a/repo/includes/api/SetClaim.php b/repo/includes/api/SetClaim.php
index a836044..8d244d6 100644
--- a/repo/includes/api/SetClaim.php
+++ b/repo/includes/api/SetClaim.php
@@ -164,9 +164,7 @@
        }
 
        /**
-        * @see ApiBase::getExamplesMessages()
-        *
-        * @return array
+        * @see ApiBase::getExamplesMessages
         */
        protected function getExamplesMessages() {
                return array(
diff --git a/repo/includes/api/SetClaimValue.php 
b/repo/includes/api/SetClaimValue.php
index e69256c..0ebfc02 100644
--- a/repo/includes/api/SetClaimValue.php
+++ b/repo/includes/api/SetClaimValue.php
@@ -107,13 +107,12 @@
        }
 
        /**
-        * @see ApiBase::getExamplesMessages()
-        *
-        * @return array
+        * @see ApiBase::getExamplesMessages
         */
        protected function getExamplesMessages() {
                return array(
                        
'action=wbsetclaimvalue&claim=Q42$D8404CDA-25E4-4334-AF13-A3290BCD9C0F&snaktype=value&value={"entity-type":"item","numeric-id":1}&token=foobar&baserevid=7201010'
 => 'apihelp-wbsetclaimvalue-example-1',
                );
        }
+
 }
diff --git a/repo/includes/api/SetDescription.php 
b/repo/includes/api/SetDescription.php
index e79146f..a2f310a 100644
--- a/repo/includes/api/SetDescription.php
+++ b/repo/includes/api/SetDescription.php
@@ -83,9 +83,7 @@
        }
 
        /**
-        * @see ApiBase::getExamplesMessages()
-        *
-        * @return array
+        * @see ApiBase::getExamplesMessages
         */
        protected function getExamplesMessages() {
                return array(
diff --git a/repo/includes/api/SetLabel.php b/repo/includes/api/SetLabel.php
index 0a0ab58..3c9b18b 100644
--- a/repo/includes/api/SetLabel.php
+++ b/repo/includes/api/SetLabel.php
@@ -83,9 +83,7 @@
        }
 
        /**
-        * @see ApiBase::getExamplesMessages()
-        *
-        * @return array
+        * @see ApiBase::getExamplesMessages
         */
        protected function getExamplesMessages() {
                return array(
diff --git a/repo/includes/api/SetQualifier.php 
b/repo/includes/api/SetQualifier.php
index b4a07f9..23bf8a5 100644
--- a/repo/includes/api/SetQualifier.php
+++ b/repo/includes/api/SetQualifier.php
@@ -171,13 +171,12 @@
        }
 
        /**
-        * @see ApiBase::getExamplesMessages()
-        *
-        * @return array
+        * @see ApiBase::getExamplesMessages
         */
        protected function getExamplesMessages() {
                return array(
                        
'action=wbsetqualifier&claim=Q2$4554c0f4-47b2-1cd9-2db9-aa270064c9f3&property=P1&value=GdyjxP8I6XB3&snaktype=value&token=foobar'
 => 'apihelp-wbsetqualifier-example-1',
                );
        }
+
 }
diff --git a/repo/includes/api/SetReference.php 
b/repo/includes/api/SetReference.php
index 17fb5ae..4831eb9 100644
--- a/repo/includes/api/SetReference.php
+++ b/repo/includes/api/SetReference.php
@@ -230,9 +230,7 @@
        }
 
        /**
-        * @see ApiBase::getExamplesMessages()
-        *
-        * @return array
+        * @see ApiBase::getExamplesMessages
         */
        protected function getExamplesMessages() {
                return array(
@@ -244,4 +242,5 @@
                                => 'apihelp-wbsetreference-example-3',
                );
        }
+
 }
diff --git a/repo/includes/api/SetSiteLink.php 
b/repo/includes/api/SetSiteLink.php
index a09e113..5aedd18 100644
--- a/repo/includes/api/SetSiteLink.php
+++ b/repo/includes/api/SetSiteLink.php
@@ -181,9 +181,7 @@
        }
 
        /**
-        * @see ApiBase::getExamplesMessages()
-        *
-        * @return array
+        * @see ApiBase::getExamplesMessages
         */
        protected function getExamplesMessages() {
                return array(

-- 
To view, visit https://gerrit.wikimedia.org/r/189922
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings

Gerrit-MessageType: merged
Gerrit-Change-Id: Icd90c6ad715acafe7af70bc9d0a8ea485fdbaded
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/Wikibase
Gerrit-Branch: master
Gerrit-Owner: Thiemo Mättig (WMDE) <[email protected]>
Gerrit-Reviewer: Addshore <[email protected]>
Gerrit-Reviewer: Aude <[email protected]>
Gerrit-Reviewer: jenkins-bot <>

_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits

Reply via email to