Update inline documentation

Author: populov

src/DatabaseRuleSet.php

@@ -26,8 +26,8 @@ public function __construct(array $rules = [])
     /**
      * Get a exists constraint builder instance.
      *
-     * @param  string $table
-     * @param  string $column
+     * @param  string $table Table in database, in which lookup should be performed
+     * @param  string $column Column in table, in which lookup should be performed
      * @param \Closure|null $callback callback, that will receive \Illuminate\Validation\Rules\Exists $rule
      * @return GenericRuleSet
      * @see \Illuminate\Validation\Rules\Exists
@@ -44,8 +44,8 @@ public function exists(string $table, string $column = 'NULL', \Closure $callbac
     /**
      * Get a unique constraint builder instance.
      *
-     * @param  string $table
-     * @param  string $column
+     * @param  string $table Table in database, in which lookup should be performed
+     * @param  string $column Column in table, in which lookup should be performed
      * @param \Closure|null $callback callback, that will receive \Illuminate\Validation\Rules\Unique $rule
      * @return GenericRuleSet
      */

src/DateRuleSet.php

@@ -34,7 +34,7 @@ public function __construct(array $rules = [])
      *
      * 'finish_date' => 'required|date|after:start_date'
      *
-     * @param Carbon|string $date
+     * @param Carbon|string $date Value must be after this date
      * @return $this|static
      */
     public function after($date)
@@ -47,7 +47,7 @@ public function after($date)
      * For more information, see the after rule.
      *
      * @see after
-     * @param Carbon|string $date
+     * @param Carbon|string $date Value must be after or equal this date
      * @return $this|static
      */
     public function afterOrEqual($date)
@@ -59,7 +59,7 @@ public function afterOrEqual($date)
      * The field under validation must be a value preceding the given date.
      * The dates will be passed into the PHP strtotime function.
      *
-     * @param Carbon|string $date
+     * @param Carbon|string $date Value must be preceding this date
      * @return $this|static
      */
     public function before($date)
@@ -71,7 +71,7 @@ public function before($date)
      * The field under validation must be a value preceding or equal to the given date.
      * The dates will be passed into the PHP strtotime function.
      *
-     * @param Carbon|string $date
+     * @param Carbon|string $date Value must be before or equal this date
      * @return $this|static
      */
     public function beforeOrEqual($date)

src/FileRuleSet.php

@@ -23,7 +23,9 @@ public function __construct(array $rules = [])
     }
 
     /**
-     * @param array|\Closure $constraints
+     * Field under validation must contain image
+     *
+     * @param array|\Closure $constraints Image dimensions constraints
      * @return ImageRuleSet
      */
     public function image($constraints = []): ImageRuleSet
@@ -35,7 +37,7 @@ public function image($constraints = []): ImageRuleSet
      * The file under validation must match one of the given MIME types
      * To determine the MIME type of the uploaded file, the file's contents will be read and the framework will attempt to guess the MIME type, which may be different from the client provided MIME type.
      *
-     * @param \string[] ...$types
+     * @param \string[] ...$types List of allowed MIME types
      * @return $this|static
      */
     public function mimetypes(string ...$types)
@@ -54,7 +56,7 @@ public function mimetypes(string ...$types)
      * A full listing of MIME types and their corresponding extensions may be found at the following location:
      * https://svn.apache.org/repos/asf/httpd/httpd/trunk/docs/conf/mime.types
      *
-     * @param \string[] ...$extensions
+     * @param \string[] ...$extensions List of allowed file extensions
      * @return $this|static
      */
     public function mimes(string ...$extensions)

src/FluentValidatorFactory.php

@@ -10,7 +10,15 @@
  */
 class FluentValidatorFactory extends LaravelValidatorFactory
 {
-    /** @inheritdoc */
+    /**
+     * Create a new Validator instance.
+     *
+     * @param  array  $data Input data to validate
+     * @param  array  $rules Set of validation rules
+     * @param  array  $messages Custom messages for validation rules
+     * @param  array  $customAttributes Human-readable attribute names for validated attributes
+     * @return \Illuminate\Validation\Validator
+     */
     public function make(array $data, array $rules, array $messages = [], array $customAttributes = [])
     {
         $rules = array_map(function ($rule) {

src/GenericRuleSet.php

@@ -38,7 +38,7 @@
  */
 class GenericRuleSet extends RuleSet
 {
-    const EXPOSED_RULES = ['int', 'numeric', 'string'];
+    const EXPOSED_RULES = ['int', 'numeric', 'string', 'boolean', 'date', 'file'];
 
     /**
      * The field under validation must be an integer.
@@ -100,7 +100,7 @@ public function file(): FileRuleSet
         return new FileRuleSet($this->rules);
     }
 
-    public function __call($name, $arguments)
+    public function __call(string $name, array $arguments)
     {
         $ruleSet = null;
         if (in_array($name, StringRuleSet::EXPOSED_RULES)) {

src/ImageRuleSet.php

@@ -9,6 +9,8 @@
  * Image validation rules. In addition to file validation has image dimensions rules
  * (width, height, ratio of width and height).
  *
+ * @see https://laravel.com/docs/5.5/validation#rule-dimensions
+ *
  * @method ImageRuleSet width(int $width)
  * @method ImageRuleSet height(int $height)
  * @method ImageRuleSet minWidth(int $width)
@@ -18,14 +20,21 @@
  */
 class ImageRuleSet extends FileRuleSet
 {
-    /** @var  Dimensions */
+    /**
+     * Expected image dimensions
+     *
+     * @var Dimensions
+     */
     protected $dimensions;
 
     /**
-     * ImageRuleSet constructor.
+     * Image validation rules. In addition to file validation has image dimensions rules
+     * (width, height, ratio of width and height).
+     *
+     * @see https://laravel.com/docs/5.5/validation#rule-dimensions
      *
-     * @param array|\Closure|Dimensions $constraints
-     * @param array $rules
+     * @param array $rules Additional validation rules
+     * @param mixed|array|\Closure|Dimensions $constraints Image dimension constraints
      */
     public function __construct(array $rules = [], $constraints = [])
     {
@@ -43,7 +52,7 @@ public function file()
         return $this->appendIfNotExists('file');
     }
 
-    public function __call($name, $arguments)
+    public function __call(string $name, array $arguments)
     {
         if (in_array($name, ['width', 'height', 'minWidth', 'minHeight', 'maxWidth', 'maxHeight', 'ratio'])) {
             if ($this->dimensions == null) {
@@ -56,8 +65,11 @@ public function __call($name, $arguments)
     }
 
     /**
-     * @param array|\Closure|Dimensions $constraints
+     * Image dimension constraints
+     *
+     * @param array|\Closure|Dimensions $constraints Image dimensions constraints
      * @return $this
+     * @see \Illuminate\Validation\Rules\Dimensions
      */
     public function dimensions($constraints)
     {

src/NumericRuleSet.php

@@ -19,22 +19,22 @@ public function __construct(array $rules = [])
     /**
      * The field under validation must be numeric and must have an exact length of value.
      *
+     * @param int $length Expected number of digits
      * @return NumericRuleSet
-     * @param int $length
      */
-    public function digits($length): NumericRuleSet
+    public function digits(int $length): NumericRuleSet
     {
         return $this->appendIfNotExists("digits:$length");
     }
 
     /**
      * The field under validation must have a length between the given min and max.
      *
-     * @param $minLength
-     * @param $maxLength
+     * @param int $minLength Minimum number of digits
+     * @param int $maxLength Maximum number of digits
      * @return NumericRuleSet
      */
-    public function digitsBetween($minLength, $maxLength): NumericRuleSet
+    public function digitsBetween(int $minLength, int $maxLength): NumericRuleSet
     {
         return $this->appendIfNotExists("digits_between:$minLength,$maxLength");
     }

src/PhoneRuleSet.php

@@ -24,14 +24,16 @@
 class PhoneRuleSet extends StringRuleSet
 {
     /**
+     * Phone validation rule
+     *
      * @var Phone
      */
     protected $rule;
 
     /**
      * PhoneRuleSet constructor.
      *
-     * @param array $rules
+     * @param array $rules Set of rules to merge with
      */
     public function __construct(array $rules = [])
     {
@@ -49,7 +51,7 @@ public function __construct(array $rules = [])
         }
     }
 
-    public function __call($name, $arguments)
+    public function __call(string $name, array $arguments)
     {
         if (method_exists($this->rule, $name)) {
             call_user_func_array([$this->rule, $name], $arguments);

src/RequiredRules.php

@@ -25,7 +25,7 @@ public function required()
     /**
      * The field under validation must be present and not empty only if any of the other specified fields are present.
      *
-     * @param \string[] $otherFields
+     * @param \string[] $otherFields Field is required, if any of these fields present
      * @return static
      */
     public function requiredWith(string ...$otherFields)
@@ -36,7 +36,7 @@ public function requiredWith(string ...$otherFields)
     /**
      * The field under validation must be present and not empty only if all of the other specified fields are present.
      *
-     * @param \string[] ...$otherFields
+     * @param \string[] ...$otherFields Field is required, if all of these fields present
      * @return static
      */
     public function requiredWithAll(string ...$otherFields)
@@ -47,7 +47,7 @@ public function requiredWithAll(string ...$otherFields)
     /**
      * The field under validation must be present and not empty only when any of the other specified fields are not present.
      *
-     * @param \string[] ...$otherFields
+     * @param \string[] ...$otherFields Field is required, if any of these fields is absent
      * @return static
      */
     public function requiredWithout(string ...$otherFields)
@@ -58,7 +58,7 @@ public function requiredWithout(string ...$otherFields)
     /**
      * The field under validation must be present and not empty only when all of the other specified fields are not present.
      *
-     * @param \string[] ...$otherFields
+     * @param \string[] ...$otherFields Field is required, if all of these fields absent
      * @return static
      */
     public function requiredWithoutAll(string ...$otherFields)
@@ -69,8 +69,8 @@ public function requiredWithoutAll(string ...$otherFields)
     /**
      * The field under validation must be present and not empty if the anotherField field is equal to any value.
      *
-     * @param string $anotherField
-     * @param mixed $value
+     * @param string $anotherField Field name to compare with
+     * @param mixed $value Value of another field to compare with
      * @return static
      */
     public function requiredIf(string $anotherField, $value)
@@ -81,8 +81,8 @@ public function requiredIf(string $anotherField, $value)
     /**
      * The field under validation must be present and not empty unless the anotherField field is equal to any value.
      *
-     * @param string $anotherField
-     * @param mixed $value
+     * @param string $anotherField Field to compare with
+     * @param mixed $value Value of another field to compare with
      * @return static
      */
     public function requiredUnless(string $anotherField, $value)

src/Rule.php

@@ -132,7 +132,8 @@ public static function date(): DateRuleSet
     /**
      * The file under validation must be an image (jpeg, png, bmp, gif, or svg)
      *
-     * @param array|\Closure|\Illuminate\Validation\Rules\Dimensions $constraints
+     * @param array|\Closure|\Illuminate\Validation\Rules\Dimensions $constraints Image constraints
+     * @see https://laravel.com/docs/5.5/validation#rule-dimensions
      * @return ImageRuleSet
      */
     public static function image($constraints = []): ImageRuleSet