Update the documentation.

bojan · Mar 31, 2018 · aa107e5 · aa107e5
1 parent 45143d1
commit aa107e5
Show file tree

Hide file tree

Showing 29 changed files with 291 additions and 207 deletions.
diff --git a/Sources/Device.swift b/Sources/Device.swift
@@ -70,7 +70,7 @@ public enum Device {
 	case iPad4
 	/// - iPad5: All iPad (2017) variants.
 	case iPad5
-	/// - iPad6: All iPad (2016) variants.
+	/// - iPad6: All iPad (2018) variants.
 	case iPad6
 	/// - iPadMini: The original iPad mini in all variants.
 	case iPadMini
@@ -184,10 +184,14 @@ public extension Device {
 
 // MARK: - Errors
 
+/// Errors thrown by Thingy.
+
 public enum ThingyError: Error {
-	case InvalidIdentifier
+	/// - An error thrown when devices of different families get compared.
 	case IncomparableFamilies
+	/// - An error thrown when devices from different product lines get compared.
 	case IncomparableProductLines
+	/// - An error thrown when an unknown device gets compared.
 	case IncomparableUnknownProduct
 }
 

diff --git a/docs/Enums.html b/docs/Enums.html
@@ -13,7 +13,7 @@
     <a title="Enumerations  Reference"></a>
     <header>
       <div class="content-wrapper">
-        <p><a href="index.html">Thingy Docs</a> (95% documented)</p>
+        <p><a href="index.html">Thingy Docs</a></p>
       </div>
     </header>
     <div class="content-wrapper">
@@ -126,7 +126,7 @@ <h3 class="section-name">Errors</h3>
                     <section class="section">
                       <div class="pointer"></div>
                       <div class="abstract">
-                        <p>Undocumented</p>
+                        <p>Errors thrown by Thingy.</p>
 
                         <a href="Enums/ThingyError.html" class="slightly-smaller">See more</a>
                       </div>
@@ -178,7 +178,7 @@ <h4>Declaration</h4>
           </section>
         </section>
         <section id="footer">
-          <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>
+          <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>
           <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>
       </article>

diff --git a/docs/Enums/Device.html b/docs/Enums/Device.html
@@ -14,7 +14,7 @@
     <a title="Device Enumeration Reference"></a>
     <header>
       <div class="content-wrapper">
-        <p><a href="../index.html">Thingy Docs</a> (95% documented)</p>
+        <p><a href="../index.html">Thingy Docs</a></p>
       </div>
     </header>
     <div class="content-wrapper">
@@ -691,6 +691,40 @@ <h4>Declaration</h4>
                 </li>
               </ul>
             </div>
+            <div class="task-group">
+              <ul>
+                <li class="item">
+                  <div>
+                    <code>
+                    <a name="/s:6Thingy6DeviceO5iPad6A2CmF"></a>
+                    <a name="//apple_ref/swift/Element/iPad6" class="dashAnchor"></a>
+                    <a class="token" href="#/s:6Thingy6DeviceO5iPad6A2CmF">iPad6</a>
+                    </code>
+                  </div>
+                  <div class="height-container">
+                    <div class="pointer-container"></div>
+                    <section class="section">
+                      <div class="pointer"></div>
+                      <div class="abstract">
+
+<ul>
+<li>iPad6: All iPad (2018) variants.</li>
+</ul>
+
+                      </div>
+                      <div class="declaration">
+                        <h4>Declaration</h4>
+                        <div class="language">
+                          <p class="aside-title">Swift</p>
+                          <pre class="highlight swift"><code><span class="k">case</span> <span class="n">iPad6</span></code></pre>
+
+                        </div>
+                      </div>
+                    </section>
+                  </div>
+                </li>
+              </ul>
+            </div>
             <div class="task-group">
               <ul>
                 <li class="item">
@@ -1804,7 +1838,7 @@ <h4>Return Value</h4>
           </section>
         </section>
         <section id="footer">
-          <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>
+          <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>
           <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>
       </article>

diff --git a/docs/Enums/Family.html b/docs/Enums/Family.html
@@ -14,7 +14,7 @@
     <a title="Family Enumeration Reference"></a>
     <header>
       <div class="content-wrapper">
-        <p><a href="../index.html">Thingy Docs</a> (95% documented)</p>
+        <p><a href="../index.html">Thingy Docs</a></p>
       </div>
     </header>
     <div class="content-wrapper">
@@ -281,7 +281,7 @@ <h4>Declaration</h4>
           </section>
         </section>
         <section id="footer">
-          <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>
+          <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>
           <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>
       </article>

diff --git a/docs/Enums/ThingyError.html b/docs/Enums/ThingyError.html
@@ -14,7 +14,7 @@
     <a title="ThingyError Enumeration Reference"></a>
     <header>
       <div class="content-wrapper">
-        <p><a href="../index.html">Thingy Docs</a> (95% documented)</p>
+        <p><a href="../index.html">Thingy Docs</a></p>
       </div>
     </header>
     <div class="content-wrapper">
@@ -73,41 +73,10 @@ <h1>ThingyError</h1>
 
                 </div>
               </div>
-            <p>Undocumented</p>
+            <p>Errors thrown by Thingy.</p>
 
           </section>
           <section class="section task-group-section">
-            <div class="task-group">
-              <ul>
-                <li class="item">
-                  <div>
-                    <code>
-                    <a name="/s:6Thingy0A5ErrorO17InvalidIdentifierA2CmF"></a>
-                    <a name="//apple_ref/swift/Element/InvalidIdentifier" class="dashAnchor"></a>
-                    <a class="token" href="#/s:6Thingy0A5ErrorO17InvalidIdentifierA2CmF">InvalidIdentifier</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="k">case</span> <span class="kt">InvalidIdentifier</span></code></pre>
-
-                        </div>
-                      </div>
-                    </section>
-                  </div>
-                </li>
-              </ul>
-            </div>
             <div class="task-group">
               <ul>
                 <li class="item">
@@ -123,7 +92,10 @@ <h4>Declaration</h4>
                     <section class="section">
                       <div class="pointer"></div>
                       <div class="abstract">
-                        <p>Undocumented</p>
+
+<ul>
+<li>An error thrown when devices of different families get compared.</li>
+</ul>
 
                       </div>
                       <div class="declaration">
@@ -154,7 +126,10 @@ <h4>Declaration</h4>
                     <section class="section">
                       <div class="pointer"></div>
                       <div class="abstract">
-                        <p>Undocumented</p>
+
+<ul>
+<li>An error thrown when devices from different product lines get compared.</li>
+</ul>
 
                       </div>
                       <div class="declaration">
@@ -185,7 +160,10 @@ <h4>Declaration</h4>
                     <section class="section">
                       <div class="pointer"></div>
                       <div class="abstract">
-                        <p>Undocumented</p>
+
+<ul>
+<li>An error thrown when an unknown device gets compared.</li>
+</ul>
 
                       </div>
                       <div class="declaration">
@@ -204,7 +182,7 @@ <h4>Declaration</h4>
           </section>
         </section>
         <section id="footer">
-          <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>
+          <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>
           <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>
       </article>

diff --git a/docs/Structs.html b/docs/Structs.html
@@ -13,7 +13,7 @@
     <a title="Structures  Reference"></a>
     <header>
       <div class="content-wrapper">
-        <p><a href="index.html">Thingy Docs</a> (95% documented)</p>
+        <p><a href="index.html">Thingy Docs</a></p>
       </div>
     </header>
     <div class="content-wrapper">
@@ -137,7 +137,7 @@ <h4>Declaration</h4>
           </section>
         </section>
         <section id="footer">
-          <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>
+          <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>
           <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>
       </article>

diff --git a/docs/Structs/Display.html b/docs/Structs/Display.html
@@ -14,7 +14,7 @@
     <a title="Display Structure Reference"></a>
     <header>
       <div class="content-wrapper">
-        <p><a href="../index.html">Thingy Docs</a> (95% documented)</p>
+        <p><a href="../index.html">Thingy Docs</a></p>
       </div>
     </header>
     <div class="content-wrapper">
@@ -356,7 +356,7 @@ <h4>Declaration</h4>
           </section>
         </section>
         <section id="footer">
-          <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>
+          <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>
           <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>
       </article>

diff --git a/docs/Structs/Display/ColorSpace.html b/docs/Structs/Display/ColorSpace.html
@@ -14,7 +14,7 @@
     <a title="ColorSpace Enumeration Reference"></a>
     <header>
       <div class="content-wrapper">
-        <p><a href="../../index.html">Thingy Docs</a> (95% documented)</p>
+        <p><a href="../../index.html">Thingy Docs</a></p>
       </div>
     </header>
     <div class="content-wrapper">
@@ -148,7 +148,7 @@ <h4>Declaration</h4>
           </section>
         </section>
         <section id="footer">
-          <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>
+          <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>
           <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>
       </article>

diff --git a/docs/Structs/Display/Size.html b/docs/Structs/Display/Size.html
@@ -14,7 +14,7 @@
     <a title="Size Enumeration Reference"></a>
     <header>
       <div class="content-wrapper">
-        <p><a href="../../index.html">Thingy Docs</a> (95% documented)</p>
+        <p><a href="../../index.html">Thingy Docs</a></p>
       </div>
     </header>
     <div class="content-wrapper">
@@ -485,10 +485,66 @@ <h4>Declaration</h4>
                 </li>
               </ul>
             </div>
+            <div class="task-group">
+              <ul>
+                <li class="item">
+                  <div>
+                    <code>
+                    <a name="/s:s10ComparableP1loiSbx_xtFZ"></a>
+                    <a name="//apple_ref/swift/Method/&lt;(_:_:)" class="dashAnchor"></a>
+                    <a class="token" href="#/s:s10ComparableP1loiSbx_xtFZ">&lt;(_:_:)</a>
+                    </code>
+                  </div>
+                  <div class="height-container">
+                    <div class="pointer-container"></div>
+                    <section class="section">
+                      <div class="pointer"></div>
+                      <div class="abstract">
+
+                      </div>
+                      <div class="declaration">
+                        <h4>Declaration</h4>
+                        <div class="language">
+                          <p class="aside-title">Swift</p>
+                          <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>
+
+                        </div>
+                      </div>
+                    </section>
+                  </div>
+                </li>
+                <li class="item">
+                  <div>
+                    <code>
+                    <a name="/s:s9EquatableP2eeoiSbx_xtFZ"></a>
+                    <a name="//apple_ref/swift/Method/==(_:_:)" class="dashAnchor"></a>
+                    <a class="token" href="#/s:s9EquatableP2eeoiSbx_xtFZ">==(_:_:)</a>
+                    </code>
+                  </div>
+                  <div class="height-container">
+                    <div class="pointer-container"></div>
+                    <section class="section">
+                      <div class="pointer"></div>
+                      <div class="abstract">
+
+                      </div>
+                      <div class="declaration">
+                        <h4>Declaration</h4>
+                        <div class="language">
+                          <p class="aside-title">Swift</p>
+                          <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>
+
+                        </div>
+                      </div>
+                    </section>
+                  </div>
+                </li>
+              </ul>
+            </div>
           </section>
         </section>
         <section id="footer">
-          <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>
+          <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>
           <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>
       </article>

diff --git a/docs/Structs/Lines.html b/docs/Structs/Lines.html
@@ -14,7 +14,7 @@
     <a title="Lines Structure Reference"></a>
     <header>
       <div class="content-wrapper">
-        <p><a href="../index.html">Thingy Docs</a> (95% documented)</p>
+        <p><a href="../index.html">Thingy Docs</a></p>
       </div>
     </header>
     <div class="content-wrapper">
@@ -112,7 +112,7 @@ <h4>Declaration</h4>
           </section>
         </section>
         <section id="footer">
-          <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>
+          <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>
           <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>
       </article>

diff --git a/docs/Structs/Lines/iPad.html b/docs/Structs/Lines/iPad.html
@@ -14,7 +14,7 @@
     <a title="iPad Enumeration Reference"></a>
     <header>
       <div class="content-wrapper">
-        <p><a href="../../index.html">Thingy Docs</a> (95% documented)</p>
+        <p><a href="../../index.html">Thingy Docs</a></p>
       </div>
     </header>
     <div class="content-wrapper">
@@ -247,7 +247,7 @@ <h4>Declaration</h4>
           </section>
         </section>
         <section id="footer">
-          <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>
+          <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>
           <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>
       </article>