From 809e0a382b65bf2e8253a625bfe9cf58b23a1f50 Mon Sep 17 00:00:00 2001 From: Fredrik Forsmo Date: Wed, 6 Jan 2016 15:35:35 +0100 Subject: [PATCH] Improve docblock comments in WC_API class * Added type to missing property comment * Added missing type to param tag for `add_query_vars` * Added better comments for properties --- includes/class-wc-api.php | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) diff --git a/includes/class-wc-api.php b/includes/class-wc-api.php index 5a39bd3ba8c..1ef5e831715 100644 --- a/includes/class-wc-api.php +++ b/includes/class-wc-api.php @@ -18,15 +18,26 @@ if ( ! class_exists( 'WC_API' ) ) : class WC_API { - /** This is the major version for the REST API and takes + /** + * This is the major version for the REST API and takes * first-order position in endpoint URLs. + * + * @var string */ const VERSION = '3.1.0'; - /** @var WC_API_Server the REST API server */ + /** + * The REST API server. + * + * @var WC_API_Server + */ public $server; - /** @var WC_API_Authentication REST API authentication class instance */ + /** + * REST API authentication class instance. + * + * @var WC_API_Authentication + */ public $authentication; /** @@ -56,7 +67,7 @@ class WC_API { * Add new query vars. * * @since 2.0 - * @param $vars + * @param array $vars * @return string[] */ public function add_query_vars( $vars ) {