Update documentation for v3.1.0

ustwo · Apr 4, 2018 · c6b4ded · c6b4ded
1 parent 2d81c57
commit c6b4ded
Show file tree

Hide file tree

Showing 116 changed files with 986 additions and 771 deletions.
diff --git a/docs/Classes.html b/docs/Classes.html
@@ -22,7 +22,7 @@
         <a class="header-link" href="index.html">
           FormValidatorSwift Docs
         </a>
-         (72% documented)
+         (73% documented)
       </p>
 
       <p class="header-col--secondary">
@@ -300,7 +300,7 @@ <h4>Declaration</h4>
       </article>
     </div>
     <section class="footer">
-      <p>&copy; 2018 <a class="link" href="https://ustwo.com/" target="_blank" rel="external">ustwo Fampany Ltd.</a>. All rights reserved. (Last updated: 2018-02-08)</p>
+      <p>&copy; 2018 <a class="link" href="https://ustwo.com/" target="_blank" rel="external">ustwo Fampany Ltd.</a>. All rights reserved. (Last updated: 2018-04-04)</p>
       <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
     </section>
   </body>

diff --git a/docs/Classes/ValidatorTextField.html b/docs/Classes/ValidatorTextField.html
@@ -23,7 +23,7 @@
         <a class="header-link" href="../index.html">
           FormValidatorSwift Docs
         </a>
-         (72% documented)
+         (73% documented)
       </p>
 
       <p class="header-col--secondary">
@@ -249,9 +249,9 @@ <h3 class="section-name">Properties</h3>
                 <li class="item">
                   <div>
                     <code>
-                    <a name="/s:18FormValidatorSwift0B9TextFieldC20shouldAllowViolationSbv"></a>
+                    <a name="/s:18FormValidatorSwift0B9TextFieldC20shouldAllowViolationSbvp"></a>
                     <a name="//apple_ref/swift/Property/shouldAllowViolation" class="dashAnchor"></a>
-                    <a class="token" href="#/s:18FormValidatorSwift0B9TextFieldC20shouldAllowViolationSbv">shouldAllowViolation</a>
+                    <a class="token" href="#/s:18FormValidatorSwift0B9TextFieldC20shouldAllowViolationSbvp">shouldAllowViolation</a>
                     </code>
                   </div>
                   <div class="height-container">
@@ -276,9 +276,9 @@ <h4>Declaration</h4>
                 <li class="item">
                   <div>
                     <code>
-                    <a name="/s:18FormValidatorSwift0B9TextFieldC23validateOnFocusLossOnlySbv"></a>
+                    <a name="/s:18FormValidatorSwift0B9TextFieldC23validateOnFocusLossOnlySbvp"></a>
                     <a name="//apple_ref/swift/Property/validateOnFocusLossOnly" class="dashAnchor"></a>
-                    <a class="token" href="#/s:18FormValidatorSwift0B9TextFieldC23validateOnFocusLossOnlySbv">validateOnFocusLossOnly</a>
+                    <a class="token" href="#/s:18FormValidatorSwift0B9TextFieldC23validateOnFocusLossOnlySbvp">validateOnFocusLossOnly</a>
                     </code>
                   </div>
                   <div class="height-container">
@@ -303,9 +303,9 @@ <h4>Declaration</h4>
                 <li class="item">
                   <div>
                     <code>
-                    <a name="/s:18FormValidatorSwift0B9TextFieldC9validatorAA0B0_pv"></a>
+                    <a name="/s:18FormValidatorSwift0B9TextFieldC9validatorAA0B0_pvp"></a>
                     <a name="//apple_ref/swift/Property/validator" class="dashAnchor"></a>
-                    <a class="token" href="#/s:18FormValidatorSwift0B9TextFieldC9validatorAA0B0_pv">validator</a>
+                    <a class="token" href="#/s:18FormValidatorSwift0B9TextFieldC9validatorAA0B0_pvp">validator</a>
                     </code>
                   </div>
                   <div class="height-container">
@@ -330,9 +330,9 @@ <h4>Declaration</h4>
                 <li class="item">
                   <div>
                     <code>
-                    <a name="/s:18FormValidatorSwift0B9TextFieldC17validatorDelegateAA0b7ControlG0_pSgXwv"></a>
+                    <a name="/s:18FormValidatorSwift0B9TextFieldC17validatorDelegateAA0b7ControlG0_pSgXwvp"></a>
                     <a name="//apple_ref/swift/Property/validatorDelegate" class="dashAnchor"></a>
-                    <a class="token" href="#/s:18FormValidatorSwift0B9TextFieldC17validatorDelegateAA0b7ControlG0_pSgXwv">validatorDelegate</a>
+                    <a class="token" href="#/s:18FormValidatorSwift0B9TextFieldC17validatorDelegateAA0b7ControlG0_pSgXwvp">validatorDelegate</a>
                     </code>
                   </div>
                   <div class="height-container">
@@ -362,9 +362,9 @@ <h4>Declaration</h4>
                 <li class="item">
                   <div>
                     <code>
-                    <a name="/s:18FormValidatorSwift0B9TextFieldC011validatableD0SSSgv"></a>
+                    <a name="/s:18FormValidatorSwift0B9TextFieldC011validatableD0SSSgvp"></a>
                     <a name="//apple_ref/swift/Property/validatableText" class="dashAnchor"></a>
-                    <a class="token" href="#/s:18FormValidatorSwift0B9TextFieldC011validatableD0SSSgv">validatableText</a>
+                    <a class="token" href="#/s:18FormValidatorSwift0B9TextFieldC011validatableD0SSSgvp">validatableText</a>
                     </code>
                   </div>
                   <div class="height-container">
@@ -502,7 +502,7 @@ <h3 class="section-name">Custom Setters</h3>
                     <section class="section">
                       <div class="pointer"></div>
                       <div class="abstract">
-                        <p>Sets the <code><a href="../Classes/ValidatorTextField.html#/s:18FormValidatorSwift0B9TextFieldC17validatorDelegateAA0b7ControlG0_pSgXwv">validatorDelegate</a></code> for the text field. This allows custom responses to both <code>UITextFieldDelegate</code> callbacks as well as those from <code><a href="../Protocols/ValidatorControlDelegate.html">ValidatorControlDelegate</a></code>.</p>
+                        <p>Sets the <code><a href="../Classes/ValidatorTextField.html#/s:18FormValidatorSwift0B9TextFieldC17validatorDelegateAA0b7ControlG0_pSgXwvp">validatorDelegate</a></code> for the text field. This allows custom responses to both <code>UITextFieldDelegate</code> callbacks as well as those from <code><a href="../Protocols/ValidatorControlDelegate.html">ValidatorControlDelegate</a></code>.</p>
 
                       </div>
                       <div class="declaration">
@@ -608,7 +608,7 @@ <h4>Declaration</h4>
       </article>
     </div>
     <section class="footer">
-      <p>&copy; 2018 <a class="link" href="https://ustwo.com/" target="_blank" rel="external">ustwo Fampany Ltd.</a>. All rights reserved. (Last updated: 2018-02-08)</p>
+      <p>&copy; 2018 <a class="link" href="https://ustwo.com/" target="_blank" rel="external">ustwo Fampany Ltd.</a>. All rights reserved. (Last updated: 2018-04-04)</p>
       <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
     </section>
   </body>

diff --git a/docs/Classes/ValidatorTextView.html b/docs/Classes/ValidatorTextView.html
@@ -23,7 +23,7 @@
         <a class="header-link" href="../index.html">
           FormValidatorSwift Docs
         </a>
-         (72% documented)
+         (73% documented)
       </p>
 
       <p class="header-col--secondary">
@@ -249,9 +249,9 @@ <h3 class="section-name">Properties</h3>
                 <li class="item">
                   <div>
                     <code>
-                    <a name="/s:18FormValidatorSwift0B8TextViewC20shouldAllowViolationSbv"></a>
+                    <a name="/s:18FormValidatorSwift0B8TextViewC20shouldAllowViolationSbvp"></a>
                     <a name="//apple_ref/swift/Property/shouldAllowViolation" class="dashAnchor"></a>
-                    <a class="token" href="#/s:18FormValidatorSwift0B8TextViewC20shouldAllowViolationSbv">shouldAllowViolation</a>
+                    <a class="token" href="#/s:18FormValidatorSwift0B8TextViewC20shouldAllowViolationSbvp">shouldAllowViolation</a>
                     </code>
                   </div>
                   <div class="height-container">
@@ -276,9 +276,9 @@ <h4>Declaration</h4>
                 <li class="item">
                   <div>
                     <code>
-                    <a name="/s:18FormValidatorSwift0B8TextViewC23validateOnFocusLossOnlySbv"></a>
+                    <a name="/s:18FormValidatorSwift0B8TextViewC23validateOnFocusLossOnlySbvp"></a>
                     <a name="//apple_ref/swift/Property/validateOnFocusLossOnly" class="dashAnchor"></a>
-                    <a class="token" href="#/s:18FormValidatorSwift0B8TextViewC23validateOnFocusLossOnlySbv">validateOnFocusLossOnly</a>
+                    <a class="token" href="#/s:18FormValidatorSwift0B8TextViewC23validateOnFocusLossOnlySbvp">validateOnFocusLossOnly</a>
                     </code>
                   </div>
                   <div class="height-container">
@@ -303,9 +303,9 @@ <h4>Declaration</h4>
                 <li class="item">
                   <div>
                     <code>
-                    <a name="/s:18FormValidatorSwift0B8TextViewC9validatorAA0B0_pv"></a>
+                    <a name="/s:18FormValidatorSwift0B8TextViewC9validatorAA0B0_pvp"></a>
                     <a name="//apple_ref/swift/Property/validator" class="dashAnchor"></a>
-                    <a class="token" href="#/s:18FormValidatorSwift0B8TextViewC9validatorAA0B0_pv">validator</a>
+                    <a class="token" href="#/s:18FormValidatorSwift0B8TextViewC9validatorAA0B0_pvp">validator</a>
                     </code>
                   </div>
                   <div class="height-container">
@@ -330,9 +330,9 @@ <h4>Declaration</h4>
                 <li class="item">
                   <div>
                     <code>
-                    <a name="/s:18FormValidatorSwift0B8TextViewC17validatorDelegateAA0b7ControlG0_pSgXwv"></a>
+                    <a name="/s:18FormValidatorSwift0B8TextViewC17validatorDelegateAA0b7ControlG0_pSgXwvp"></a>
                     <a name="//apple_ref/swift/Property/validatorDelegate" class="dashAnchor"></a>
-                    <a class="token" href="#/s:18FormValidatorSwift0B8TextViewC17validatorDelegateAA0b7ControlG0_pSgXwv">validatorDelegate</a>
+                    <a class="token" href="#/s:18FormValidatorSwift0B8TextViewC17validatorDelegateAA0b7ControlG0_pSgXwvp">validatorDelegate</a>
                     </code>
                   </div>
                   <div class="height-container">
@@ -362,9 +362,9 @@ <h4>Declaration</h4>
                 <li class="item">
                   <div>
                     <code>
-                    <a name="/s:18FormValidatorSwift0B8TextViewC011validatableD0SSSgv"></a>
+                    <a name="/s:18FormValidatorSwift0B8TextViewC011validatableD0SSSgvp"></a>
                     <a name="//apple_ref/swift/Property/validatableText" class="dashAnchor"></a>
-                    <a class="token" href="#/s:18FormValidatorSwift0B8TextViewC011validatableD0SSSgv">validatableText</a>
+                    <a class="token" href="#/s:18FormValidatorSwift0B8TextViewC011validatableD0SSSgvp">validatableText</a>
                     </code>
                   </div>
                   <div class="height-container">
@@ -529,7 +529,7 @@ <h3 class="section-name">Custom Setters</h3>
                     <section class="section">
                       <div class="pointer"></div>
                       <div class="abstract">
-                        <p>Sets the <code><a href="../Classes/ValidatorTextView.html#/s:18FormValidatorSwift0B8TextViewC17validatorDelegateAA0b7ControlG0_pSgXwv">validatorDelegate</a></code> for the text view. This allows custom responses to both <code>UITextViewDelegate</code> callbacks as well as those from <code><a href="../Protocols/ValidatorControlDelegate.html">ValidatorControlDelegate</a></code>.</p>
+                        <p>Sets the <code><a href="../Classes/ValidatorTextView.html#/s:18FormValidatorSwift0B8TextViewC17validatorDelegateAA0b7ControlG0_pSgXwvp">validatorDelegate</a></code> for the text view. This allows custom responses to both <code>UITextViewDelegate</code> callbacks as well as those from <code><a href="../Protocols/ValidatorControlDelegate.html">ValidatorControlDelegate</a></code>.</p>
 
                       </div>
                       <div class="declaration">
@@ -635,7 +635,7 @@ <h4>Declaration</h4>
       </article>
     </div>
     <section class="footer">
-      <p>&copy; 2018 <a class="link" href="https://ustwo.com/" target="_blank" rel="external">ustwo Fampany Ltd.</a>. All rights reserved. (Last updated: 2018-02-08)</p>
+      <p>&copy; 2018 <a class="link" href="https://ustwo.com/" target="_blank" rel="external">ustwo Fampany Ltd.</a>. All rights reserved. (Last updated: 2018-04-04)</p>
       <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
     </section>
   </body>

diff --git a/docs/Enums.html b/docs/Enums.html
@@ -22,7 +22,7 @@
         <a class="header-link" href="index.html">
           FormValidatorSwift Docs
         </a>
-         (72% documented)
+         (73% documented)
       </p>
 
       <p class="header-col--secondary">
@@ -300,7 +300,7 @@ <h4>Declaration</h4>
       </article>
     </div>
     <section class="footer">
-      <p>&copy; 2018 <a class="link" href="https://ustwo.com/" target="_blank" rel="external">ustwo Fampany Ltd.</a>. All rights reserved. (Last updated: 2018-02-08)</p>
+      <p>&copy; 2018 <a class="link" href="https://ustwo.com/" target="_blank" rel="external">ustwo Fampany Ltd.</a>. All rights reserved. (Last updated: 2018-04-04)</p>
       <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
     </section>
   </body>

diff --git a/docs/Enums/PasswordStrength.html b/docs/Enums/PasswordStrength.html
@@ -23,7 +23,7 @@
         <a class="header-link" href="../index.html">
           FormValidatorSwift Docs
         </a>
-         (72% documented)
+         (73% documented)
       </p>
 
       <p class="header-col--secondary">
@@ -382,7 +382,7 @@ <h4>Declaration</h4>
       </article>
     </div>
     <section class="footer">
-      <p>&copy; 2018 <a class="link" href="https://ustwo.com/" target="_blank" rel="external">ustwo Fampany Ltd.</a>. All rights reserved. (Last updated: 2018-02-08)</p>
+      <p>&copy; 2018 <a class="link" href="https://ustwo.com/" target="_blank" rel="external">ustwo Fampany Ltd.</a>. All rights reserved. (Last updated: 2018-04-04)</p>
       <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
     </section>
   </body>

diff --git a/docs/Enums/PostcodeCountries.html b/docs/Enums/PostcodeCountries.html
@@ -23,7 +23,7 @@
         <a class="header-link" href="../index.html">
           FormValidatorSwift Docs
         </a>
-         (72% documented)
+         (73% documented)
       </p>
 
       <p class="header-col--secondary">
@@ -366,9 +366,9 @@ <h4>Declaration</h4>
                 <li class="item">
                   <div>
                     <code>
-                    <a name="/s:18FormValidatorSwift17PostcodeCountriesO5regexSSv"></a>
+                    <a name="/s:18FormValidatorSwift17PostcodeCountriesO5regexSSvp"></a>
                     <a name="//apple_ref/swift/Property/regex" class="dashAnchor"></a>
-                    <a class="token" href="#/s:18FormValidatorSwift17PostcodeCountriesO5regexSSv">regex</a>
+                    <a class="token" href="#/s:18FormValidatorSwift17PostcodeCountriesO5regexSSvp">regex</a>
                     </code>
                   </div>
                   <div class="height-container">
@@ -393,9 +393,9 @@ <h4>Declaration</h4>
                 <li class="item">
                   <div>
                     <code>
-                    <a name="/s:18FormValidatorSwift17PostcodeCountriesO9allValuesSayACGvZ"></a>
+                    <a name="/s:18FormValidatorSwift17PostcodeCountriesO9allValuesSayACGvpZ"></a>
                     <a name="//apple_ref/swift/Variable/allValues" class="dashAnchor"></a>
-                    <a class="token" href="#/s:18FormValidatorSwift17PostcodeCountriesO9allValuesSayACGvZ">allValues</a>
+                    <a class="token" href="#/s:18FormValidatorSwift17PostcodeCountriesO9allValuesSayACGvpZ">allValues</a>
                     </code>
                   </div>
                   <div class="height-container">
@@ -425,7 +425,7 @@ <h4>Declaration</h4>
       </article>
     </div>
     <section class="footer">
-      <p>&copy; 2018 <a class="link" href="https://ustwo.com/" target="_blank" rel="external">ustwo Fampany Ltd.</a>. All rights reserved. (Last updated: 2018-02-08)</p>
+      <p>&copy; 2018 <a class="link" href="https://ustwo.com/" target="_blank" rel="external">ustwo Fampany Ltd.</a>. All rights reserved. (Last updated: 2018-04-04)</p>
       <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
     </section>
   </body>

diff --git a/docs/Protocols.html b/docs/Protocols.html
@@ -22,7 +22,7 @@
         <a class="header-link" href="index.html">
           FormValidatorSwift Docs
         </a>
-         (72% documented)
+         (73% documented)
       </p>
 
       <p class="header-col--secondary">
@@ -531,7 +531,7 @@ <h4>Declaration</h4>
       </article>
     </div>
     <section class="footer">
-      <p>&copy; 2018 <a class="link" href="https://ustwo.com/" target="_blank" rel="external">ustwo Fampany Ltd.</a>. All rights reserved. (Last updated: 2018-02-08)</p>
+      <p>&copy; 2018 <a class="link" href="https://ustwo.com/" target="_blank" rel="external">ustwo Fampany Ltd.</a>. All rights reserved. (Last updated: 2018-04-04)</p>
       <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
     </section>
   </body>