Skip to content

Commit aa107e5

Browse files
bojanbojan
committed
Update the documentation.
1 parent 45143d1 commit aa107e5

29 files changed

Lines changed: 291 additions & 207 deletions

‎Sources/Device.swift‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ public enum Device {
7070
case iPad4
7171
/// - iPad5: All iPad (2017) variants.
7272
case iPad5
73-
/// - iPad6: All iPad (2016) variants.
73+
/// - iPad6: All iPad (2018) variants.
7474
case iPad6
7575
/// - iPadMini: The original iPad mini in all variants.
7676
case iPadMini
@@ -184,10 +184,14 @@ public extension Device {
184184

185185
// MARK: - Errors
186186

187+
/// Errors thrown by Thingy.
188+
187189
public enum ThingyError: Error {
188-
case InvalidIdentifier
190+
/// - An error thrown when devices of different families get compared.
189191
case IncomparableFamilies
192+
/// - An error thrown when devices from different product lines get compared.
190193
case IncomparableProductLines
194+
/// - An error thrown when an unknown device gets compared.
191195
case IncomparableUnknownProduct
192196
}
193197

‎docs/Enums.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
<a title="Enumerations Reference"></a>
1414
<header>
1515
<div class="content-wrapper">
16-
<p><a href="index.html">Thingy Docs</a> (95% documented)</p>
16+
<p><a href="index.html">Thingy Docs</a></p>
1717
</div>
1818
</header>
1919
<div class="content-wrapper">
@@ -126,7 +126,7 @@ <h3 class="section-name">Errors</h3>
126126
<section class="section">
127127
<div class="pointer"></div>
128128
<div class="abstract">
129-
<p>Undocumented</p>
129+
<p>Errors thrown by Thingy.</p>
130130

131131
<a href="Enums/ThingyError.html" class="slightly-smaller">See more</a>
132132
</div>
@@ -178,7 +178,7 @@ <h4>Declaration</h4>
178178
</section>
179179
</section>
180180
<section id="footer">
181-
<p>&copy; 2018 <a class="link" href="https://github.com/bojan/Thingy" target="_blank" rel="external">Bojan Dimovski</a>. All rights reserved. (Last updated: 2018-01-29)</p>
181+
<p>&copy; 2018 <a class="link" href="https://github.com/bojan/Thingy" target="_blank" rel="external">Bojan Dimovski</a>. All rights reserved. (Last updated: 2018-03-31)</p>
182182
<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>
183183
</section>
184184
</article>

‎docs/Enums/Device.html‎

Lines changed: 36 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
<a title="Device Enumeration Reference"></a>
1515
<header>
1616
<div class="content-wrapper">
17-
<p><a href="../index.html">Thingy Docs</a> (95% documented)</p>
17+
<p><a href="../index.html">Thingy Docs</a></p>
1818
</div>
1919
</header>
2020
<div class="content-wrapper">
@@ -691,6 +691,40 @@ <h4>Declaration</h4>
691691
</li>
692692
</ul>
693693
</div>
694+
<div class="task-group">
695+
<ul>
696+
<li class="item">
697+
<div>
698+
<code>
699+
<a name="/s:6Thingy6DeviceO5iPad6A2CmF"></a>
700+
<a name="//apple_ref/swift/Element/iPad6" class="dashAnchor"></a>
701+
<a class="token" href="#/s:6Thingy6DeviceO5iPad6A2CmF">iPad6</a>
702+
</code>
703+
</div>
704+
<div class="height-container">
705+
<div class="pointer-container"></div>
706+
<section class="section">
707+
<div class="pointer"></div>
708+
<div class="abstract">
709+
710+
<ul>
711+
<li>iPad6: All iPad (2018) variants.</li>
712+
</ul>
713+
714+
</div>
715+
<div class="declaration">
716+
<h4>Declaration</h4>
717+
<div class="language">
718+
<p class="aside-title">Swift</p>
719+
<pre class="highlight swift"><code><span class="k">case</span> <span class="n">iPad6</span></code></pre>
720+
721+
</div>
722+
</div>
723+
</section>
724+
</div>
725+
</li>
726+
</ul>
727+
</div>
694728
<div class="task-group">
695729
<ul>
696730
<li class="item">
@@ -1804,7 +1838,7 @@ <h4>Return Value</h4>
18041838
</section>
18051839
</section>
18061840
<section id="footer">
1807-
<p>&copy; 2018 <a class="link" href="https://github.com/bojan/Thingy" target="_blank" rel="external">Bojan Dimovski</a>. All rights reserved. (Last updated: 2018-01-29)</p>
1841+
<p>&copy; 2018 <a class="link" href="https://github.com/bojan/Thingy" target="_blank" rel="external">Bojan Dimovski</a>. All rights reserved. (Last updated: 2018-03-31)</p>
18081842
<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>
18091843
</section>
18101844
</article>

‎docs/Enums/Family.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
<a title="Family Enumeration Reference"></a>
1515
<header>
1616
<div class="content-wrapper">
17-
<p><a href="../index.html">Thingy Docs</a> (95% documented)</p>
17+
<p><a href="../index.html">Thingy Docs</a></p>
1818
</div>
1919
</header>
2020
<div class="content-wrapper">
@@ -281,7 +281,7 @@ <h4>Declaration</h4>
281281
</section>
282282
</section>
283283
<section id="footer">
284-
<p>&copy; 2018 <a class="link" href="https://github.com/bojan/Thingy" target="_blank" rel="external">Bojan Dimovski</a>. All rights reserved. (Last updated: 2018-01-29)</p>
284+
<p>&copy; 2018 <a class="link" href="https://github.com/bojan/Thingy" target="_blank" rel="external">Bojan Dimovski</a>. All rights reserved. (Last updated: 2018-03-31)</p>
285285
<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>
286286
</section>
287287
</article>

‎docs/Enums/ThingyError.html‎

Lines changed: 15 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
<a title="ThingyError Enumeration Reference"></a>
1515
<header>
1616
<div class="content-wrapper">
17-
<p><a href="../index.html">Thingy Docs</a> (95% documented)</p>
17+
<p><a href="../index.html">Thingy Docs</a></p>
1818
</div>
1919
</header>
2020
<div class="content-wrapper">
@@ -73,41 +73,10 @@ <h1>ThingyError</h1>
7373

7474
</div>
7575
</div>
76-
<p>Undocumented</p>
76+
<p>Errors thrown by Thingy.</p>
7777

7878
</section>
7979
<section class="section task-group-section">
80-
<div class="task-group">
81-
<ul>
82-
<li class="item">
83-
<div>
84-
<code>
85-
<a name="/s:6Thingy0A5ErrorO17InvalidIdentifierA2CmF"></a>
86-
<a name="//apple_ref/swift/Element/InvalidIdentifier" class="dashAnchor"></a>
87-
<a class="token" href="#/s:6Thingy0A5ErrorO17InvalidIdentifierA2CmF">InvalidIdentifier</a>
88-
</code>
89-
</div>
90-
<div class="height-container">
91-
<div class="pointer-container"></div>
92-
<section class="section">
93-
<div class="pointer"></div>
94-
<div class="abstract">
95-
<p>Undocumented</p>
96-
97-
</div>
98-
<div class="declaration">
99-
<h4>Declaration</h4>
100-
<div class="language">
101-
<p class="aside-title">Swift</p>
102-
<pre class="highlight swift"><code><span class="k">case</span> <span class="kt">InvalidIdentifier</span></code></pre>
103-
104-
</div>
105-
</div>
106-
</section>
107-
</div>
108-
</li>
109-
</ul>
110-
</div>
11180
<div class="task-group">
11281
<ul>
11382
<li class="item">
@@ -123,7 +92,10 @@ <h4>Declaration</h4>
12392
<section class="section">
12493
<div class="pointer"></div>
12594
<div class="abstract">
126-
<p>Undocumented</p>
95+
96+
<ul>
97+
<li>An error thrown when devices of different families get compared.</li>
98+
</ul>
12799

128100
</div>
129101
<div class="declaration">
@@ -154,7 +126,10 @@ <h4>Declaration</h4>
154126
<section class="section">
155127
<div class="pointer"></div>
156128
<div class="abstract">
157-
<p>Undocumented</p>
129+
130+
<ul>
131+
<li>An error thrown when devices from different product lines get compared.</li>
132+
</ul>
158133

159134
</div>
160135
<div class="declaration">
@@ -185,7 +160,10 @@ <h4>Declaration</h4>
185160
<section class="section">
186161
<div class="pointer"></div>
187162
<div class="abstract">
188-
<p>Undocumented</p>
163+
164+
<ul>
165+
<li>An error thrown when an unknown device gets compared.</li>
166+
</ul>
189167

190168
</div>
191169
<div class="declaration">
@@ -204,7 +182,7 @@ <h4>Declaration</h4>
204182
</section>
205183
</section>
206184
<section id="footer">
207-
<p>&copy; 2018 <a class="link" href="https://github.com/bojan/Thingy" target="_blank" rel="external">Bojan Dimovski</a>. All rights reserved. (Last updated: 2018-01-29)</p>
185+
<p>&copy; 2018 <a class="link" href="https://github.com/bojan/Thingy" target="_blank" rel="external">Bojan Dimovski</a>. All rights reserved. (Last updated: 2018-03-31)</p>
208186
<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>
209187
</section>
210188
</article>

‎docs/Structs.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
<a title="Structures Reference"></a>
1414
<header>
1515
<div class="content-wrapper">
16-
<p><a href="index.html">Thingy Docs</a> (95% documented)</p>
16+
<p><a href="index.html">Thingy Docs</a></p>
1717
</div>
1818
</header>
1919
<div class="content-wrapper">
@@ -137,7 +137,7 @@ <h4>Declaration</h4>
137137
</section>
138138
</section>
139139
<section id="footer">
140-
<p>&copy; 2018 <a class="link" href="https://github.com/bojan/Thingy" target="_blank" rel="external">Bojan Dimovski</a>. All rights reserved. (Last updated: 2018-01-29)</p>
140+
<p>&copy; 2018 <a class="link" href="https://github.com/bojan/Thingy" target="_blank" rel="external">Bojan Dimovski</a>. All rights reserved. (Last updated: 2018-03-31)</p>
141141
<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>
142142
</section>
143143
</article>

‎docs/Structs/Display.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
<a title="Display Structure Reference"></a>
1515
<header>
1616
<div class="content-wrapper">
17-
<p><a href="../index.html">Thingy Docs</a> (95% documented)</p>
17+
<p><a href="../index.html">Thingy Docs</a></p>
1818
</div>
1919
</header>
2020
<div class="content-wrapper">
@@ -356,7 +356,7 @@ <h4>Declaration</h4>
356356
</section>
357357
</section>
358358
<section id="footer">
359-
<p>&copy; 2018 <a class="link" href="https://github.com/bojan/Thingy" target="_blank" rel="external">Bojan Dimovski</a>. All rights reserved. (Last updated: 2018-01-29)</p>
359+
<p>&copy; 2018 <a class="link" href="https://github.com/bojan/Thingy" target="_blank" rel="external">Bojan Dimovski</a>. All rights reserved. (Last updated: 2018-03-31)</p>
360360
<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>
361361
</section>
362362
</article>

‎docs/Structs/Display/ColorSpace.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
<a title="ColorSpace Enumeration Reference"></a>
1515
<header>
1616
<div class="content-wrapper">
17-
<p><a href="../../index.html">Thingy Docs</a> (95% documented)</p>
17+
<p><a href="../../index.html">Thingy Docs</a></p>
1818
</div>
1919
</header>
2020
<div class="content-wrapper">
@@ -148,7 +148,7 @@ <h4>Declaration</h4>
148148
</section>
149149
</section>
150150
<section id="footer">
151-
<p>&copy; 2018 <a class="link" href="https://github.com/bojan/Thingy" target="_blank" rel="external">Bojan Dimovski</a>. All rights reserved. (Last updated: 2018-01-29)</p>
151+
<p>&copy; 2018 <a class="link" href="https://github.com/bojan/Thingy" target="_blank" rel="external">Bojan Dimovski</a>. All rights reserved. (Last updated: 2018-03-31)</p>
152152
<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>
153153
</section>
154154
</article>

‎docs/Structs/Display/Size.html‎

Lines changed: 58 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
<a title="Size Enumeration Reference"></a>
1515
<header>
1616
<div class="content-wrapper">
17-
<p><a href="../../index.html">Thingy Docs</a> (95% documented)</p>
17+
<p><a href="../../index.html">Thingy Docs</a></p>
1818
</div>
1919
</header>
2020
<div class="content-wrapper">
@@ -485,10 +485,66 @@ <h4>Declaration</h4>
485485
</li>
486486
</ul>
487487
</div>
488+
<div class="task-group">
489+
<ul>
490+
<li class="item">
491+
<div>
492+
<code>
493+
<a name="/s:s10ComparableP1loiSbx_xtFZ"></a>
494+
<a name="//apple_ref/swift/Method/&lt;(_:_:)" class="dashAnchor"></a>
495+
<a class="token" href="#/s:s10ComparableP1loiSbx_xtFZ">&lt;(_:_:)</a>
496+
</code>
497+
</div>
498+
<div class="height-container">
499+
<div class="pointer-container"></div>
500+
<section class="section">
501+
<div class="pointer"></div>
502+
<div class="abstract">
503+
504+
</div>
505+
<div class="declaration">
506+
<h4>Declaration</h4>
507+
<div class="language">
508+
<p class="aside-title">Swift</p>
509+
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="o">&lt;</span><span class="p">(</span><span class="nv">lhs</span><span class="p">:</span> <span class="kt"><a href="../../Structs/Display.html">Display</a></span><span class="o">.</span><span class="kt">Size</span><span class="p">,</span> <span class="nv">rhs</span><span class="p">:</span> <span class="kt"><a href="../../Structs/Display.html">Display</a></span><span class="o">.</span><span class="kt">Size</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Bool</span></code></pre>
510+
511+
</div>
512+
</div>
513+
</section>
514+
</div>
515+
</li>
516+
<li class="item">
517+
<div>
518+
<code>
519+
<a name="/s:s9EquatableP2eeoiSbx_xtFZ"></a>
520+
<a name="//apple_ref/swift/Method/==(_:_:)" class="dashAnchor"></a>
521+
<a class="token" href="#/s:s9EquatableP2eeoiSbx_xtFZ">==(_:_:)</a>
522+
</code>
523+
</div>
524+
<div class="height-container">
525+
<div class="pointer-container"></div>
526+
<section class="section">
527+
<div class="pointer"></div>
528+
<div class="abstract">
529+
530+
</div>
531+
<div class="declaration">
532+
<h4>Declaration</h4>
533+
<div class="language">
534+
<p class="aside-title">Swift</p>
535+
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="o">==</span><span class="p">(</span><span class="nv">lhs</span><span class="p">:</span> <span class="kt"><a href="../../Structs/Display.html">Display</a></span><span class="o">.</span><span class="kt">Size</span><span class="p">,</span> <span class="nv">rhs</span><span class="p">:</span> <span class="kt"><a href="../../Structs/Display.html">Display</a></span><span class="o">.</span><span class="kt">Size</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Bool</span></code></pre>
536+
537+
</div>
538+
</div>
539+
</section>
540+
</div>
541+
</li>
542+
</ul>
543+
</div>
488544
</section>
489545
</section>
490546
<section id="footer">
491-
<p>&copy; 2018 <a class="link" href="https://github.com/bojan/Thingy" target="_blank" rel="external">Bojan Dimovski</a>. All rights reserved. (Last updated: 2018-01-29)</p>
547+
<p>&copy; 2018 <a class="link" href="https://github.com/bojan/Thingy" target="_blank" rel="external">Bojan Dimovski</a>. All rights reserved. (Last updated: 2018-03-31)</p>
492548
<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>
493549
</section>
494550
</article>

‎docs/Structs/Lines.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
<a title="Lines Structure Reference"></a>
1515
<header>
1616
<div class="content-wrapper">
17-
<p><a href="../index.html">Thingy Docs</a> (95% documented)</p>
17+
<p><a href="../index.html">Thingy Docs</a></p>
1818
</div>
1919
</header>
2020
<div class="content-wrapper">
@@ -112,7 +112,7 @@ <h4>Declaration</h4>
112112
</section>
113113
</section>
114114
<section id="footer">
115-
<p>&copy; 2018 <a class="link" href="https://github.com/bojan/Thingy" target="_blank" rel="external">Bojan Dimovski</a>. All rights reserved. (Last updated: 2018-01-29)</p>
115+
<p>&copy; 2018 <a class="link" href="https://github.com/bojan/Thingy" target="_blank" rel="external">Bojan Dimovski</a>. All rights reserved. (Last updated: 2018-03-31)</p>
116116
<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>
117117
</section>
118118
</article>

0 commit comments

Comments
 (0)