Skip to content

Commit

Permalink
Update documentation for v4.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
Aaron McTavish committed Apr 24, 2019
1 parent 0b110d1 commit 5a5785f
Show file tree
Hide file tree
Showing 117 changed files with 1,792 additions and 1,680 deletions.
11 changes: 6 additions & 5 deletions docs/Classes.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
</head>
<body>

<a name="//apple_ref/swift/Section/Classes" class="dashAnchor"></a>

<a title="Classes Reference"></a>

Expand All @@ -22,7 +23,7 @@
<a class="header-link" href="index.html">
FormValidatorSwift Docs
</a>
(73% documented)
(72% documented)
</p>

<p class="header-col--secondary">
Expand Down Expand Up @@ -256,7 +257,7 @@ <h1>Classes</h1>
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">ValidatorTextField</span><span class="p">:</span> <span class="kt">UITextField</span><span class="p">,</span> <span class="kt"><a href="Protocols/ValidatorControl.html">ValidatorControl</a></span></code></pre>
<pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">ValidatorTextField</span> <span class="p">:</span> <span class="kt">UITextField</span><span class="p">,</span> <span class="kt"><a href="Protocols/ValidatorControl.html">ValidatorControl</a></span></code></pre>

</div>
</div>
Expand Down Expand Up @@ -288,7 +289,7 @@ <h4>Declaration</h4>
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">ValidatorTextView</span><span class="p">:</span> <span class="kt">UITextView</span><span class="p">,</span> <span class="kt"><a href="Protocols/ValidatorControl.html">ValidatorControl</a></span></code></pre>
<pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">ValidatorTextView</span> <span class="p">:</span> <span class="kt">UITextView</span><span class="p">,</span> <span class="kt"><a href="Protocols/ValidatorControl.html">ValidatorControl</a></span></code></pre>

</div>
</div>
Expand All @@ -303,8 +304,8 @@ <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-04-25)</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>
<p>&copy; 2019 <a class="link" href="https://ustwo.com/" target="_blank" rel="external">ustwo Fampany Ltd.</a>. All rights reserved. (Last updated: 2019-04-24)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
</div>
Expand Down
69 changes: 48 additions & 21 deletions docs/Classes/ValidatorTextField.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
<a class="header-link" href="../index.html">
FormValidatorSwift Docs
</a>
(73% documented)
(72% documented)
</p>

<p class="header-col--secondary">
Expand Down Expand Up @@ -229,7 +229,7 @@
<h1>ValidatorTextField</h1>
<div class="declaration">
<div class="language">
<pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">ValidatorTextField</span><span class="p">:</span> <span class="kt">UITextField</span><span class="p">,</span> <span class="kt"><a href="../Protocols/ValidatorControl.html">ValidatorControl</a></span></code></pre>
<pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">ValidatorTextField</span> <span class="p">:</span> <span class="kt">UITextField</span><span class="p">,</span> <span class="kt"><a href="../Protocols/ValidatorControl.html">ValidatorControl</a></span></code></pre>

</div>
</div>
Expand Down Expand Up @@ -269,7 +269,7 @@ <h3 class="section-name">Properties</h3>
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">open</span> <span class="k">var</span> <span class="nv">shouldAllowViolation</span> <span class="o">=</span> <span class="kc">false</span></code></pre>
<pre class="highlight swift"><code><span class="kd">open</span> <span class="k">var</span> <span class="nv">shouldAllowViolation</span><span class="p">:</span> <span class="kt">Bool</span></code></pre>

</div>
</div>
Expand All @@ -296,7 +296,7 @@ <h4>Declaration</h4>
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">open</span> <span class="k">var</span> <span class="nv">validateOnFocusLossOnly</span> <span class="o">=</span> <span class="kc">false</span></code></pre>
<pre class="highlight swift"><code><span class="kd">open</span> <span class="k">var</span> <span class="nv">validateOnFocusLossOnly</span><span class="p">:</span> <span class="kt">Bool</span></code></pre>

</div>
</div>
Expand All @@ -323,7 +323,7 @@ <h4>Declaration</h4>
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">open</span> <span class="k">let</span> <span class="nv">validator</span><span class="p">:</span> <span class="kt"><a href="../Protocols/Validator.html">Validator</a></span></code></pre>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">validator</span><span class="p">:</span> <span class="kt"><a href="../Protocols/Validator.html">Validator</a></span></code></pre>

</div>
</div>
Expand All @@ -333,9 +333,9 @@ <h4>Declaration</h4>
<li class="item">
<div>
<code>
<a name="/s:18FormValidatorSwift0B9TextFieldC17validatorDelegateAA0b7ControlG0_pSgXwvp"></a>
<a name="/s:18FormValidatorSwift0B9TextFieldC17validatorDelegateAA0b7ControlG0_pSgvp"></a>
<a name="//apple_ref/swift/Property/validatorDelegate" class="dashAnchor"></a>
<a class="token" href="#/s:18FormValidatorSwift0B9TextFieldC17validatorDelegateAA0b7ControlG0_pSgXwvp">validatorDelegate</a>
<a class="token" href="#/s:18FormValidatorSwift0B9TextFieldC17validatorDelegateAA0b7ControlG0_pSgvp">validatorDelegate</a>
</code>
</div>
<div class="height-container">
Expand All @@ -346,7 +346,7 @@ <h4>Declaration</h4>
<p>Validator delegate for the text field.</p>
<div class="aside aside-see-also">
<p class="aside-title">See also</p>
<code><a href="../Classes/ValidatorTextField.html#/s:18FormValidatorSwift0B9TextFieldC03setB8DelegateyAA0b7ControlG0_So06UITexteG0pF">setValidatorDelegate(_:)</a></code> to set the validator delegate.
<code><a href="../Classes/ValidatorTextField.html#/s:18FormValidatorSwift0B9TextFieldC03setB8DelegateyyAA0b7ControlG0_So06UITexteG0pF">setValidatorDelegate(_:)</a></code> to set the validator delegate.

</div>

Expand All @@ -355,7 +355,7 @@ <h4>Declaration</h4>
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">open</span> <span class="k">weak</span> <span class="k">var</span> <span class="nv">validatorDelegate</span><span class="p">:</span> <span class="kt"><a href="../Protocols/ValidatorControlDelegate.html">ValidatorControlDelegate</a></span><span class="p">?</span></code></pre>
<pre class="highlight swift"><code><span class="kd">open</span> <span class="k">var</span> <span class="nv">validatorDelegate</span><span class="p">:</span> <span class="kt"><a href="../Protocols/ValidatorControlDelegate.html">ValidatorControlDelegate</a></span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>

</div>
</div>
Expand All @@ -382,7 +382,7 @@ <h4>Declaration</h4>
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">open</span> <span class="k">var</span> <span class="nv">validatableText</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span></code></pre>
<pre class="highlight swift"><code><span class="kd">open</span> <span class="k">var</span> <span class="nv">validatableText</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>

</div>
</div>
Expand All @@ -403,9 +403,9 @@ <h3 class="section-name">Initializers</h3>
<li class="item">
<div>
<code>
<a name="/s:18FormValidatorSwift0B9TextFieldCAcA0B0_p9validator_tcfc"></a>
<a name="/s:18FormValidatorSwift0B9TextFieldC9validatorAcA0B0_p_tcfc"></a>
<a name="//apple_ref/swift/Method/init(validator:)" class="dashAnchor"></a>
<a class="token" href="#/s:18FormValidatorSwift0B9TextFieldCAcA0B0_p9validator_tcfc">init(validator:)</a>
<a class="token" href="#/s:18FormValidatorSwift0B9TextFieldC9validatorAcA0B0_p_tcfc">init(validator:)</a>
</code>
</div>
<div class="height-container">
Expand All @@ -430,9 +430,9 @@ <h4>Declaration</h4>
<li class="item">
<div>
<code>
<a name="/s:18FormValidatorSwift0B9TextFieldCACSC6CGRectV5frame_AA0B0_p9validatortcfc"></a>
<a name="/s:18FormValidatorSwift0B9TextFieldC5frame9validatorACSo6CGRectV_AA0B0_ptcfc"></a>
<a name="//apple_ref/swift/Method/init(frame:validator:)" class="dashAnchor"></a>
<a class="token" href="#/s:18FormValidatorSwift0B9TextFieldCACSC6CGRectV5frame_AA0B0_p9validatortcfc">init(frame:validator:)</a>
<a class="token" href="#/s:18FormValidatorSwift0B9TextFieldC5frame9validatorACSo6CGRectV_AA0B0_ptcfc">init(frame:validator:)</a>
</code>
</div>
<div class="height-container">
Expand Down Expand Up @@ -481,6 +481,33 @@ <h4>Declaration</h4>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/c:@M@FormValidatorSwift@objc(cs)ValidatorTextField(im)dealloc"></a>
<a name="//apple_ref/swift/Method/deinit" class="dashAnchor"></a>
<a class="token" href="#/c:@M@FormValidatorSwift@objc(cs)ValidatorTextField(im)dealloc">deinit</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>

</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">deinit</span></code></pre>

</div>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
Expand All @@ -495,17 +522,17 @@ <h3 class="section-name">Custom Setters</h3>
<li class="item">
<div>
<code>
<a name="/s:18FormValidatorSwift0B9TextFieldC03setB8DelegateyAA0b7ControlG0_So06UITexteG0pF"></a>
<a name="/s:18FormValidatorSwift0B9TextFieldC03setB8DelegateyyAA0b7ControlG0_So06UITexteG0pF"></a>
<a name="//apple_ref/swift/Method/setValidatorDelegate(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:18FormValidatorSwift0B9TextFieldC03setB8DelegateyAA0b7ControlG0_So06UITexteG0pF">setValidatorDelegate(_:)</a>
<a class="token" href="#/s:18FormValidatorSwift0B9TextFieldC03setB8DelegateyyAA0b7ControlG0_So06UITexteG0pF">setValidatorDelegate(_:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<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>
<p>Sets the <code><a href="../Classes/ValidatorTextField.html#/s:18FormValidatorSwift0B9TextFieldC17validatorDelegateAA0b7ControlG0_pSgvp">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">
Expand Down Expand Up @@ -579,9 +606,9 @@ <h4>Declaration</h4>
<li class="item">
<div>
<code>
<a name="/s:18FormValidatorSwift0B9TextFieldC09validatordE18ViolatedConditionsySayAA9Condition_pGF"></a>
<a name="/s:18FormValidatorSwift0B9TextFieldC09validatordE18ViolatedConditionsyySayAA9Condition_pGF"></a>
<a name="//apple_ref/swift/Method/validatorTextFieldViolatedConditions(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:18FormValidatorSwift0B9TextFieldC09validatordE18ViolatedConditionsySayAA9Condition_pGF">validatorTextFieldViolatedConditions(_:)</a>
<a class="token" href="#/s:18FormValidatorSwift0B9TextFieldC09validatordE18ViolatedConditionsyySayAA9Condition_pGF">validatorTextFieldViolatedConditions(_:)</a>
</code>
</div>
<div class="height-container">
Expand Down Expand Up @@ -611,8 +638,8 @@ <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-04-25)</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>
<p>&copy; 2019 <a class="link" href="https://ustwo.com/" target="_blank" rel="external">ustwo Fampany Ltd.</a>. All rights reserved. (Last updated: 2019-04-24)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
</div>
Expand Down
Loading

0 comments on commit 5a5785f

Please sign in to comment.