Steve-Dee-Designs
/
woocommerce
mirror of https://github.com/woocommerce/woocommerce.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

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
This commit is contained in:
Fredrik Forsmo 2016-01-06 15:35:35 +01:00
parent 870ecfea11
commit 809e0a382b
1 changed files with 15 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
includes/class-wc-api.php
View File

@ -18,15 +18,26 @@ if ( ! class_exists( 'WC_API' ) ) :
class 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. * first-order position in endpoint URLs.
*
* @var string
*/ */
const VERSION = '3.1.0'; const VERSION = '3.1.0';
/** @var WC_API_Server the REST API server */ /**
* The REST API server.
*
* @var WC_API_Server
*/
public $server; public $server;
/** @var WC_API_Authentication REST API authentication class instance */ /**
* REST API authentication class instance.
*
* @var WC_API_Authentication
*/
public $authentication; public $authentication;
/** /**
@ -56,7 +67,7 @@ class WC_API {
* Add new query vars. * Add new query vars.
* *
* @since 2.0 * @since 2.0
* @param $vars * @param array $vars
* @return string[] * @return string[]
*/ */
public function add_query_vars( $vars ) { public function add_query_vars( $vars ) {