jenkins-bot has submitted this change and it was merged. ( https://gerrit.wikimedia.org/r/405003 )
Change subject: Add missing @return tags ...................................................................... Add missing @return tags And a few other fixups in the same phpdoc blocks. Change-Id: Ia911d6b0964b26574470a56b8c3c27e04e4143c1 --- M amazon_gateway/amazon.adapter.php M gateway_common/MessageUtils.php M gateway_common/gateway.adapter.php M special/GatewayFormChooser.php 4 files changed, 9 insertions(+), 3 deletions(-) Approvals: Mepps: Looks good to me, approved jenkins-bot: Verified diff --git a/amazon_gateway/amazon.adapter.php b/amazon_gateway/amazon.adapter.php index c392d9c..8d00f98 100644 --- a/amazon_gateway/amazon.adapter.php +++ b/amazon_gateway/amazon.adapter.php @@ -169,6 +169,8 @@ * the first place. * @param string $functionName * @param array $parameters + * @throws ResponseProcessingException on call failure or error code + * @return array Results of the SDK client call */ protected function callPwaClient( $functionName, $parameters ) { $callMe = array( $this->client, $functionName ); diff --git a/gateway_common/MessageUtils.php b/gateway_common/MessageUtils.php index 572da6d..2beb642 100644 --- a/gateway_common/MessageUtils.php +++ b/gateway_common/MessageUtils.php @@ -48,6 +48,7 @@ * @param string $country * @param string $language * @param array $params extra message parameters + * @return string Localized message */ public static function getCountrySpecificMessage( $key, $country, $language, $params = array() ) { return self::languageSpecificFallback( diff --git a/gateway_common/gateway.adapter.php b/gateway_common/gateway.adapter.php index 4fdbc3c..39c7bbe 100644 --- a/gateway_common/gateway.adapter.php +++ b/gateway_common/gateway.adapter.php @@ -557,7 +557,8 @@ /** * Gets a global variable according to @see getGlobal rules, then replaces * $country and $language with values from gateway instance data. - * @param string $varname + * @param string $varname Name of setting to retrieve + * @return string Localized setting */ public function localizeGlobal( $varname ) { $value = self::getGlobal( $varname ); diff --git a/special/GatewayFormChooser.php b/special/GatewayFormChooser.php index 645408a..5b323ed 100644 --- a/special/GatewayFormChooser.php +++ b/special/GatewayFormChooser.php @@ -125,7 +125,8 @@ * to get one. * @param array $other_params An array of any params that DonationData * will harvest and understand. - * @throw UnexpectedValueException + * @throws MWException on ambiguous gateway or bad gateway name + * @return string The form URL */ static function buildPaymentsFormURL( $form_key, $other_params = array() ) { global $wgDonationInterfaceDefaultAppeal; @@ -603,7 +604,8 @@ * @param string $gateway The gateway used for the payment that failed * @param string $payment_method The code for the payment method that failed * @param string $payment_submethod Code for the payment submethod that failed - * @throws RuntimeException + * @throws RuntimeException if no form found + * @return string The name of the best error form */ static function getBestErrorForm( $gateway, $payment_method, $payment_submethod = null ) { global $wgDonationInterfaceAllowedHtmlForms; -- To view, visit https://gerrit.wikimedia.org/r/405003 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: merged Gerrit-Change-Id: Ia911d6b0964b26574470a56b8c3c27e04e4143c1 Gerrit-PatchSet: 2 Gerrit-Project: mediawiki/extensions/DonationInterface Gerrit-Branch: master Gerrit-Owner: Ejegg <ej...@ejegg.com> Gerrit-Reviewer: AndyRussG <andrew.green...@gmail.com> Gerrit-Reviewer: Mepps <me...@wikimedia.org> Gerrit-Reviewer: XenoRyet <dkozlow...@wikimedia.org> Gerrit-Reviewer: jenkins-bot <> _______________________________________________ MediaWiki-commits mailing list MediaWiki-commits@lists.wikimedia.org https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits