From d553b080deecbebc03eaa45ebe351bf418f956f8 Mon Sep 17 00:00:00 2001 From: JeroenSormani Date: Wed, 1 Mar 2017 18:44:11 +0100 Subject: [PATCH] Fix some docblock @param tags / remove a @access public --- includes/class-wc-validation.php | 19 +++++++++---------- 1 file changed, 9 insertions(+), 10 deletions(-) diff --git a/includes/class-wc-validation.php b/includes/class-wc-validation.php index 57afd384a82..48813e3a99b 100644 --- a/includes/class-wc-validation.php +++ b/includes/class-wc-validation.php @@ -16,9 +16,9 @@ if ( ! defined( 'ABSPATH' ) ) { class WC_Validation { /** - * Validates an email using wordpress native is_email function. + * Validates an email using WordPress native is_email function. * - * @param string email address + * @param string $email Email address to validate. * @return bool */ public static function is_email( $email ) { @@ -28,7 +28,7 @@ class WC_Validation { /** * Validates a phone number using a regular expression. * - * @param string phone number + * @param string $phone Phone number to validate. * @return bool */ public static function is_phone( $phone ) { @@ -42,8 +42,8 @@ class WC_Validation { /** * Checks for a valid postcode. * - * @param string postcode - * @param string country + * @param string $postcode Postcode to validate. + * @param string $country Country to validate the postcode for. * @return bool */ public static function is_postcode( $postcode, $country ) { @@ -154,9 +154,9 @@ class WC_Validation { /** * Format the postcode according to the country and length of the postcode. * - * @param string postcode - * @param string country - * @return string formatted postcode + * @param string $postcode Postcode to format. + * @param string $country Country to format the postcode for. + * @return string Formatted postcode. */ public static function format_postcode( $postcode, $country ) { return wc_format_postcode( $postcode, $country ); @@ -165,8 +165,7 @@ class WC_Validation { /** * format_phone function. * - * @access public - * @param mixed $tel + * @param mixed $tel Phone number to format. * @return string */ public static function format_phone( $tel ) {