Document types in public methods

Author: BenMorel

src/PhoneNumberDesc.php

@@ -39,21 +39,24 @@ public function clear()
     }
 
     /**
-     * @return array
+     * @return int[]
      */
     public function getPossibleLength()
     {
         return $this->possibleLength;
     }
 
     /**
-     * @param array $possibleLength
+     * @param int[] $possibleLength
      */
     public function setPossibleLength($possibleLength)
     {
         $this->possibleLength = $possibleLength;
     }
 
+    /**
+     * @param int $possibleLength
+     */
     public function addPossibleLength($possibleLength)
     {
         if (!in_array($possibleLength, $this->possibleLength)) {
@@ -67,21 +70,24 @@ public function clearPossibleLength()
     }
 
     /**
-     * @return array
+     * @return int[]
      */
     public function getPossibleLengthLocalOnly()
     {
         return $this->possibleLengthLocalOnly;
     }
 
     /**
-     * @param array $possibleLengthLocalOnly
+     * @param int[] $possibleLengthLocalOnly
      */
     public function setPossibleLengthLocalOnly($possibleLengthLocalOnly)
     {
         $this->possibleLengthLocalOnly = $possibleLengthLocalOnly;
     }
 
+    /**
+     * @param int $possibleLengthLocalOnly
+     */
     public function addPossibleLengthLocalOnly($possibleLengthLocalOnly)
     {
         if (!in_array($possibleLengthLocalOnly, $this->possibleLengthLocalOnly)) {

src/PhoneNumberUtil.php

@@ -711,7 +711,7 @@ public static function formattingRuleHasFirstGroupOnly($nationalPrefixFormatting
     /**
      * Returns all regions the library has metadata for.
      *
-     * @return array An unordered array of the two-letter region codes for every geographical region the
+     * @return string[] An unordered array of the two-letter region codes for every geographical region the
      *  library supports
      */
     public function getSupportedRegions()
@@ -722,7 +722,7 @@ public function getSupportedRegions()
     /**
      * Returns all global network calling codes the library has metadata for.
      *
-     * @return array An unordered array of the country calling codes for every non-geographical entity
+     * @return int[] An unordered array of the country calling codes for every non-geographical entity
      *  the library supports
      */
     public function getSupportedGlobalNetworkCallingCodes()
@@ -736,7 +736,7 @@ public function getSupportedGlobalNetworkCallingCodes()
      * used to populate a drop-down box of country calling codes for a phone-number widget, for
      * instance.
      *
-     * @return array An unordered array of the country calling codes for every geographical and
+     * @return int[] An unordered array of the country calling codes for every geographical and
      *      non-geographical entity the library supports
      */
     public function getSupportedCallingCodes()
@@ -804,7 +804,7 @@ private function getSupportedTypesForMetadata(PhoneMetadata $metadata)
      * No types will be returned for invalid or unknown region codes.
      *
      * @param string $regionCode
-     * @return array
+     * @return (PhoneNumberType::*)[]
      */
     public function getSupportedTypesForRegion($regionCode)
     {
@@ -822,7 +822,7 @@ public function getSupportedTypesForRegion($regionCode)
      * present) and UNKNOWN.
      *
      * @param int $countryCallingCode
-     * @return array
+     * @return (PhoneNumberType::*)[]
      */
     public function getSupportedTypesForNonGeoEntity($countryCallingCode)
     {
@@ -2447,7 +2447,7 @@ protected function testNumberLength($number, PhoneMetadata $metadata, $type = Ph
      * non-geographical country calling codes, the region code 001 is returned. Also, in the case
      * of no region code being found, an empty list is returned.
      * @param int $countryCallingCode
-     * @return array
+     * @return string[]
      */
     public function getRegionCodesForCountryCode($countryCallingCode)
     {
@@ -3190,7 +3190,7 @@ public function parse($numberToParse, $defaultRegion = null, ?PhoneNumber $phone
      *
      * @param PhoneNumber $number the phone number to be formatted
      * @param int $numberFormat the format the phone number should be formatted into
-     * @param array $userDefinedFormats formatting rules specified by clients
+     * @param NumberFormat[] $userDefinedFormats formatting rules specified by clients
      * @return String the formatted phone number
      */
     public function formatByPattern(PhoneNumber $number, $numberFormat, array $userDefinedFormats)

src/ShortNumberInfo.php

@@ -70,7 +70,7 @@ public static function resetInstance()
      * of no region code being found, an empty list is returned.
      *
      * @param int $countryCallingCode
-     * @return array
+     * @return string[]
      */
     protected function getRegionCodesForCountryCode($countryCallingCode)
     {