refactor(docblocks): document public apis/methods

adhocore · adhocore · commit d73a07807ba2 · 2018-08-15T23:22:07.000+07:00
diff --git a/src/Validator.php b/src/Validator.php
@@ -20,13 +20,29 @@
  */
 class Validator
 {
+    /**
+     * Check if the value is in range of given offset.
+     *
+     * @param int    $value
+     * @param string $offset
+     *
+     * @return bool
+     */
     public function inRange($value, $offset)
     {
         $parts = \explode('-', $offset);
 
         return $parts[0] <= $value && $value <= $parts[1];
     }
 
+    /**
+     * Check if the value is in step of given offset.
+     *
+     * @param int    $value
+     * @param string $offset
+     *
+     * @return bool
+     */
     public function inStep($value, $offset)
     {
         $parts = \explode('/', $offset, 2);
@@ -45,6 +61,16 @@ public function inStep($value, $offset)
         return $this->inStepRange($value, $subparts[0], $subparts[1], $parts[1]);
     }
 
+    /**
+     * Check if the value falls between start and end when advanved by step.
+     *
+     * @param int $value
+     * @param int $start
+     * @param int $end
+     * @param int $step
+     *
+     * @return bool
+     */
     public function inStepRange($value, $start, $end, $step)
     {
         if (($start + $step) > $end) {
