update doxs

eddmash · Nov 23, 2017 · 523e9ee · 523e9ee
1 parent d43617d
commit 523e9ee
Show file tree

Hide file tree

Showing 29 changed files with 77 additions and 327 deletions.
diff --git a/README.md b/README.md
@@ -52,34 +52,45 @@ Using this library boils down to this steps
     validator.addCheck(new NotEmptyCheck(nameEditText, "name cannot be blank");
     validator.addCheck(new NotEmptyCheck(ageSpinner, "age cannot be blank");
 ```
-`Learn more about available checks <com/eddmash/validation/checks/package-index>`
+[Learn more about available checks](http://android-validation-library.readthedocs.io/en/latest/checks.html)
 
-- Validate and Handle the errors
+- Validate
 
+The final step is telling the validator to validate againsts our checks
 
-To run the validations invole the validators
-`validate() <ValidatorInterface.validate()>` method.
+```
+validator.validate().
+```
 
 This method returns ``true`` if the validation passed or ``false`` if the validations failed.
 
+Handling Errors
+---------------
+
 Incase of validation failure, the validation errors can be accessed via the
 `getErrors() <ValidatorInterface.getErrors()>` method.
 
-This library comes with a convenience `ErrorRenderer <ErrorRenderer>`, which can be used
-to easily display the validation errors.
+This library comes with a convenience class 
+[ErrorRenderer](http://android-validation-library.readthedocs.io/en/latest/renderer.html), which 
+can be used to easily display the validation errors.
 
 ```
      // the layout where we display any validation errors
      LinearLayout errorSpace = (LinearLayout) findViewById(R.id.error_base);
+     
      errorSpace.removeAllViews();// clear space first
-
+     
      if (validator.validate()) {
+     
          // .. code to perform if validation passes
+         
      } else {
-
+     
          // show the errors if validation failed
          // we use the renderer class to handle the display
          ErrorRenderer errorRenderer = new ErrorRenderer(this, validator);
+         
          errorRenderer.render(errorSpace);
      }
-```
+```
+
diff --git a/docs/source/com/eddmash/validation/ExampleInstrumentedTest.rst b/docs/source/com/eddmash/validation/ExampleInstrumentedTest.rst
diff --git a/docs/source/com/eddmash/validation/ExampleUnitTest.rst b/docs/source/com/eddmash/validation/ExampleUnitTest.rst
diff --git a/docs/source/com/eddmash/validation/ValidationListener.rst b/docs/source/com/eddmash/validation/ValidationListener.rst
@@ -10,17 +10,12 @@ ValidationListener
 
 Methods
 -------
-onValidationFailed
-^^^^^^^^^^^^^^^^^^
 
 .. java:method::  void onValidationFailed()
    :outertype: ValidationListener
 
    Invoked when validation failed
 
-onValidationSuccess
-^^^^^^^^^^^^^^^^^^^
-
 .. java:method::  void onValidationSuccess()
    :outertype: ValidationListener
 

diff --git a/docs/source/com/eddmash/validation/Validator.rst b/docs/source/com/eddmash/validation/Validator.rst
@@ -26,79 +26,45 @@ Validator
 
 Constructors
 ------------
-Validator
-^^^^^^^^^
 
 .. java:constructor:: public Validator(Activity context)
    :outertype: Validator
 
-Validator
-^^^^^^^^^
-
 .. java:constructor:: public Validator(String tag, Activity context)
    :outertype: Validator
 
 Methods
 -------
-addCheck
-^^^^^^^^
 
 .. java:method:: @Override public void addCheck(ValidationCheck validationCheck)
    :outertype: Validator
 
-addValidator
-^^^^^^^^^^^^
-
 .. java:method:: @Override public void addValidator(ValidatorInterface validator)
    :outertype: Validator
 
-clearErrors
-^^^^^^^^^^^
-
 .. java:method:: @Override public void clearErrors()
    :outertype: Validator
 
-disableCheck
-^^^^^^^^^^^^
-
 .. java:method:: @Override public void disableCheck(ValidationCheck validationCheck)
    :outertype: Validator
 
    \ :java:ref:`see <ValidatorInterface.addCheck(ValidationCheck)>`\
 
-disableValidator
-^^^^^^^^^^^^^^^^
-
 .. java:method:: @Override public void disableValidator(ValidatorInterface validatorInterface)
    :outertype: Validator
 
-getErrors
-^^^^^^^^^
-
 .. java:method:: @Override public Map<String, List> getErrors()
    :outertype: Validator
 
-getErrorsByTag
-^^^^^^^^^^^^^^
-
 .. java:method:: @Override public List getErrorsByTag(String tag)
    :outertype: Validator
 
-toString
-^^^^^^^^
-
 .. java:method:: @Override public String toString()
    :outertype: Validator
 
-validate
-^^^^^^^^
-
 .. java:method:: @Override public boolean validate()
    :outertype: Validator
 
-validate
-^^^^^^^^
-
 .. java:method:: @Override public void validate(ValidationListener validationListener)
    :outertype: Validator
 
diff --git a/docs/source/com/eddmash/validation/ValidatorInterface.rst b/docs/source/com/eddmash/validation/ValidatorInterface.rst
@@ -14,8 +14,6 @@ ValidatorInterface
 
 Methods
 -------
-addCheck
-^^^^^^^^
 
 .. java:method::  void addCheck(ValidationCheck validationCheck)
    :outertype: ValidatorInterface
@@ -24,47 +22,32 @@ addCheck
 
    :param validationCheck:
 
-addValidator
-^^^^^^^^^^^^
-
 .. java:method::  void addValidator(ValidatorInterface validatorInterface)
    :outertype: ValidatorInterface
 
    Add another validator to validated at the time this one is being validated.
 
    :param validatorInterface: the validatorInterface object
 
-clearErrors
-^^^^^^^^^^^
-
 .. java:method::  void clearErrors()
    :outertype: ValidatorInterface
 
    Clear all the errors from the validator. maybe use when you have already run the validation onces and want to run the validation again using the same ValidatorInterface instance
 
-disableCheck
-^^^^^^^^^^^^
-
 .. java:method::  void disableCheck(ValidationCheck validationCheck)
    :outertype: ValidatorInterface
 
    disable validation check
 
    :param validationCheck: the validation check to disable.
 
-disableValidator
-^^^^^^^^^^^^^^^^
-
 .. java:method::  void disableValidator(ValidatorInterface validatorInterface)
    :outertype: ValidatorInterface
 
    Disable the validator from being validated any more.
 
    :param validatorInterface: validatorInterface object
 
-getErrors
-^^^^^^^^^
-
 .. java:method::  Map<String, List> getErrors()
    :outertype: ValidatorInterface
 
@@ -74,29 +57,20 @@ getErrors
 
    :return: Map
 
-getErrorsByTag
-^^^^^^^^^^^^^^
-
 .. java:method::  List getErrorsByTag(String tag)
    :outertype: ValidatorInterface
 
    Gets a list of errors for a specific tag.
 
    :param tag:
 
-validate
-^^^^^^^^
-
 .. java:method::  boolean validate()
    :outertype: ValidatorInterface
 
    Does the actual validation.
 
    :return: boolean true of valid
 
-validate
-^^^^^^^^
-
 .. java:method::  void validate(ValidationListener validationListener)
    :outertype: ValidatorInterface
 

diff --git a/docs/source/com/eddmash/validation/checks/AllCheck.rst b/docs/source/com/eddmash/validation/checks/AllCheck.rst
@@ -12,16 +12,12 @@ AllCheck
 
 Constructors
 ------------
-AllCheck
-^^^^^^^^
 
 .. java:constructor:: public AllCheck(String errorMessage)
    :outertype: AllCheck
 
 Methods
 -------
-validate
-^^^^^^^^
 
 .. java:method:: @Override protected boolean validate()
    :outertype: AllCheck

diff --git a/docs/source/com/eddmash/validation/checks/AnyCheck.rst b/docs/source/com/eddmash/validation/checks/AnyCheck.rst
@@ -12,16 +12,12 @@ AnyCheck
 
 Constructors
 ------------
-AnyCheck
-^^^^^^^^
 
 .. java:constructor:: public AnyCheck(String errorMessage)
    :outertype: AnyCheck
 
 Methods
 -------
-validate
-^^^^^^^^
 
 .. java:method:: @Override protected boolean validate()
    :outertype: AnyCheck

diff --git a/docs/source/com/eddmash/validation/checks/CheckCompound.rst b/docs/source/com/eddmash/validation/checks/CheckCompound.rst
@@ -16,55 +16,34 @@ CheckCompound
 
 Fields
 ------
-checkList
-^^^^^^^^^
 
 .. java:field:: protected List<ValidationCheck> checkList
    :outertype: CheckCompound
 
 Constructors
 ------------
-CheckCompound
-^^^^^^^^^^^^^
 
 .. java:constructor:: public CheckCompound(String errorMessage)
    :outertype: CheckCompound
 
 Methods
 -------
-addCheck
-^^^^^^^^
 
 .. java:method:: public void addCheck(ValidationCheck validationCheck)
    :outertype: CheckCompound
 
-addChecks
-^^^^^^^^^
-
 .. java:method:: public void addChecks(List<ValidationCheck> validationChecks)
    :outertype: CheckCompound
 
-getErrorMsg
-^^^^^^^^^^^
-
 .. java:method:: @Override public String getErrorMsg()
    :outertype: CheckCompound
 
-run
-^^^
-
 .. java:method:: @Override public boolean run()
    :outertype: CheckCompound
 
-setError
-^^^^^^^^
-
 .. java:method:: @Override public void setError(String error)
    :outertype: CheckCompound
 
-validate
-^^^^^^^^
-
 .. java:method:: protected abstract boolean validate()
    :outertype: CheckCompound