From bc9019458c9dd9a452dc430caf6b5262c5229b73 Mon Sep 17 00:00:00 2001 From: Fredrik Forsmo Date: Wed, 6 Jan 2016 19:58:38 +0100 Subject: [PATCH] Improve docblock comments WC_Widget classes * Added better comment to `widget`, `form` and `update` methods. --- includes/widgets/class-wc-widget-cart.php | 2 +- includes/widgets/class-wc-widget-layered-nav-filters.php | 2 +- includes/widgets/class-wc-widget-layered-nav.php | 8 ++++---- includes/widgets/class-wc-widget-price-filter.php | 2 +- includes/widgets/class-wc-widget-product-categories.php | 2 +- includes/widgets/class-wc-widget-product-search.php | 2 +- includes/widgets/class-wc-widget-product-tag-cloud.php | 2 +- includes/widgets/class-wc-widget-products.php | 2 +- includes/widgets/class-wc-widget-recent-reviews.php | 2 +- includes/widgets/class-wc-widget-recently-viewed.php | 2 +- includes/widgets/class-wc-widget-top-rated-products.php | 2 +- 11 files changed, 14 insertions(+), 14 deletions(-) diff --git a/includes/widgets/class-wc-widget-cart.php b/includes/widgets/class-wc-widget-cart.php index 517648a637a..fdc559132b0 100644 --- a/includes/widgets/class-wc-widget-cart.php +++ b/includes/widgets/class-wc-widget-cart.php @@ -42,7 +42,7 @@ class WC_Widget_Cart extends WC_Widget { } /** - * widget function. + * Output widget. * * @see WP_Widget * diff --git a/includes/widgets/class-wc-widget-layered-nav-filters.php b/includes/widgets/class-wc-widget-layered-nav-filters.php index 8e23bd571a2..416ea1879a0 100644 --- a/includes/widgets/class-wc-widget-layered-nav-filters.php +++ b/includes/widgets/class-wc-widget-layered-nav-filters.php @@ -35,7 +35,7 @@ class WC_Widget_Layered_Nav_Filters extends WC_Widget { } /** - * widget function. + * Output widget. * * @see WP_Widget * diff --git a/includes/widgets/class-wc-widget-layered-nav.php b/includes/widgets/class-wc-widget-layered-nav.php index 26abf96bad3..767b4692462 100644 --- a/includes/widgets/class-wc-widget-layered-nav.php +++ b/includes/widgets/class-wc-widget-layered-nav.php @@ -28,7 +28,7 @@ class WC_Widget_Layered_Nav extends WC_Widget { } /** - * update function. + * Updates a particular instance of a widget. * * @see WP_Widget->update * @@ -44,7 +44,7 @@ class WC_Widget_Layered_Nav extends WC_Widget { } /** - * form function. + * Outputs the settings update form. * * @see WP_Widget->form * @@ -105,7 +105,7 @@ class WC_Widget_Layered_Nav extends WC_Widget { } /** - * widget function. + * Output widget. * * @see WP_Widget * @@ -380,7 +380,7 @@ class WC_Widget_Layered_Nav extends WC_Widget { } // End display type conditional $this->widget_end( $args ); - + if ( ! $found ) { ob_end_clean(); } else { diff --git a/includes/widgets/class-wc-widget-price-filter.php b/includes/widgets/class-wc-widget-price-filter.php index d04364c61a2..480e072cd95 100644 --- a/includes/widgets/class-wc-widget-price-filter.php +++ b/includes/widgets/class-wc-widget-price-filter.php @@ -37,7 +37,7 @@ class WC_Widget_Price_Filter extends WC_Widget { } /** - * widget function. + * Output widget. * * @see WP_Widget * diff --git a/includes/widgets/class-wc-widget-product-categories.php b/includes/widgets/class-wc-widget-product-categories.php index dd3259bde5a..3f354432443 100644 --- a/includes/widgets/class-wc-widget-product-categories.php +++ b/includes/widgets/class-wc-widget-product-categories.php @@ -83,7 +83,7 @@ class WC_Widget_Product_Categories extends WC_Widget { } /** - * widget function. + * Output widget. * * @see WP_Widget * diff --git a/includes/widgets/class-wc-widget-product-search.php b/includes/widgets/class-wc-widget-product-search.php index bde7ca2b7f5..d8dac1dc614 100644 --- a/includes/widgets/class-wc-widget-product-search.php +++ b/includes/widgets/class-wc-widget-product-search.php @@ -35,7 +35,7 @@ class WC_Widget_Product_Search extends WC_Widget { } /** - * widget function. + * Output widget. * * @see WP_Widget * diff --git a/includes/widgets/class-wc-widget-product-tag-cloud.php b/includes/widgets/class-wc-widget-product-tag-cloud.php index 9401ed63e44..55676a98b2c 100644 --- a/includes/widgets/class-wc-widget-product-tag-cloud.php +++ b/includes/widgets/class-wc-widget-product-tag-cloud.php @@ -35,7 +35,7 @@ class WC_Widget_Product_Tag_Cloud extends WC_Widget { } /** - * widget function. + * Output widget. * * @see WP_Widget * diff --git a/includes/widgets/class-wc-widget-products.php b/includes/widgets/class-wc-widget-products.php index 4340e168b90..4b50d50433c 100644 --- a/includes/widgets/class-wc-widget-products.php +++ b/includes/widgets/class-wc-widget-products.php @@ -154,7 +154,7 @@ class WC_Widget_Products extends WC_Widget { } /** - * widget function. + * Output widget. * * @see WP_Widget * diff --git a/includes/widgets/class-wc-widget-recent-reviews.php b/includes/widgets/class-wc-widget-recent-reviews.php index 3c2d388e46f..b13cd90325a 100644 --- a/includes/widgets/class-wc-widget-recent-reviews.php +++ b/includes/widgets/class-wc-widget-recent-reviews.php @@ -43,7 +43,7 @@ class WC_Widget_Recent_Reviews extends WC_Widget { } /** - * widget function. + * Output widget. * * @see WP_Widget * diff --git a/includes/widgets/class-wc-widget-recently-viewed.php b/includes/widgets/class-wc-widget-recently-viewed.php index 1edd266f52f..08ad4a0da59 100644 --- a/includes/widgets/class-wc-widget-recently-viewed.php +++ b/includes/widgets/class-wc-widget-recently-viewed.php @@ -43,7 +43,7 @@ class WC_Widget_Recently_Viewed extends WC_Widget { } /** - * widget function. + * Output widget. * * @see WP_Widget * diff --git a/includes/widgets/class-wc-widget-top-rated-products.php b/includes/widgets/class-wc-widget-top-rated-products.php index b69d6bd39f8..c86b079e1ff 100644 --- a/includes/widgets/class-wc-widget-top-rated-products.php +++ b/includes/widgets/class-wc-widget-top-rated-products.php @@ -45,7 +45,7 @@ class WC_Widget_Top_Rated_Products extends WC_Widget { } /** - * widget function. + * Output widget. * * @see WP_Widget *