Improve docblock comments in WC_Report_Sales_By_Product class

* Added comments to properties that don’t have any.
* Added comment to `get_chart_widgets` since it
was `method function`
* Added missing `exit if accessed directly`
* Updated `current_filters` and `products_widget`
This commit is contained in:
Fredrik Forsmo 2016-01-05 12:41:12 +01:00
parent e07185ec1f
commit 53d5684c92
1 changed files with 25 additions and 3 deletions

View File

@ -1,4 +1,9 @@
<?php
if ( ! defined( 'ABSPATH' ) ) {
exit; // Exit if accessed directly
}
/**
* WC_Report_Sales_By_Product
*
@ -9,8 +14,25 @@
*/
class WC_Report_Sales_By_Product extends WC_Admin_Report {
/**
* Chart colours.
*
* @var array
*/
public $chart_colours = array();
/**
* Product ids.
*
* @var array
*/
public $product_ids = array();
/**
* Product ids with titles.
*
* @var array
*/
public $product_ids_titles = array();
/**
@ -124,7 +146,7 @@ class WC_Report_Sales_By_Product extends WC_Admin_Report {
}
/**
* [get_chart_widgets description].
* Get chart widgets.
*
* @return array
*/
@ -148,7 +170,7 @@ class WC_Report_Sales_By_Product extends WC_Admin_Report {
}
/**
* Show current filters.
* Output current filters.
*/
public function current_filters() {
@ -170,7 +192,7 @@ class WC_Report_Sales_By_Product extends WC_Admin_Report {
}
/**
* Product selection.
* Output products widget.
*/
public function products_widget() {
?>