small phpdoc improvements

Author: flack

src/Provider/DeProvider.php

@@ -11,6 +11,10 @@
 
 class DeProvider implements Provider
 {
+    /**
+     * {@inheritDoc}
+     * @see \OpenPsa\Ranger\Provider\Provider::modifySeparator()
+     */
     public function modifySeparator(IntlDateFormatter $intl, $best_match, $separator)
     {
         if (   $best_match < Ranger::YEAR

src/Provider/DefaultProvider.php

@@ -11,6 +11,10 @@
 
 class DefaultProvider implements Provider
 {
+    /**
+     * {@inheritDoc}
+     * @see \OpenPsa\Ranger\Provider\Provider::modifySeparator()
+     */
     public function modifySeparator(IntlDateFormatter $intl, $best_match, $separator)
     {
         if (   $best_match != Ranger::MONTH

src/Provider/Provider.php

@@ -15,6 +15,7 @@ interface Provider
      * @param IntlDateFormatter $intl
      * @param int $best_match
      * @param string $separator
+     * @return string
      */
     public function modifySeparator(IntlDateFormatter $intl, $best_match, $separator);
 }

src/Ranger.php

@@ -28,6 +28,9 @@ class Ranger
     const TIMEZONE = -1;
     const NO_MATCH = -2;
 
+    /**
+     * @var array
+     */
     private $pattern_characters = [
         'G' => self::ERA,
         'y' => self::YEAR,
@@ -116,7 +119,7 @@ public function __construct($locale)
     }
 
     /**
-     * @param int $type
+     * @param int $type One of the IntlDateFormatter constants
      * @return self
      */
     public function setDateType($type)
@@ -130,7 +133,7 @@ public function setDateType($type)
     }
 
     /**
-     * @param int $type
+     * @param int $type One of the IntlDateFormatter constants
      * @return self
      */
     public function setTimeType($type)
@@ -247,6 +250,7 @@ private function prepare_date($input)
 
     /**
      * @param int $best_match
+     * @return string
      */
     private function get_range_separator($best_match)
     {
@@ -377,10 +381,10 @@ private function parse_pattern()
         $esc_active = false;
         $part = ['content' => '', 'delimiter' => false];
         foreach (str_split($pattern) as $char) {
-            //@todo the esc char handling is untested
             if ($char == $this->escape_character) {
                 if ($esc_active) {
                     $esc_active = false;
+                    // @todo the esc char handling is untested
                     if ($part['content'] === '') {
                         //Literal '
                         $part['content'] = $char;