Standard for "See also:" on documentation

CONTRIBUTING.md

@@ -156,7 +156,6 @@ $ vendor/bin/php-cs-fixer fix
 ```
 
 ***
-
 See also:
 
 - [Feature Guide](docs/README.md)

LICENSE.md

@@ -30,7 +30,6 @@ ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 ***
-
 See also:
 
 - [Contributing](CONTRIBUTING.md)

docs/Age.md

@@ -37,6 +37,7 @@ v::age(null, 70)->validate('71 years ago'); //false
 
 Message template for this validator includes `{{minAge}}` and `{{maxAge}}`.
 
+***
 See also:
 
   * [Between](Between.md)

docs/AllOf.md

@@ -22,6 +22,7 @@ v::allOf(
  ->validate(15); //true
 ```
 
+***
 See also:
 
   * [OneOf](OneOf.md)

docs/Alnum.md

@@ -39,6 +39,7 @@ v::alnum()->uppercase()->validate('aaa'); //false
 Message template for this validator includes `{{additionalChars}}` as
 the string of extra chars passed as the parameter.
 
+***
 See also:
 
   * [Alpha](Alpha.md)

docs/Alpha.md

@@ -7,6 +7,7 @@ This is similar to v::alnum(), but it doesn't allow numbers. It also
 accepts empty values and whitespace, so use `v::notEmpty()` and
 `v::noWhitespace()` when appropriate.
 
+***
 See also:
 
   * [Alnum](Alnum.md)

docs/AlwaysInvalid.md

@@ -8,6 +8,7 @@ Always return false.
 v::alwaysInvalid()->validate($whatever); //false
 ```
 
+***
 See also:
 
   * [AlwaysValid](AlwaysValid.md)

docs/AlwaysValid.md

@@ -8,6 +8,7 @@ Always returns true.
 v::alwaysValid()->validate($whatever); //true
 ```
 
+***
 See also:
 
   * [AlwaysInvalid](AlwaysInvalid.md)

docs/Arr.md

@@ -9,6 +9,7 @@ v::arr()->validate(array()); //true
 v::arr()->validate(new ArrayObject); //true
 ```
 
+***
 See also:
 
   * [Each](Each.md)

docs/Attribute.md

@@ -27,6 +27,7 @@ v::attribute('lorem', v::string(), false)->validate($obj); // true
 
 The name of this validator is automatically set to the attribute name.
 
+***
 See also:
 
   * [Key](Key.md)

docs/Bank.md

@@ -13,7 +13,8 @@ These country codes are supported:
 
  * "de" (Germany) - You must add `"malkusch/bav": "~1.0"` to your `require` property on composer.json file.
 
-See also
+***
+See also:
 
   * [BankAccount](BankAccount.md)
   * [Bic](Bic.md)

docs/BankAccount.md

@@ -13,7 +13,8 @@ These country codes are supported:
 
  * "de" (Germany) - You must add `"malkusch/bav": "~1.0"` to your `require` property on composer.json file.
 
-See also
+***
+See also:
 
   * [Bank](Bank.md)
   * [Bic](Bic.md)

docs/Between.md

@@ -36,6 +36,7 @@ v::date()->between(10, 20, true)->validate(20); //true
 
 Message template for this validator includes `{{minValue}}` and `{{maxValue}}`.
 
+***
 See also:
 
   * [Length](Length.md)

docs/Bic.md

@@ -13,7 +13,8 @@ Theses country codes are supported:
 
  * "de" (Germany) - You must add `"malkusch/bav": "~1.0"` to your `require` property on composer.json file.
 
-See also
+***
+See also:
 
   * [Bank](Bank.md)
   * [BankAccount](BankAccount.md)

docs/Call.md

@@ -45,6 +45,7 @@ v::call(array($myObj, 'methodName'), v::int())->validate($myInput);
 v::call(function($input) {}, v::int())->validate($myInput);
 ```
 
+***
 See also:
 
   * [Callback](Callback.md)

docs/CallableType.md

@@ -10,6 +10,7 @@ v::callableType()->validate('trim'); //true
 v::callableType()->validate(array(new Object, 'methodName')); //true
 ```
 
+***
 See also:
 
   * [Callback](Callback.md)

docs/Callback.md

@@ -13,6 +13,7 @@ v::callback('is_int')->validate(10); //true
 
 As in `v::call()`, you can pass a method or closure to it.
 
+***
 See also:
 
   * [Call](Call.md)

docs/Cnh.md

@@ -8,6 +8,7 @@ Validates a Brazillian driver's license.
 v::cnh()->validate('02650306461'); //true
 ```
 
+***
 See also:
 
   * [Cnpj](Cnpj.md)

docs/Cnpj.md

@@ -5,6 +5,7 @@
 Validates the Brazillian CNPJ number. Ignores non-digit chars, so
 use `->digit()` if needed.
 
+***
 See also:
 
   * [Cpf](Cpf.md)

docs/Cntrl.md

@@ -9,6 +9,7 @@ This is similar to `v::alnum()`, but only accepts control characters:
 v::cntrl()->validate("\n\r\t"); //true
 ```
 
+***
 See also:
 
   * [Alnum](Alnum.md)

docs/Consonant.md

@@ -9,6 +9,7 @@ Similar to `v::alnum()`. Validates strings that contain only consonants:
 v::consonant()->validate('xkcd'); //true
 ```
 
+***
 See also:
 
   * [Alnum](Alnum.md)

docs/Contains.md

@@ -20,6 +20,7 @@ of equal comparison.
 
 Message template for this validator includes `{{containsValue}}`.
 
+***
 See also:
 
   * [StartsWith](StartsWith.md)

docs/CountryCode.md

@@ -8,6 +8,7 @@ Validates an ISO country code like US or BR.
 v::countryCode()->validate('BR'); //true
 ```
 
+***
 See also:
 
   * [Tld](Tld.md)

docs/Cpf.md

@@ -21,6 +21,7 @@ the chain:
 v::digit()->cpf()->validate('44455566820'); //true
 ```
 
+***
 See also:
 
   * [Cnpj](Cnpj.md)

docs/Date.md

@@ -31,6 +31,7 @@ Format has no effect when validating DateTime instances.
 
 Message template for this validator includes `{{format}}`.
 
+***
 See also:
 
   * [Between](Between.md)

docs/Digit.md

@@ -6,6 +6,7 @@ This is similar to v::alnum(), but it doesn't allow a-Z. It also
 accepts empty values and whitespace, so use `v::notEmpty()` and
 `v::noWhitespace()` when appropriate.
 
+***
 See also:
 
   * [Alnum](Alnum.md)

docs/Directory.md

@@ -15,7 +15,8 @@ This validator will consider SplFileInfo instances, so you can do something like
 v::directory()->validate(new \SplFileInfo($directory));
 ```
 
-See also
+***
+See also:
 
   * [Exists](Exists.md)
   * [File](File.md)

docs/Domain.md

@@ -29,6 +29,7 @@ internally:
 
 Messages for this validator will reflect rules above.
 
+***
 See also:
 
   * [Tld](Tld.md)

docs/Each.md

@@ -20,6 +20,7 @@ v::arr()->each(v::date(), v::string()->lowercase())->validate($releaseDates); //
 
 Using `arr()` before `each()` is a best practice.
 
+***
 See also:
 
   * [Key](Key.md)

docs/EndsWith.md

@@ -23,6 +23,7 @@ of equal comparison.
 
 Message template for this validator includes `{{endValue}}`.
 
+***
 See also:
 
   * [StartsWith](StartsWith.md)

docs/Equals.md

@@ -18,6 +18,7 @@ v::equals(10, true)->validate('10'); //false
 
 Message template for this validator includes `{{compareTo}}`.
 
+***
 See also:
 
   * [Contains](Contains.md)

docs/Even.md

@@ -10,7 +10,8 @@ v::int()->even()->validate(2); //true
 
 Using `int()` before `even()` is a best practice.
 
-See also
+***
+See also:
 
   * [Odd](Odd.md)
   * [Multiple](Multiple.md)

docs/Executable.md

@@ -8,7 +8,8 @@ Validates if a file is an executable.
 v::email()->executable('script.sh'); //true
 ```
 
-See also
+***
+See also:
 
   * [Readable](Readable.md)
   * [Writable](Writable.md)

docs/Exists.md

@@ -15,7 +15,8 @@ This validator will consider SplFileInfo instances, so you can do something like
 v::exists()->validate(new \SplFileInfo($file));
 ```
 
-See also
+***
+See also:
 
   * [Directory](Directory.md)
   * [File](File.md)

docs/Extension.md

@@ -10,6 +10,7 @@ v::extension('png')->validate('image.png'); //true
 
 This rule is case-sensitive.
 
+***
 See also:
 
   * [Executable](Executable.md)

docs/False.md

@@ -13,6 +13,7 @@ v::false()->validate('off'); //true
 v::false()->validate('no'); //true
 ```
 
-See also
+***
+See also:
 
   * [True](True.md)

docs/File.md

@@ -15,7 +15,8 @@ This validator will consider SplFileInfo instances, so you can do something like
 v::file()->validate(new \SplFileInfo($file));
 ```
 
-See also
+***
+See also:
 
   * [Directory](Directory.md)
   * [Exists](Exists.md)

docs/FilterVar.md

@@ -10,6 +10,7 @@ v::filterVar(FILTER_VALIDATE_EMAIL)->validate('bob@example.com'); //true
 v::filterVar(FILTER_VALIDATE_URL, FILTER_FLAG_PATH_REQUIRED)->validate('http://example.com'); //true
 ```
 
-See also
+***
+See also:
 
   * [Callback](Callback.md)

docs/Finite.md

@@ -9,6 +9,7 @@ v::finite()->validate('10'); //true
 v::finite()->validate(10); //true
 ```
 
+***
 See also:
 
   * [Digit](Digit.md)

docs/Graph.md

@@ -9,6 +9,7 @@ Validates all characters that are graphically represented.
 v::graph()->validate('LKM@#$%4;'); //true
 ```
 
+***
 See also:
 
   * [Prnt](Prnt.md)

docs/HexRgbColor.md

@@ -10,6 +10,7 @@ v::hexRgbColor()->validate('123123'); //true
 v::hexRgbColor()->validate('FCD'); //true
 ```
 
+***
 See also:
 
   * [Vxdigit](Vxdigit.md)

docs/INSTALL.md

@@ -11,6 +11,7 @@ composer require respect/validation
 
 ***
 
+***
 See also:
 
 - [Contributing](../CONTRIBUTING.md)

docs/In.md

@@ -22,6 +22,7 @@ of equal comparison.
 
 Message template for this validator includes `{{haystack}}`.
 
+***
 See also:
 
   * [StartsWith](StartsWith.md)

docs/Infinite.md

@@ -8,6 +8,7 @@ Validates if the input is an infinite number.
 v::infinite()->validate(INF); //true
 ```
 
+***
 See also:
 
   * [Digit](Digit.md)

docs/Instance.md

@@ -11,6 +11,7 @@ v::instance('Traversable')->validate(new ArrayObject); //true
 
 Message template for this validator includes `{{instanceName}}`.
 
+***
 See also:
 
   * [Object](Object.md)

docs/Int.md

@@ -9,6 +9,7 @@ v::int()->validate('10'); //true
 v::int()->validate(10); //true
 ```
 
+***
 See also:
 
   * [Digit](Digit.md)

docs/Key.md

@@ -28,6 +28,7 @@ v::key('lorem', v::string(), false)->validate($dict); // true
 
 The name of this validator is automatically set to the key name.
 
+***
 See also:
 
   * [Attribute](Attribute.md)

docs/KeySet.md

@@ -45,6 +45,7 @@ v::keySet(
 
 The keys' order is not considered in the validation.
 
+***
 See also:
 
   * [Key](Key.md)

docs/LeapDate.md

@@ -11,6 +11,7 @@ v::leapDate('Y-m-d')->validate('1988-02-29'); //true
 This validator accepts DateTime instances as well. The $format
 parameter is mandatory.
 
+***
 See also:
 
   * [Date](Date.md)

docs/LeapYear.md

@@ -10,6 +10,7 @@ v::leapYear()->validate('1988'); //true
 
 This validator accepts DateTime instances as well.
 
+***
 See also:
 
   * [Date](Date.md)

docs/Length.md

@@ -38,6 +38,7 @@ v::string()->length(1, 5, true)->validate('a'); //true
 
 Message template for this validator includes `{{minValue}}` and `{{maxValue}}`.
 
+***
 See also:
 
   * [Between](Between.md)

docs/Lowercase.md

@@ -8,6 +8,7 @@ Validates if string characters are lowercase in the input:
 v::string()->lowercase()->validate('xkcd'); //true
 ```
 
+***
 See also:
 
   * [Uppercase](Uppercase.md)

docs/Max.md

@@ -29,6 +29,7 @@ values must be used.
 
 Message template for this validator includes `{{maxValue}}`.
 
+***
 See also:
 
   * [Min](Min.md)

docs/Mimetype.md

@@ -10,7 +10,8 @@ v::mimetype('image/png')->validate('image.png'); //true
 
 This rule is case-sensitive and requires [fileinfo](http://php.net/fileinfo) PHP extension.
 
-See also
+***
+See also:
 
   * [Executable](Executable.md)
   * [File](File.md)

docs/Min.md

@@ -22,6 +22,7 @@ values must be used.
 
 Message template for this validator includes `{{minValue}}`.
 
+***
 See also:
 
   * [Max](Max.md)

docs/MinimumAge.md

@@ -16,6 +16,7 @@ Using `date()` before is a best-practice.
 
 Message template for this validator includes `{{age}}`.
 
+***
 See also:
 
   * [Age](Age.md)

docs/Multiple.md

@@ -8,6 +8,7 @@ Validates if the input is a multiple of the given parameter
 v::int()->multiple(3)->validate(9); //true
 ```
 
+***
 See also:
 
   * [PrimeNumber](PrimeNumber.md)

docs/Negative.md

@@ -8,6 +8,7 @@ Validates if a number is lower than zero
 v::numeric()->negative()->validate(-15); //true
 ```
 
+***
 See also:
 
   * [Positive](Positive.md)

docs/No.md

@@ -18,6 +18,7 @@ This rule is case insensitive.
 
 If `$locale` is TRUE, uses the value of [nl_langinfo()](http://php.net/nl_langinfo) with `NOEXPR` constant.
 
+***
 See also:
 
   * [Yes](Yes.md)

docs/NoneOf.md

@@ -13,6 +13,7 @@ v::noneOf(
 
 In the sample above, 'foo' isn't a integer nor a float, so noneOf returns true.
 
+***
 See also:
 
   * [Not](Not.md)

docs/Not.md

@@ -30,6 +30,7 @@ v::int()->positive()->not()->validate(-1.5); //true
 
 Each other validation has custom messages for negated rules.
 
+***
 See also:
 
   * [NoneOf](NoneOf.md)

docs/NotEmpty.md

@@ -35,6 +35,7 @@ v::string()->notEmpty()->validate('        ');  //false
 v::string()->notEmpty()->validate("\t \n \r");  //false
 ```
 
+***
 See also:
 
   * [NoWhitespace](NoWhitespace.md)

docs/NullValue.md

@@ -8,6 +8,7 @@ Validates if the input is null. This rule does not allow empty strings to avoid
 v::nullValue()->validate(null); //true
 ```
 
+***
 See also:
 
   * [NotEmpty](NotEmpty.md)

docs/Numeric.md

@@ -9,6 +9,7 @@ v::numeric()->validate(-12); //true
 v::numeric()->validate('135.0'); //true
 ```
 
+***
 See also:
 
   * [Digit](Digit.md)

docs/Object.md

@@ -8,6 +8,7 @@ Validates if the input is an object.
 v::object()->validate(new stdClass); //true
 ```
 
+***
 See also:
 
   * [Instance](Instance.md)

docs/Odd.md

@@ -10,7 +10,8 @@ v::int()->odd()->validate(3); //true
 
 Using `int()` before `odd()` is a best practice.
 
-See also
+***
+See also:
 
   * [Even](Even.md)
   * [Multiple](Multiple.md)

docs/OneOf.md

@@ -23,6 +23,7 @@ Using a shortcut
 v::int()->addOr(v::float())->validate(15.5); //true
 ```
 
+***
 See also:
 
   * [AllOf](AllOf.md)

docs/Positive.md

@@ -8,6 +8,7 @@ Validates if a number is higher than zero
 v::numeric()->positive()->validate(-15); //false
 ```
 
+***
 See also:
 
   * [Negative](Negative.md)

docs/PostalCode.md

@@ -12,6 +12,7 @@ v::numeric()->postalCode('US')->validate('02179-000'); //false
 
 Extracted from [GeoNames](http://www.geonames.org/).
 
+***
 See also:
 
   * [CountryCode](CountryCode.md)

docs/Prnt.md

@@ -9,6 +9,7 @@ Similar to `v::graph` but accepts whitespace.
 v::prnt()->validate('LMKA0$% _123'); //true
 ```
 
+***
 See also:
 
   * [Graph](Graph.md)

docs/Punct.md

@@ -9,6 +9,7 @@ Accepts only punctuation characters:
 v::punct()->validate('&,.;[]'); //true
 ```
 
+***
 See also:
 
   * [Cntrl](Cntrl.md)

docs/README.md

@@ -211,7 +211,6 @@ Message:
 ```
 
 ***
-
 See also:
 
 - [Contributing](../CONTRIBUTING.md)

docs/Resource.md

@@ -8,6 +8,7 @@ Validates if the input is a resource.
 v::resource()->validate(fopen('/path/to/file.txt', 'w')); //true
 ```
 
+***
 See also:
 
   * [Type](Type.md)

docs/Scalar.md

@@ -9,6 +9,7 @@ v::scalar()->validate(array()); //false
 v::scalar()->validate(135.0); //true
 ```
 
+***
 See also:
 
   * [Type](Type.md)

docs/Sf.md

@@ -13,6 +13,7 @@ v::sf('Time')->validate('15:00:00');
 You must add `"symfony/validator": "~2.6"` to your `require` property on composer.json file.
 
 
+***
 See also:
 
   * [Zend](Zend.md)

docs/Size.md

@@ -33,6 +33,7 @@ v::size('1.5mb')->validate($fileInfo); // Will return true or false
 
 Message template for this validator includes `{{minSize}}` and `{{maxSize}}`.
 
+***
 See also:
 
   * [Executable](Executable.md)

docs/Space.md

@@ -9,6 +9,7 @@ Accepts only whitespace:
 v::space()->validate('    '); //true
 ```
 
+***
 See also:
 
   * [Cntrl](Cntrl.md)

docs/StartsWith.md

@@ -23,6 +23,7 @@ instead of equal.
 
 Message template for this validator includes `{{startValue}}`.
 
+***
 See also:
 
   * [EndsWith](EndsWith.md)

docs/String.md

@@ -8,6 +8,7 @@ Validates a string.
 v::string()->validate('hi'); //true
 ```
 
+***
 See also:
 
   * [Alnum](Alnum.md)

docs/Tld.md

@@ -10,7 +10,8 @@ v::tld()->validate('ly'); //true
 v::tld()->validate('org'); //true
 ```
 
-See also
+***
+See also:
 
  * [Domain](Domain.md)
  * [CountryCode](CountryCode.md)

docs/True.md

@@ -13,6 +13,7 @@ v::true()->validate('on'); //true
 v::true()->validate('yes'); //true
 ```
 
-See also
+***
+See also:
 
   * [False](False.md)

docs/Type.md

@@ -10,7 +10,8 @@ v::type('callable')->validate(function (){}); //true
 v::type('object')->validate(new stdClass()); //true
 ```
 
-See also
+***
+See also:
 
   * [Arr](Arr.md)
   * [Bool](Bool.md)

docs/Uppercase.md

@@ -8,6 +8,7 @@ Validates if string characters are uppercase in the input:
 v::string()->uppercase()->validate('W3C'); //true
 ```
 
+***
 See also:
 
   * [Lowercase](Lowercase.md)

docs/Url.md

@@ -14,6 +14,7 @@ v::url()->validate('news:new.example.com'); //true
 
 This rule uses [FilterVar](FilterVar.md)
 
+***
 See also:
 
   * [Domain](Domain.md)

docs/VALIDATORS.md

@@ -278,7 +278,6 @@
   * [Zend](Zend.md)
 
 ***
-
 See also:
 
 - [Contributing](../CONTRIBUTING.md)

docs/Vowel.md

@@ -8,6 +8,7 @@ Similar to `v::alnum()`. Validates strings that contains only vowels:
 v::vowel()->validate('aei'); //true
 ```
 
+***
 See also:
 
   * [Alnum](Alnum.md)

docs/When.md

@@ -16,6 +16,7 @@ In the sample above, if `$input` is an integer, then it must be positive.
 If `$input` is not an integer, then it must not me empty.
 When `$else` is not defined use [AlwaysInvalid](AlwaysInvalid.md)
 
+***
 See also:
 
   * [AllOf](AllOf.md)

docs/Xdigit.md

@@ -14,6 +14,7 @@ Notice, however, that it doesn't accept strings starting with 0x:
 v::xdigit()->validate('0x1f'); //false
 ```
 
+***
 See also:
 
   * [Digit](Digit.md)

docs/Yes.md

@@ -17,6 +17,7 @@ This rule is case insensitive.
 
 If `$locale` is TRUE, uses the value of [nl_langinfo()](http://php.net/nl_langinfo) with `YESEXPR` constant.
 
+***
 See also:
 
   * [No](No.md)

docs/Zend.md

@@ -11,6 +11,7 @@ v::zend('Hostname')->validate('google.com');
 
 You must add `"zendframework/zend-validator": "~2.3"` to your `require` property on composer.json file.
 
+***
 See also:
 
   * [Sf](Sf.md)