Skip to content

Commit d95e50e

Browse files
committed
Fix various phpdoc issues
1 parent f04c095 commit d95e50e

File tree

12 files changed

+37
-6
lines changed

12 files changed

+37
-6
lines changed

src/Geocoder/Exception/FunctionNotFound.php

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,10 @@
1515
*/
1616
class FunctionNotFound extends \RuntimeException implements Exception
1717
{
18+
/**
19+
* @param string $functionName
20+
* @param string $description
21+
*/
1822
public function __construct($functionName, $description = null)
1923
{
2024
parent::__construct(sprintf('The function "%s" cannot be found.%s',

src/Geocoder/Exception/ProviderNotRegistered.php

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,9 @@
1515
*/
1616
class ProviderNotRegistered extends \RuntimeException implements Exception
1717
{
18+
/**
19+
* @param string $providerName
20+
*/
1821
public function __construct($providerName, array $registeredProviders = [])
1922
{
2023
parent::__construct(sprintf(

src/Geocoder/Model/Address.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -179,7 +179,7 @@ public function getSubLocality()
179179
/**
180180
* Returns the county value.
181181
*
182-
* @return string
182+
* @return County
183183
*/
184184
public function getCounty()
185185
{

src/Geocoder/Model/AddressFactory.php

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,11 +55,17 @@ public function createFromArray(array $results)
5555
return $addresses;
5656
}
5757

58+
/**
59+
* @param string $key
60+
*/
5861
private function readDoubleValue(array $data, $key)
5962
{
6063
return (double) \igorw\get_in($data, explode('.', $key));
6164
}
6265

66+
/**
67+
* @param string $key
68+
*/
6369
private function readStringValue(array $data, $key)
6470
{
6571
return $this->formatString(\igorw\get_in($data, [ $key ]));

src/Geocoder/Model/Bounds.php

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,12 @@ final class Bounds
2323

2424
private $east;
2525

26+
/**
27+
* @param double $south
28+
* @param double $west
29+
* @param double $north
30+
* @param double $east
31+
*/
2632
public function __construct($south, $west, $north, $east)
2733
{
2834
$this->south = $south;

src/Geocoder/Model/Coordinates.php

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,10 @@ final class Coordinates
1919

2020
private $longitude;
2121

22+
/**
23+
* @param double $latitude
24+
* @param double $longitude
25+
*/
2226
public function __construct($latitude, $longitude)
2327
{
2428
$this->latitude = $latitude;

src/Geocoder/Model/Country.php

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,9 @@ final class Country
1919

2020
private $code;
2121

22+
/**
23+
* @param string $code
24+
*/
2225
public function __construct($name, $code)
2326
{
2427
$this->name = $name;

src/Geocoder/Model/County.php

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,9 @@ final class County
1919

2020
private $code;
2121

22+
/**
23+
* @param string $code
24+
*/
2225
public function __construct($name, $code)
2326
{
2427
$this->name = $name;

src/Geocoder/Model/Region.php

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,9 @@ final class Region
1919

2020
private $code;
2121

22+
/**
23+
* @param string $code
24+
*/
2225
public function __construct($name, $code)
2326
{
2427
$this->name = $name;

src/Geocoder/Provider/MaxMindProvider.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@ public function getName()
170170
*
171171
* @param string $service
172172
*
173-
* @return array
173+
* @return string[]
174174
*/
175175
private function fieldsForService($service)
176176
{

0 commit comments

Comments
 (0)