Merge pull request #34 from kesar/typos_and_doc

fixed documentation + typo

src/Valitron/Validator.php

@@ -41,7 +41,7 @@ class Validator
             }
         }
 
-        // set lang in the follow order: constructor param, static::$_lang, defaul to en
+        // set lang in the follow order: constructor param, static::$_lang, default to en
         $lang = $lang ?: static::lang();
         // set langDir in the follow order: constructor param, static::$_langDir, default to package lang dir
         $langDir = $langDir ?: static::langDir();
@@ -79,6 +79,10 @@ class Validator
 
     /**
      * Required field validator
+     *
+     * @param $field
+     * @param $value
+     * @return bool
      */
     protected function validateRequired($field, $value)
     {
@@ -95,8 +99,9 @@ class Validator
      *
      * @param  string $field
      * @param  mixed $value
-     * @param  array   $fields
+     * @param array $params
-     * @return void
+     * @internal param array $fields
+     * @return bool
      */
     protected function validateEquals($field, $value, array $params)
     {
@@ -109,7 +114,8 @@ class Validator
      *
      * @param  string $field
      * @param  mixed $value
-     * @param  array   $fields
+     * @param array $params
+     * @internal param array $fields
      * @return bool
      */
     protected function validateDifferent($field, $value, array $params)
@@ -162,7 +168,8 @@ class Validator
      *
      * @param  string $field
      * @param  mixed $value
-     * @param  array   $fields
+     * @param $params
+     * @internal param array $fields
      * @return bool
      */
     protected function validateLength($field, $value, $params)
@@ -195,7 +202,8 @@ class Validator
      *
      * @param  string $field
      * @param  mixed $value
-     * @param  array   $fields
+     * @param $params
+     * @internal param array $fields
      * @return bool
      */
     protected function validateMin($field, $value, $params)
@@ -208,7 +216,8 @@ class Validator
      *
      * @param  string $field
      * @param  mixed $value
-     * @param  array   $fields
+     * @param $params
+     * @internal param array $fields
      * @return bool
      */
     protected function validateMax($field, $value, $params)
@@ -221,7 +230,8 @@ class Validator
      *
      * @param  string $field
      * @param  mixed $value
-     * @param  array   $fields
+     * @param $params
+     * @internal param array $fields
      * @return bool
      */
     protected function validateIn($field, $value, $params)
@@ -238,7 +248,8 @@ class Validator
      *
      * @param  string $field
      * @param  mixed $value
-     * @param  array   $fields
+     * @param $params
+     * @internal param array $fields
      * @return bool
      */
     protected function validateNotIn($field, $value, $params)
@@ -366,6 +377,7 @@ class Validator
      *
      * @param  string $field
      * @param  mixed $value
+     * @param $params
      * @return bool
      */
     protected function validateRegex($field, $value, $params)
@@ -390,7 +402,8 @@ class Validator
      *
      * @param  string $field
      * @param  mixed $value
-     * @param  array   $fields
+     * @param $params
+     * @internal param array $fields
      * @return bool
      */
     protected function validateDateFormat($field, $value, $params)
@@ -405,7 +418,8 @@ class Validator
      *
      * @param  string $field
      * @param  mixed $value
-     * @param  array   $fields
+     * @param $params
+     * @internal param array $fields
      * @return bool
      */
     protected function validateDateBefore($field, $value, $params)
@@ -420,7 +434,8 @@ class Validator
      *
      * @param  string $field
      * @param  mixed $value
-     * @param  array   $fields
+     * @param $params
+     * @internal param array $fields
      * @return bool
      */
     protected function validateDateAfter($field, $value, $params)
@@ -452,6 +467,9 @@ class Validator
 
     /**
      * Get array of error messages
+     *
+     * @param null|string $field
+     * @return array|bool
      */
     public function errors($field = null)
     {
@@ -463,6 +481,10 @@ class Validator
 
     /**
      * Add an error to error messages array
+     *
+     * @param $field
+     * @param $msg
+     * @param array $params
      */
     public function error($field, $msg, array $params = array())
     {
@@ -489,6 +511,9 @@ class Validator
 
     /**
      * Specify validation message to use for error for the last validation rule
+     *
+     * @param string $msg
+     * @return $this
      */
     public function message($msg)
     {
@@ -558,6 +583,11 @@ class Validator
 
     /**
      * Register new validation rule callback
+     *
+     * @param string $name
+     * @param $callback
+     * @param string $message
+     * @throws \InvalidArgumentException
      */
     public static function addRule($name, $callback, $message = self::ERROR_DEFAULT)
     {
@@ -597,7 +627,8 @@ class Validator
     }
 
     /**
-     * @param array $labels
+     * @param $value
+     * @internal param array $labels
      * @return $this
      */
     public function label($value)
@@ -620,6 +651,8 @@ class Validator
 
     /**
      * @param $field
+     * @param $msg
+     * @param $params
      * @return array
      */
     private function checkAndSetLabel($field, $msg, $params)
@@ -645,6 +678,7 @@ class Validator
 
     /**
      * Convenience method to add multiple validation rules with an array
+     * @param array $rules
      */
     public function rules($rules)
     {