fix phpdoc

Author: pyrech

src/Geocoder/Exception/ProviderNotRegistered.php

@@ -17,6 +17,7 @@ class ProviderNotRegistered extends \RuntimeException implements Exception
 {
     /**
      * @param string $providerName
+     * @param array  $registeredProviders
      */
     public function __construct($providerName, array $registeredProviders = [])
     {

src/Geocoder/Model/AddressFactory.php

@@ -56,15 +56,19 @@ public function createFromArray(array $results)
     }
 
     /**
+     * @param array  $data
      * @param string $key
+     * @return double
      */
     private function readDoubleValue(array $data, $key)
     {
         return (double) \igorw\get_in($data, explode('.', $key));
     }
 
     /**
+     * @param array  $data
      * @param string $key
+     * @return string
      */
     private function readStringValue(array $data, $key)
     {

src/Geocoder/Model/Bounds.php

@@ -15,12 +15,24 @@
  */
 final class Bounds
 {
+    /**
+     * @var double
+     */
     private $south;
 
+    /**
+     * @var double
+     */
     private $west;
 
+    /**
+     * @var double
+     */
     private $north;
 
+    /**
+     * @var double
+     */
     private $east;
 
     /**
@@ -37,31 +49,61 @@ public function __construct($south, $west, $north, $east)
         $this->east  = $east;
     }
 
+    /**
+     * Returns the south bound.
+     *
+     * @return double
+     */
     public function getSouth()
     {
         return $this->south;
     }
 
+    /**
+     * Returns the west bound.
+     *
+     * @return double
+     */
     public function getWest()
     {
         return $this->west;
     }
 
+    /**
+     * Returns the north bound.
+     *
+     * @return double
+     */
     public function getNorth()
     {
         return $this->north;
     }
 
+    /**
+     * Returns the east bound.
+     *
+     * @return double
+     */
     public function getEast()
     {
         return $this->east;
     }
 
+    /**
+     * Returns whether or not bounds are defined
+     *
+     * @return bool
+     */
     public function isDefined()
     {
         return !empty($this->south) && !empty($this->east) && !empty($this->north) && !empty($this->west);
     }
 
+    /**
+     * Returns an array with bounds.
+     *
+     * @return array
+     */
     public function toArray()
     {
         return [

src/Geocoder/Model/Coordinates.php

@@ -15,8 +15,14 @@
  */
 final class Coordinates
 {
+    /**
+     * @var double
+     */
     private $latitude;
 
+    /**
+     * @var double
+     */
     private $longitude;
 
     /**
@@ -29,11 +35,21 @@ public function __construct($latitude, $longitude)
         $this->longitude = $longitude;
     }
 
+    /**
+     * Returns the latitude.
+     *
+     * @return double
+     */
     public function getLatitude()
     {
         return $this->latitude;
     }
 
+    /**
+     * Returns the longitude.
+     *
+     * @return double
+     */
     public function getLongitude()
     {
         return $this->longitude;

src/Geocoder/Model/Country.php

@@ -15,11 +15,18 @@
  */
 final class Country
 {
+    /**
+     * @var string
+     */
     private $name;
 
+    /**
+     * @var string
+     */
     private $code;
 
     /**
+     * @param string $name
      * @param string $code
      */
     public function __construct($name, $code)
@@ -28,16 +35,31 @@ public function __construct($name, $code)
         $this->code = $code;
     }
 
+    /**
+     * Returns the country name
+     *
+     * @return string
+     */
     public function getName()
     {
         return $this->name;
     }
 
+    /**
+     * Returns the country ISO code.
+     *
+     * @return string
+     */
     public function getCode()
     {
         return $this->code;
     }
 
+    /**
+     * Returns a string with the country name.
+     *
+     * @return array
+     */
     public function toString()
     {
         return $this->getName();

src/Geocoder/Model/County.php

@@ -15,11 +15,18 @@
  */
 final class County
 {
+    /**
+     * @var string
+     */
     private $name;
 
+    /**
+     * @var string
+     */
     private $code;
 
     /**
+     * @param string $name
      * @param string $code
      */
     public function __construct($name, $code)
@@ -28,16 +35,31 @@ public function __construct($name, $code)
         $this->code = $code;
     }
 
+    /**
+     * Returns the country name
+     *
+     * @return string
+     */
     public function getName()
     {
         return $this->name;
     }
 
+    /**
+     * Returns the county short name.
+     *
+     * @return string
+     */
     public function getCode()
     {
         return $this->code;
     }
 
+    /**
+     * Returns a string with the county name.
+     *
+     * @return array
+     */
     public function toString()
     {
         return $this->getName();

src/Geocoder/Model/Region.php

@@ -15,11 +15,18 @@
  */
 final class Region
 {
+    /**
+     * @var string
+     */
     private $name;
 
+    /**
+     * @var string
+     */
     private $code;
 
     /**
+     * @param string $name
      * @param string $code
      */
     public function __construct($name, $code)
@@ -28,16 +35,31 @@ public function __construct($name, $code)
         $this->code = $code;
     }
 
+    /**
+     * Returns the region name
+     *
+     * @return string
+     */
     public function getName()
     {
         return $this->name;
     }
 
+    /**
+     * Returns the region short name.
+     *
+     * @return string
+     */
     public function getCode()
     {
         return $this->code;
     }
 
+    /**
+     * Returns a string with the region name.
+     *
+     * @return array
+     */
     public function toString()
     {
         return $this->getName();

src/Geocoder/ProviderAggregator.php

@@ -96,7 +96,7 @@ public function getLimit()
      *
      * @param Provider $provider
      *
-     * @return ProviderBasedGeocoder
+     * @return ProviderAggregator
      */
     public function registerProvider(Provider $provider)
     {
@@ -112,7 +112,7 @@ public function registerProvider(Provider $provider)
      *
      * @param Provider[] $providers
      *
-     * @return ProviderBasedGeocoder
+     * @return ProviderAggregator
      */
     public function registerProviders(array $providers = [])
     {
@@ -128,7 +128,7 @@ public function registerProviders(array $providers = [])
      *
      * @param string $name
      *
-     * @return ProviderBasedGeocoder
+     * @return ProviderAggregator
      */
     public function using($name)
     {