update docs

eddmash · Feb 7, 2018 · 31c9dd2 · 31c9dd2
1 parent e3068ee
commit 31c9dd2
Show file tree

Hide file tree

Showing 10 changed files with 83 additions and 18 deletions.
diff --git a/docs/packages.rst b/docs/packages.rst
@@ -0,0 +1,10 @@
+Javadoc
+=======
+
+.. toctree::
+   :maxdepth: 2
+
+   com/eddmash/validation/package-index
+   com/eddmash/validation/checks/package-index
+   com/eddmash/validation/renderer/package-index
+
diff --git a/docs/source/com/eddmash/validation/ExampleInstrumentedTest.rst b/docs/source/com/eddmash/validation/ExampleInstrumentedTest.rst
@@ -0,0 +1,30 @@
+.. java:import:: android.content Context
+
+.. java:import:: android.support.test InstrumentationRegistry
+
+.. java:import:: android.support.test.runner AndroidJUnit4
+
+.. java:import:: org.junit Test
+
+.. java:import:: org.junit.runner RunWith
+
+ExampleInstrumentedTest
+=======================
+
+.. java:package:: com.eddmash.validation
+   :noindex:
+
+.. java:type:: @RunWith public class ExampleInstrumentedTest
+
+   Instrumentation test, which will execute on an Android device.
+
+   **See also:** \ `Testing documentation <http://d.android.com/tools/testing>`_\
+
+Methods
+-------
+useAppContext
+^^^^^^^^^^^^^
+
+.. java:method:: @Test public void useAppContext() throws Exception
+   :outertype: ExampleInstrumentedTest
+
diff --git a/docs/source/com/eddmash/validation/ExampleUnitTest.rst b/docs/source/com/eddmash/validation/ExampleUnitTest.rst
@@ -0,0 +1,22 @@
+.. java:import:: org.junit Test
+
+ExampleUnitTest
+===============
+
+.. java:package:: com.eddmash.validation
+   :noindex:
+
+.. java:type:: public class ExampleUnitTest
+
+   Example local unit test, which will execute on the development machine (host).
+
+   **See also:** \ `Testing documentation <http://d.android.com/tools/testing>`_\
+
+Methods
+-------
+addition_isCorrect
+^^^^^^^^^^^^^^^^^^
+
+.. java:method:: @Test public void addition_isCorrect() throws Exception
+   :outertype: ExampleUnitTest
+
diff --git a/docs/source/com/eddmash/validation/checks/AllCheck.rst b/docs/source/com/eddmash/validation/checks/AllCheck.rst
@@ -6,7 +6,7 @@ AllCheck
 
 .. java:type:: public class AllCheck extends CheckCompound
 
-   Ensures all are validation checks are valid. \ **NOTE::**\   If the no checks are provided i.e. checkList is empty, validation will always pass for this check.
+   Ensures all are validation checks are valid. NOTE:: If the no checks are provided i.e. checkList is empty, validation will always pass for this check.
 
 Constructors
 ------------

diff --git a/docs/source/com/eddmash/validation/checks/AnyCheck.rst b/docs/source/com/eddmash/validation/checks/AnyCheck.rst
@@ -6,7 +6,7 @@ AnyCheck
 
 .. java:type:: public class AnyCheck extends CheckCompound
 
-   Checks if at least one of the checks passed validation. \ **NOTE::**\   If the no checks are provided i.e. checkList is empty, validation will always fail.
+   Checks if at least one of the checks passed validation. NOTE:: If the no checks are provided i.e. checkList is empty, validation will always fail.
 
 Constructors
 ------------

diff --git a/docs/source/com/eddmash/validation/checks/CheckCompound.rst b/docs/source/com/eddmash/validation/checks/CheckCompound.rst
@@ -50,6 +50,18 @@ clearError
 .. java:method:: @Override public void clearError()
    :outertype: CheckCompound
 
+disableCheck
+^^^^^^^^^^^^
+
+.. java:method:: public void disableCheck(CheckInterface checkInterface)
+   :outertype: CheckCompound
+
+disableChecks
+^^^^^^^^^^^^^
+
+.. java:method:: public void disableChecks(List<CheckInterface> validationChecks)
+   :outertype: CheckCompound
+
 getErrorMsg
 ^^^^^^^^^^^
 

diff --git a/docs/source/com/eddmash/validation/package-index.rst b/docs/source/com/eddmash/validation/package-index.rst
@@ -6,6 +6,8 @@ com.eddmash.validation
 .. toctree::
    :maxdepth: 1
 
+   ExampleInstrumentedTest
+   ExampleUnitTest
    ValidationListener
    Validator
    ValidatorInterface

diff --git a/docs/source/com/eddmash/validation/renderer/ErrorRenderer.rst b/docs/source/com/eddmash/validation/renderer/ErrorRenderer.rst
@@ -1,9 +1,9 @@
+.. java:import:: android.app Activity
+
 .. java:import:: android.graphics Color
 
 .. java:import:: android.graphics Typeface
 
-.. java:import:: android.support.v7.app AppCompatActivity
-
 .. java:import:: android.view View
 
 .. java:import:: android.view ViewGroup
@@ -14,8 +14,6 @@
 
 .. java:import:: android.widget TextView
 
-.. java:import:: com.eddmash.validation Validator
-
 .. java:import:: com.eddmash.validation ValidatorInterface
 
 .. java:import:: java.util List
@@ -37,7 +35,7 @@ Constructors
 ErrorRenderer
 ^^^^^^^^^^^^^
 
-.. java:constructor:: public ErrorRenderer(AppCompatActivity compatActivity, ValidatorInterface validatorInterface)
+.. java:constructor:: public ErrorRenderer(Activity activity, ValidatorInterface validatorInterface)
    :outertype: ErrorRenderer
 
 Methods

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -15,15 +15,15 @@ using Maven.
     <dependency>
       <groupId>com.eddmash</groupId>
       <artifactId>validation</artifactId>
-      <version>1.0.13</version>
+      <version>1.0.16</version>
       <type>pom</type>
     </dependency>
 
 using Gradle.
 
 ::
 
-    compile 'com.eddmash:validation:1.0.13'
+    compile 'com.eddmash:validation:1.0.16'
 
 Usage
 *****

diff --git a/validation.iml b/validation.iml
@@ -89,21 +89,12 @@
       <excludeFolder url="file://$MODULE_DIR$/build/intermediates/blame" />
       <excludeFolder url="file://$MODULE_DIR$/build/intermediates/bundles" />
       <excludeFolder url="file://$MODULE_DIR$/build/intermediates/check-manifest" />
-      <excludeFolder url="file://$MODULE_DIR$/build/intermediates/classes" />
       <excludeFolder url="file://$MODULE_DIR$/build/intermediates/incremental" />
-      <excludeFolder url="file://$MODULE_DIR$/build/intermediates/intermediate-jars" />
-      <excludeFolder url="file://$MODULE_DIR$/build/intermediates/javaPrecompile" />
-      <excludeFolder url="file://$MODULE_DIR$/build/intermediates/jniLibs" />
-      <excludeFolder url="file://$MODULE_DIR$/build/intermediates/lint" />
       <excludeFolder url="file://$MODULE_DIR$/build/intermediates/manifests" />
       <excludeFolder url="file://$MODULE_DIR$/build/intermediates/res" />
-      <excludeFolder url="file://$MODULE_DIR$/build/intermediates/rs" />
-      <excludeFolder url="file://$MODULE_DIR$/build/intermediates/shaders" />
       <excludeFolder url="file://$MODULE_DIR$/build/intermediates/symbols" />
       <excludeFolder url="file://$MODULE_DIR$/build/intermediates/tmp" />
-      <excludeFolder url="file://$MODULE_DIR$/build/intermediates/transforms" />
       <excludeFolder url="file://$MODULE_DIR$/build/outputs" />
-      <excludeFolder url="file://$MODULE_DIR$/build/tmp" />
     </content>
     <orderEntry type="jdk" jdkName="Android API 25 Platform" jdkType="Android SDK" />
     <orderEntry type="sourceFolder" forTests="false" />