Merge pull request #9998 from frozzare/docs/class-wc-countries
Improve docblock comments WC_Countries class
This commit is contained in:
commit
62c195b238
|
@ -194,7 +194,7 @@ class WC_Countries {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* get_allowed_country_states function.
|
* Get allowed country states.
|
||||||
* @return array
|
* @return array
|
||||||
*/
|
*/
|
||||||
public function get_allowed_country_states() {
|
public function get_allowed_country_states() {
|
||||||
|
@ -216,7 +216,7 @@ class WC_Countries {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* get_shipping_country_states function.
|
* Get shipping country states.
|
||||||
* @return array
|
* @return array
|
||||||
*/
|
*/
|
||||||
public function get_shipping_country_states() {
|
public function get_shipping_country_states() {
|
||||||
|
@ -317,6 +317,7 @@ class WC_Countries {
|
||||||
* @param string $selected_country (default: '')
|
* @param string $selected_country (default: '')
|
||||||
* @param string $selected_state (default: '')
|
* @param string $selected_state (default: '')
|
||||||
* @param bool $escape (default: false)
|
* @param bool $escape (default: false)
|
||||||
|
* @param bool $escape (default: false)
|
||||||
*/
|
*/
|
||||||
public function country_dropdown_options( $selected_country = '', $selected_state = '', $escape = false ) {
|
public function country_dropdown_options( $selected_country = '', $selected_state = '', $escape = false ) {
|
||||||
if ( $this->countries ) foreach ( $this->countries as $key => $value ) :
|
if ( $this->countries ) foreach ( $this->countries as $key => $value ) :
|
||||||
|
@ -475,7 +476,7 @@ class WC_Countries {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Trim white space and commas off a line.
|
* Trim white space and commas off a line.
|
||||||
* @param string
|
* @param string $line
|
||||||
* @return string
|
* @return string
|
||||||
*/
|
*/
|
||||||
private function trim_formatted_address_line( $line ) {
|
private function trim_formatted_address_line( $line ) {
|
||||||
|
@ -912,7 +913,7 @@ class WC_Countries {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Apply locale and get address fields.
|
* Apply locale and get address fields.
|
||||||
* @param mixed $country
|
* @param mixed $country (default: '')
|
||||||
* @param string $type (default: 'billing_')
|
* @param string $type (default: 'billing_')
|
||||||
* @return array
|
* @return array
|
||||||
*/
|
*/
|
||||||
|
|
Loading…
Reference in New Issue