Skip to content

Commit 5a5785f

Browse files
author
Aaron McTavish
committed
Update documentation for v4.0.0
1 parent 0b110d1 commit 5a5785f

File tree

117 files changed

+1792
-1680
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

117 files changed

+1792
-1680
lines changed

docs/Classes.html

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
</head>
1515
<body>
1616

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

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

@@ -22,7 +23,7 @@
2223
<a class="header-link" href="index.html">
2324
FormValidatorSwift Docs
2425
</a>
25-
(73% documented)
26+
(72% documented)
2627
</p>
2728

2829
<p class="header-col--secondary">
@@ -256,7 +257,7 @@ <h1>Classes</h1>
256257
<h4>Declaration</h4>
257258
<div class="language">
258259
<p class="aside-title">Swift</p>
259-
<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>
260+
<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>
260261

261262
</div>
262263
</div>
@@ -288,7 +289,7 @@ <h4>Declaration</h4>
288289
<h4>Declaration</h4>
289290
<div class="language">
290291
<p class="aside-title">Swift</p>
291-
<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>
292+
<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>
292293

293294
</div>
294295
</div>
@@ -303,8 +304,8 @@ <h4>Declaration</h4>
303304
</article>
304305
</div>
305306
<section class="footer">
306-
<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>
307-
<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>
307+
<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>
308+
<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>
308309
</section>
309310
</body>
310311
</div>

docs/Classes/ValidatorTextField.html

Lines changed: 48 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
<a class="header-link" href="../index.html">
2424
FormValidatorSwift Docs
2525
</a>
26-
(73% documented)
26+
(72% documented)
2727
</p>
2828

2929
<p class="header-col--secondary">
@@ -229,7 +229,7 @@
229229
<h1>ValidatorTextField</h1>
230230
<div class="declaration">
231231
<div class="language">
232-
<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>
232+
<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>
233233

234234
</div>
235235
</div>
@@ -269,7 +269,7 @@ <h3 class="section-name">Properties</h3>
269269
<h4>Declaration</h4>
270270
<div class="language">
271271
<p class="aside-title">Swift</p>
272-
<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>
272+
<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>
273273

274274
</div>
275275
</div>
@@ -296,7 +296,7 @@ <h4>Declaration</h4>
296296
<h4>Declaration</h4>
297297
<div class="language">
298298
<p class="aside-title">Swift</p>
299-
<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>
299+
<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>
300300

301301
</div>
302302
</div>
@@ -323,7 +323,7 @@ <h4>Declaration</h4>
323323
<h4>Declaration</h4>
324324
<div class="language">
325325
<p class="aside-title">Swift</p>
326-
<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>
326+
<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>
327327

328328
</div>
329329
</div>
@@ -333,9 +333,9 @@ <h4>Declaration</h4>
333333
<li class="item">
334334
<div>
335335
<code>
336-
<a name="/s:18FormValidatorSwift0B9TextFieldC17validatorDelegateAA0b7ControlG0_pSgXwvp"></a>
336+
<a name="/s:18FormValidatorSwift0B9TextFieldC17validatorDelegateAA0b7ControlG0_pSgvp"></a>
337337
<a name="//apple_ref/swift/Property/validatorDelegate" class="dashAnchor"></a>
338-
<a class="token" href="#/s:18FormValidatorSwift0B9TextFieldC17validatorDelegateAA0b7ControlG0_pSgXwvp">validatorDelegate</a>
338+
<a class="token" href="#/s:18FormValidatorSwift0B9TextFieldC17validatorDelegateAA0b7ControlG0_pSgvp">validatorDelegate</a>
339339
</code>
340340
</div>
341341
<div class="height-container">
@@ -346,7 +346,7 @@ <h4>Declaration</h4>
346346
<p>Validator delegate for the text field.</p>
347347
<div class="aside aside-see-also">
348348
<p class="aside-title">See also</p>
349-
<code><a href="../Classes/ValidatorTextField.html#/s:18FormValidatorSwift0B9TextFieldC03setB8DelegateyAA0b7ControlG0_So06UITexteG0pF">setValidatorDelegate(_:)</a></code> to set the validator delegate.
349+
<code><a href="../Classes/ValidatorTextField.html#/s:18FormValidatorSwift0B9TextFieldC03setB8DelegateyyAA0b7ControlG0_So06UITexteG0pF">setValidatorDelegate(_:)</a></code> to set the validator delegate.
350350

351351
</div>
352352

@@ -355,7 +355,7 @@ <h4>Declaration</h4>
355355
<h4>Declaration</h4>
356356
<div class="language">
357357
<p class="aside-title">Swift</p>
358-
<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>
358+
<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>
359359

360360
</div>
361361
</div>
@@ -382,7 +382,7 @@ <h4>Declaration</h4>
382382
<h4>Declaration</h4>
383383
<div class="language">
384384
<p class="aside-title">Swift</p>
385-
<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>
385+
<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>
386386

387387
</div>
388388
</div>
@@ -403,9 +403,9 @@ <h3 class="section-name">Initializers</h3>
403403
<li class="item">
404404
<div>
405405
<code>
406-
<a name="/s:18FormValidatorSwift0B9TextFieldCAcA0B0_p9validator_tcfc"></a>
406+
<a name="/s:18FormValidatorSwift0B9TextFieldC9validatorAcA0B0_p_tcfc"></a>
407407
<a name="//apple_ref/swift/Method/init(validator:)" class="dashAnchor"></a>
408-
<a class="token" href="#/s:18FormValidatorSwift0B9TextFieldCAcA0B0_p9validator_tcfc">init(validator:)</a>
408+
<a class="token" href="#/s:18FormValidatorSwift0B9TextFieldC9validatorAcA0B0_p_tcfc">init(validator:)</a>
409409
</code>
410410
</div>
411411
<div class="height-container">
@@ -430,9 +430,9 @@ <h4>Declaration</h4>
430430
<li class="item">
431431
<div>
432432
<code>
433-
<a name="/s:18FormValidatorSwift0B9TextFieldCACSC6CGRectV5frame_AA0B0_p9validatortcfc"></a>
433+
<a name="/s:18FormValidatorSwift0B9TextFieldC5frame9validatorACSo6CGRectV_AA0B0_ptcfc"></a>
434434
<a name="//apple_ref/swift/Method/init(frame:validator:)" class="dashAnchor"></a>
435-
<a class="token" href="#/s:18FormValidatorSwift0B9TextFieldCACSC6CGRectV5frame_AA0B0_p9validatortcfc">init(frame:validator:)</a>
435+
<a class="token" href="#/s:18FormValidatorSwift0B9TextFieldC5frame9validatorACSo6CGRectV_AA0B0_ptcfc">init(frame:validator:)</a>
436436
</code>
437437
</div>
438438
<div class="height-container">
@@ -481,6 +481,33 @@ <h4>Declaration</h4>
481481
</section>
482482
</div>
483483
</li>
484+
<li class="item">
485+
<div>
486+
<code>
487+
<a name="/c:@M@FormValidatorSwift@objc(cs)ValidatorTextField(im)dealloc"></a>
488+
<a name="//apple_ref/swift/Method/deinit" class="dashAnchor"></a>
489+
<a class="token" href="#/c:@M@FormValidatorSwift@objc(cs)ValidatorTextField(im)dealloc">deinit</a>
490+
</code>
491+
</div>
492+
<div class="height-container">
493+
<div class="pointer-container"></div>
494+
<section class="section">
495+
<div class="pointer"></div>
496+
<div class="abstract">
497+
<p>Undocumented</p>
498+
499+
</div>
500+
<div class="declaration">
501+
<h4>Declaration</h4>
502+
<div class="language">
503+
<p class="aside-title">Swift</p>
504+
<pre class="highlight swift"><code><span class="kd">deinit</span></code></pre>
505+
506+
</div>
507+
</div>
508+
</section>
509+
</div>
510+
</li>
484511
</ul>
485512
</div>
486513
<div class="task-group">
@@ -495,17 +522,17 @@ <h3 class="section-name">Custom Setters</h3>
495522
<li class="item">
496523
<div>
497524
<code>
498-
<a name="/s:18FormValidatorSwift0B9TextFieldC03setB8DelegateyAA0b7ControlG0_So06UITexteG0pF"></a>
525+
<a name="/s:18FormValidatorSwift0B9TextFieldC03setB8DelegateyyAA0b7ControlG0_So06UITexteG0pF"></a>
499526
<a name="//apple_ref/swift/Method/setValidatorDelegate(_:)" class="dashAnchor"></a>
500-
<a class="token" href="#/s:18FormValidatorSwift0B9TextFieldC03setB8DelegateyAA0b7ControlG0_So06UITexteG0pF">setValidatorDelegate(_:)</a>
527+
<a class="token" href="#/s:18FormValidatorSwift0B9TextFieldC03setB8DelegateyyAA0b7ControlG0_So06UITexteG0pF">setValidatorDelegate(_:)</a>
501528
</code>
502529
</div>
503530
<div class="height-container">
504531
<div class="pointer-container"></div>
505532
<section class="section">
506533
<div class="pointer"></div>
507534
<div class="abstract">
508-
<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>
535+
<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>
509536

510537
</div>
511538
<div class="declaration">
@@ -579,9 +606,9 @@ <h4>Declaration</h4>
579606
<li class="item">
580607
<div>
581608
<code>
582-
<a name="/s:18FormValidatorSwift0B9TextFieldC09validatordE18ViolatedConditionsySayAA9Condition_pGF"></a>
609+
<a name="/s:18FormValidatorSwift0B9TextFieldC09validatordE18ViolatedConditionsyySayAA9Condition_pGF"></a>
583610
<a name="//apple_ref/swift/Method/validatorTextFieldViolatedConditions(_:)" class="dashAnchor"></a>
584-
<a class="token" href="#/s:18FormValidatorSwift0B9TextFieldC09validatordE18ViolatedConditionsySayAA9Condition_pGF">validatorTextFieldViolatedConditions(_:)</a>
611+
<a class="token" href="#/s:18FormValidatorSwift0B9TextFieldC09validatordE18ViolatedConditionsyySayAA9Condition_pGF">validatorTextFieldViolatedConditions(_:)</a>
585612
</code>
586613
</div>
587614
<div class="height-container">
@@ -611,8 +638,8 @@ <h4>Declaration</h4>
611638
</article>
612639
</div>
613640
<section class="footer">
614-
<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>
615-
<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>
641+
<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>
642+
<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>
616643
</section>
617644
</body>
618645
</div>

0 commit comments

Comments
 (0)