Improve docblock comments in various WC_* classes
* Added comments to various methods * Fixed various properties comments and param types
This commit is contained in:
parent
870ecfea11
commit
bb19615029
|
@ -48,7 +48,7 @@ class WC_HTTPS {
|
|||
}
|
||||
|
||||
/**
|
||||
* force_https_url function.
|
||||
* Force https for urls.
|
||||
*
|
||||
* @param mixed $content
|
||||
* @return string
|
||||
|
|
|
@ -43,7 +43,7 @@ class WC_Install {
|
|||
}
|
||||
|
||||
/**
|
||||
* check_version function.
|
||||
* Check WooCommerce version.
|
||||
*/
|
||||
public static function check_version() {
|
||||
if ( ! defined( 'IFRAME_REQUEST' ) && ( get_option( 'woocommerce_version' ) != WC()->version ) ) {
|
||||
|
|
|
@ -17,7 +17,11 @@ if ( ! defined( 'ABSPATH' ) ) {
|
|||
*/
|
||||
class WC_Integrations {
|
||||
|
||||
/** Array of integration classes */
|
||||
/**
|
||||
* Array of integrations.
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
public $integrations = array();
|
||||
|
||||
/**
|
||||
|
|
|
@ -16,7 +16,9 @@ if ( ! defined( 'ABSPATH' ) ) {
|
|||
class WC_Logger {
|
||||
|
||||
/**
|
||||
* @var array Stores open file _handles.
|
||||
* Stores open file _handles.
|
||||
*
|
||||
* @var array
|
||||
* @access private
|
||||
*/
|
||||
private $_handles;
|
||||
|
|
|
@ -18,7 +18,7 @@ if ( ! defined( 'ABSPATH' ) ) {
|
|||
class WC_Order_Factory {
|
||||
|
||||
/**
|
||||
* get_order function.
|
||||
* Get order.
|
||||
*
|
||||
* @param bool $the_order (default: false)
|
||||
* @return WC_Order|bool
|
||||
|
|
|
@ -17,6 +17,11 @@ if ( ! defined( 'ABSPATH' ) ) {
|
|||
*/
|
||||
class WC_Post_Data {
|
||||
|
||||
/**
|
||||
* Editing term.
|
||||
*
|
||||
* @var object
|
||||
*/
|
||||
private static $editing_term = null;
|
||||
|
||||
/**
|
||||
|
|
|
@ -15,7 +15,18 @@ if ( ! defined( 'ABSPATH' ) ) {
|
|||
*/
|
||||
class WC_Tax {
|
||||
|
||||
/**
|
||||
* Precision.
|
||||
*
|
||||
* @var int
|
||||
*/
|
||||
public static $precision;
|
||||
|
||||
/**
|
||||
* Round at subtotal.
|
||||
*
|
||||
* @var bool
|
||||
*/
|
||||
public static $round_at_subtotal;
|
||||
|
||||
/**
|
||||
|
|
|
@ -84,7 +84,7 @@ class WC_Template_Loader {
|
|||
}
|
||||
|
||||
/**
|
||||
* comments_template_loader function.
|
||||
* Load comments template.
|
||||
*
|
||||
* @param mixed $template
|
||||
* @return string
|
||||
|
|
Loading…
Reference in New Issue