added some missing API docs and fixed some typos

philiplb · Aug 30, 2016 · e35ac6c · e35ac6c
1 parent 82e19aa
commit e35ac6c
Show file tree

Hide file tree

Showing 133 changed files with 1,696 additions and 1,789 deletions.
diff --git a/docs/api/RulesBuilder.rst b/docs/api/RulesBuilder.rst
@@ -1,6 +1,6 @@
-------------
-RulesBuilder
-------------
+-------------------
+Valdi\\RulesBuilder
+-------------------
 
 .. php:namespace: Valdi
 

diff --git a/docs/api/ValidationException.rst b/docs/api/ValidationException.rst
@@ -1,6 +1,6 @@
--------------------
-ValidationException
--------------------
+--------------------------
+Valdi\\ValidationException
+--------------------------
 
 .. php:namespace: Valdi
 

diff --git a/docs/api/Validator.rst b/docs/api/Validator.rst
@@ -1,6 +1,6 @@
----------
-Validator
----------
+----------------
+Valdi\\Validator
+----------------
 
 .. php:namespace: Valdi
 

diff --git a/docs/api/Validator/AbstractComparator.rst b/docs/api/Validator/AbstractComparator.rst
@@ -1,6 +1,6 @@
------------------------------
-Validator\\AbstractComparator
------------------------------
+------------------------------------
+Valdi\\Validator\\AbstractComparator
+------------------------------------
 
 .. toctree::
 
@@ -61,7 +61,7 @@ Validator\\AbstractComparator
 
     .. php:method:: validateParameterCount($name, $parameterAmount, $parameters)
 
-        Throws an exception if the parameters don't fullfill the expected
+        Throws an exception if the parameters don't fulfill the expected
         parameter count.
 
         :type $name: string

diff --git a/docs/api/Validator/AbstractDateTimeComparator.rst b/docs/api/Validator/AbstractDateTimeComparator.rst
@@ -1,6 +1,6 @@
--------------------------------------
-Validator\\AbstractDateTimeComparator
--------------------------------------
+--------------------------------------------
+Valdi\\Validator\\AbstractDateTimeComparator
+--------------------------------------------
 
 .. toctree::
 
@@ -64,7 +64,7 @@ Validator\\AbstractDateTimeComparator
         Interprets the given parameters as date times and returns them.
 
         :type $parameters: array
-        :param $parameters: the paramters
+        :param $parameters: the parameters
         :type $format: string
         :param $format: the date time format
         :returns: \DateTime[] the date times
@@ -82,7 +82,7 @@ Validator\\AbstractDateTimeComparator
 
     .. php:method:: validateParameterCount($name, $parameterAmount, $parameters)
 
-        Throws an exception if the parameters don't fullfill the expected
+        Throws an exception if the parameters don't fulfill the expected
         parameter count.
 
         :type $name: string

diff --git a/docs/api/Validator/AbstractFilter.rst b/docs/api/Validator/AbstractFilter.rst
@@ -1,6 +1,6 @@
--------------------------
-Validator\\AbstractFilter
--------------------------
+--------------------------------
+Valdi\\Validator\\AbstractFilter
+--------------------------------
 
 .. toctree::
 
@@ -38,3 +38,9 @@ Validator\\AbstractFilter
 
         :param $value:
         :param $parameters:
+
+    .. php:method:: getInvalidDetails()
+
+        Gets the details if the validation failed.
+
+        :returns: mixed the details
diff --git a/docs/api/Validator/AbstractParametrizedValidator.rst b/docs/api/Validator/AbstractParametrizedValidator.rst
@@ -1,6 +1,6 @@
-----------------------------------------
-Validator\\AbstractParametrizedValidator
-----------------------------------------
+-----------------------------------------------
+Valdi\\Validator\\AbstractParametrizedValidator
+-----------------------------------------------
 
 .. toctree::
 
@@ -15,7 +15,7 @@ Validator\\AbstractParametrizedValidator
 
     .. php:method:: validateParameterCount($name, $parameterAmount, $parameters)
 
-        Throws an exception if the parameters don't fullfill the expected
+        Throws an exception if the parameters don't fulfill the expected
         parameter count.
 
         :type $name: string
@@ -34,3 +34,9 @@ Validator\\AbstractParametrizedValidator
         :type $parameters: array
         :param $parameters: the other parameters the validator might need
         :returns: boolean true if the value is valid, false else
+
+    .. php:method:: getInvalidDetails()
+
+        Gets the details if the validation failed.
+
+        :returns: mixed the details
diff --git a/docs/api/Validator/AfterDateTime.rst b/docs/api/Validator/AfterDateTime.rst
@@ -1,6 +1,6 @@
-------------------------
-Validator\\AfterDateTime
-------------------------
+-------------------------------
+Valdi\\Validator\\AfterDateTime
+-------------------------------
 
 .. php:namespace: Valdi\\Validator
 
@@ -51,7 +51,7 @@ Validator\\AfterDateTime
         Interprets the given parameters as date times and returns them.
 
         :type $parameters: array
-        :param $parameters: the paramters
+        :param $parameters: the parameters
         :type $format: string
         :param $format: the date time format
         :returns: \DateTime[] the date times
@@ -69,7 +69,7 @@ Validator\\AfterDateTime
 
     .. php:method:: validateParameterCount($name, $parameterAmount, $parameters)
 
-        Throws an exception if the parameters don't fullfill the expected
+        Throws an exception if the parameters don't fulfill the expected
         parameter count.
 
         :type $name: string

diff --git a/docs/api/Validator/AlphaNumerical.rst b/docs/api/Validator/AlphaNumerical.rst
@@ -1,6 +1,6 @@
--------------------------
-Validator\\AlphaNumerical
--------------------------
+--------------------------------
+Valdi\\Validator\\AlphaNumerical
+--------------------------------
 
 .. php:namespace: Valdi\\Validator
 
@@ -46,7 +46,7 @@ Validator\\AlphaNumerical
 
     .. php:method:: validateParameterCount($name, $parameterAmount, $parameters)
 
-        Throws an exception if the parameters don't fullfill the expected
+        Throws an exception if the parameters don't fulfill the expected
         parameter count.
 
         :type $name: string

diff --git a/docs/api/Validator/Alphabetical.rst b/docs/api/Validator/Alphabetical.rst
@@ -1,6 +1,6 @@
------------------------
-Validator\\Alphabetical
------------------------
+------------------------------
+Valdi\\Validator\\Alphabetical
+------------------------------
 
 .. php:namespace: Valdi\\Validator
 
@@ -46,7 +46,7 @@ Validator\\Alphabetical
 
     .. php:method:: validateParameterCount($name, $parameterAmount, $parameters)
 
-        Throws an exception if the parameters don't fullfill the expected
+        Throws an exception if the parameters don't fulfill the expected
         parameter count.
 
         :type $name: string

diff --git a/docs/api/Validator/BeforeDateTime.rst b/docs/api/Validator/BeforeDateTime.rst
@@ -1,6 +1,6 @@
--------------------------
-Validator\\BeforeDateTime
--------------------------
+--------------------------------
+Valdi\\Validator\\BeforeDateTime
+--------------------------------
 
 .. php:namespace: Valdi\\Validator
 
@@ -51,7 +51,7 @@ Validator\\BeforeDateTime
         Interprets the given parameters as date times and returns them.
 
         :type $parameters: array
-        :param $parameters: the paramters
+        :param $parameters: the parameters
         :type $format: string
         :param $format: the date time format
         :returns: \DateTime[] the date times
@@ -69,7 +69,7 @@ Validator\\BeforeDateTime
 
     .. php:method:: validateParameterCount($name, $parameterAmount, $parameters)
 
-        Throws an exception if the parameters don't fullfill the expected
+        Throws an exception if the parameters don't fulfill the expected
         parameter count.
 
         :type $name: string

diff --git a/docs/api/Validator/Between.rst b/docs/api/Validator/Between.rst
@@ -1,6 +1,6 @@
-------------------
-Validator\\Between
-------------------
+-------------------------
+Valdi\\Validator\\Between
+-------------------------
 
 .. php:namespace: Valdi\\Validator
 
@@ -46,7 +46,7 @@ Validator\\Between
 
     .. php:method:: validateParameterCount($name, $parameterAmount, $parameters)
 
-        Throws an exception if the parameters don't fullfill the expected
+        Throws an exception if the parameters don't fulfill the expected
         parameter count.
 
         :type $name: string

diff --git a/docs/api/Validator/Boolean.rst b/docs/api/Validator/Boolean.rst
@@ -1,6 +1,6 @@
-------------------
-Validator\\Boolean
-------------------
+-------------------------
+Valdi\\Validator\\Boolean
+-------------------------
 
 .. php:namespace: Valdi\\Validator
 

diff --git a/docs/api/Validator/Contains.rst b/docs/api/Validator/Contains.rst
@@ -1,6 +1,6 @@
--------------------
-Validator\\Contains
--------------------
+--------------------------
+Valdi\\Validator\\Contains
+--------------------------
 
 .. php:namespace: Valdi\\Validator
 
@@ -10,7 +10,7 @@ Validator\\Contains
 
     .. php:method:: validateParameterCount($parameterAmount)
 
-        Throws an exception if the parameters don't fullfill the expected
+        Throws an exception if the parameters don't fulfill the expected
         parameter count.
 
         :type $parameterAmount: integer

diff --git a/docs/api/Validator/DateTime.rst b/docs/api/Validator/DateTime.rst
@@ -1,6 +1,6 @@
--------------------
-Validator\\DateTime
--------------------
+--------------------------
+Valdi\\Validator\\DateTime
+--------------------------
 
 .. php:namespace: Valdi\\Validator
 

diff --git a/docs/api/Validator/DateTimeBetween.rst b/docs/api/Validator/DateTimeBetween.rst
@@ -51,7 +51,7 @@ Valdi\\Validator\\DateTimeBetween
         Interprets the given parameters as date times and returns them.
 
         :type $parameters: array
-        :param $parameters: the paramters
+        :param $parameters: the parameters
         :type $format: string
         :param $format: the date time format
         :returns: \DateTime[] the date times
@@ -69,7 +69,7 @@ Valdi\\Validator\\DateTimeBetween
 
     .. php:method:: validateParameterCount($name, $parameterAmount, $parameters)
 
-        Throws an exception if the parameters don't fullfill the expected
+        Throws an exception if the parameters don't fulfill the expected
         parameter count.
 
         :type $name: string

diff --git a/docs/api/Validator/Email.rst b/docs/api/Validator/Email.rst
@@ -1,6 +1,6 @@
-----------------
-Validator\\Email
-----------------
+-----------------------
+Valdi\\Validator\\Email
+-----------------------
 
 .. php:namespace: Valdi\\Validator
 

diff --git a/docs/api/Validator/Floating.rst b/docs/api/Validator/Floating.rst
@@ -1,6 +1,6 @@
--------------------
-Validator\\Floating
--------------------
+--------------------------
+Valdi\\Validator\\Floating
+--------------------------
 
 .. php:namespace: Valdi\\Validator
 

diff --git a/docs/api/Validator/IP.rst b/docs/api/Validator/IP.rst
@@ -1,6 +1,6 @@
--------------
-Validator\\IP
--------------
+--------------------
+Valdi\\Validator\\IP
+--------------------
 
 .. php:namespace: Valdi\\Validator
 

diff --git a/docs/api/Validator/IPv4.rst b/docs/api/Validator/IPv4.rst
@@ -1,6 +1,6 @@
----------------
-Validator\\IPv4
----------------
+----------------------
+Valdi\\Validator\\IPv4
+----------------------
 
 .. php:namespace: Valdi\\Validator
 

diff --git a/docs/api/Validator/IPv6.rst b/docs/api/Validator/IPv6.rst
@@ -1,6 +1,6 @@
----------------
-Validator\\IPv6
----------------
+----------------------
+Valdi\\Validator\\IPv6
+----------------------
 
 .. php:namespace: Valdi\\Validator
 

diff --git a/docs/api/Validator/InSet.rst b/docs/api/Validator/InSet.rst
@@ -1,6 +1,6 @@
-----------------
-Validator\\InSet
-----------------
+-----------------------
+Valdi\\Validator\\InSet
+-----------------------
 
 .. php:namespace: Valdi\\Validator
 

diff --git a/docs/api/Validator/InTheFuture.rst b/docs/api/Validator/InTheFuture.rst
@@ -1,6 +1,6 @@
-----------------------
-Validator\\InTheFuture
-----------------------
+-----------------------------
+Valdi\\Validator\\InTheFuture
+-----------------------------
 
 .. php:namespace: Valdi\\Validator
 
@@ -51,7 +51,7 @@ Validator\\InTheFuture
         Interprets the given parameters as date times and returns them.
 
         :type $parameters: array
-        :param $parameters: the paramters
+        :param $parameters: the parameters
         :type $format: string
         :param $format: the date time format
         :returns: \DateTime[] the date times
@@ -69,7 +69,7 @@ Validator\\InTheFuture
 
     .. php:method:: validateParameterCount($name, $parameterAmount, $parameters)
 
-        Throws an exception if the parameters don't fullfill the expected
+        Throws an exception if the parameters don't fulfill the expected
         parameter count.
 
         :type $name: string