From 7e75c12ba6f5d85d774c085c42047616ce22f462 Mon Sep 17 00:00:00 2001 From: otrocodigo <122544856+otrocodigo@users.noreply.github.com> Date: Mon, 26 Feb 2024 06:43:22 -0300 Subject: [PATCH] Fixed errors in file documentation syntax. (#44629) * Fixed errors in file documentation syntax. * Add changefile(s) from automation for the following project(s): woocommerce --------- Co-authored-by: github-actions --- plugins/woocommerce/changelog/44629-trunk | 4 ++++ plugins/woocommerce/src/Admin/API/Init.php | 4 ++-- .../src/Blocks/BlockTypes/ProductStockIndicator.php | 8 ++++---- .../woocommerce/src/StoreApi/Payments/PaymentContext.php | 2 +- 4 files changed, 11 insertions(+), 7 deletions(-) create mode 100644 plugins/woocommerce/changelog/44629-trunk diff --git a/plugins/woocommerce/changelog/44629-trunk b/plugins/woocommerce/changelog/44629-trunk new file mode 100644 index 0000000000000..83996f17380c7 --- /dev/null +++ b/plugins/woocommerce/changelog/44629-trunk @@ -0,0 +1,4 @@ +Significance: patch +Type: tweak + +Fixed minor errors in file documentation syntax. \ No newline at end of file diff --git a/plugins/woocommerce/src/Admin/API/Init.php b/plugins/woocommerce/src/Admin/API/Init.php index 4ce21841be883..4464b44722a3e 100644 --- a/plugins/woocommerce/src/Admin/API/Init.php +++ b/plugins/woocommerce/src/Admin/API/Init.php @@ -190,8 +190,8 @@ public static function add_data_stores( $data_stores ) { * object in REST API responses. For use in formatAmount(). * * @internal - * @param {WP_REST_Response} $response REST response object. - * @returns {WP_REST_Response} + * @param WP_REST_Response $response REST response object. + * @returns WP_REST_Response */ public static function add_currency_symbol_to_order_response( $response ) { $response_data = $response->get_data(); diff --git a/plugins/woocommerce/src/Blocks/BlockTypes/ProductStockIndicator.php b/plugins/woocommerce/src/Blocks/BlockTypes/ProductStockIndicator.php index e4b2d516d64d8..df7488d3de274 100644 --- a/plugins/woocommerce/src/Blocks/BlockTypes/ProductStockIndicator.php +++ b/plugins/woocommerce/src/Blocks/BlockTypes/ProductStockIndicator.php @@ -45,10 +45,10 @@ protected function get_block_type_uses_context() { * - Available on backorder * - 2 left in stock * - * @param [bool] $is_in_stock Whether the product is in stock. - * @param [bool] $is_low_stock Whether the product is low in stock. - * @param [int|null] $low_stock_amount The amount of stock that is considered low. - * @param [bool] $is_on_backorder Whether the product is on backorder. + * @param bool $is_in_stock Whether the product is in stock. + * @param bool $is_low_stock Whether the product is low in stock. + * @param int|null $low_stock_amount The amount of stock that is considered low. + * @param bool $is_on_backorder Whether the product is on backorder. * @return string Stock text. */ protected static function getTextBasedOnStock( $is_in_stock, $is_low_stock, $low_stock_amount, $is_on_backorder ) { diff --git a/plugins/woocommerce/src/StoreApi/Payments/PaymentContext.php b/plugins/woocommerce/src/StoreApi/Payments/PaymentContext.php index f462cc125e50f..c80ec9c1c331f 100644 --- a/plugins/woocommerce/src/StoreApi/Payments/PaymentContext.php +++ b/plugins/woocommerce/src/StoreApi/Payments/PaymentContext.php @@ -50,7 +50,7 @@ public function set_payment_method( $payment_method ) { /** * Retrieve the payment method instance for the current set payment method. * - * @return {\WC_Payment_Gateway|null} An instance of the payment gateway if it exists. + * @return \WC_Payment_Gateway|null An instance of the payment gateway if it exists. */ public function get_payment_method_instance() { $available_gateways = WC()->payment_gateways->get_available_payment_gateways();