Merge pull request #5708 from JDGrimes/docs-fixes

Update copy-pasted docs for class instance() methods
This commit is contained in:
Mike Jolley 2014-06-23 12:02:59 +01:00
commit 02ccef615b
4 changed files with 16 additions and 20 deletions

View File

@ -34,20 +34,19 @@ class WC_Checkout {
private $customer_id; private $customer_id;
/** /**
* @var WooCommerce The single instance of the class * @var WC_Checkout The single instance of the class
* @since 2.1 * @since 2.1
*/ */
protected static $_instance = null; protected static $_instance = null;
/** /**
* Main WooCommerce Instance * Main WC_Checkout Instance
* *
* Ensures only one instance of WooCommerce is loaded or can be loaded. * Ensures only one instance of WC_Checkout is loaded or can be loaded.
* *
* @since 2.1 * @since 2.1
* @static * @static
* @see WC() * @return WC_Checkout Main instance
* @return Main WooCommerce instance
*/ */
public static function instance() { public static function instance() {
if ( is_null( self::$_instance ) ) if ( is_null( self::$_instance ) )

View File

@ -37,20 +37,19 @@ class WC_Emails {
private $_content_type; private $_content_type;
/** /**
* @var WooCommerce The single instance of the class * @var WC_Emails The single instance of the class
* @since 2.1 * @since 2.1
*/ */
protected static $_instance = null; protected static $_instance = null;
/** /**
* Main WooCommerce Instance * Main WC_Emails Instance
* *
* Ensures only one instance of WooCommerce is loaded or can be loaded. * Ensures only one instance of WC_Emails is loaded or can be loaded.
* *
* @since 2.1 * @since 2.1
* @static * @static
* @see WC() * @return WC_Emails Main instance
* @return Main WooCommerce instance
*/ */
public static function instance() { public static function instance() {
if ( is_null( self::$_instance ) ) if ( is_null( self::$_instance ) )

View File

@ -16,20 +16,19 @@ class WC_Payment_Gateways {
var $payment_gateways; var $payment_gateways;
/** /**
* @var WooCommerce The single instance of the class * @var WC_Payment_Gateways The single instance of the class
* @since 2.1 * @since 2.1
*/ */
protected static $_instance = null; protected static $_instance = null;
/** /**
* Main WooCommerce Instance * Main WC_Payment_Gateways Instance
* *
* Ensures only one instance of WooCommerce is loaded or can be loaded. * Ensures only one instance of WC_Payment_Gateways is loaded or can be loaded.
* *
* @since 2.1 * @since 2.1
* @static * @static
* @see WC() * @return WC_Payment_Gateways Main instance
* @return Main WooCommerce instance
*/ */
public static function instance() { public static function instance() {
if ( is_null( self::$_instance ) ) if ( is_null( self::$_instance ) )

View File

@ -34,20 +34,19 @@ class WC_Shipping {
var $packages = array(); var $packages = array();
/** /**
* @var WooCommerce The single instance of the class * @var WC_Shipping The single instance of the class
* @since 2.1 * @since 2.1
*/ */
protected static $_instance = null; protected static $_instance = null;
/** /**
* Main WooCommerce Instance * Main WC_Shipping Instance
* *
* Ensures only one instance of WooCommerce is loaded or can be loaded. * Ensures only one instance of WC_Shipping is loaded or can be loaded.
* *
* @since 2.1 * @since 2.1
* @static * @static
* @see WC() * @return WC_Shipping Main instance
* @return Main WooCommerce instance
*/ */
public static function instance() { public static function instance() {
if ( is_null( self::$_instance ) ) if ( is_null( self::$_instance ) )