Update documentation to target 100%

MoveUpwards · May 7, 2019 · 972c250 · 972c250
1 parent f554e9e
commit 972c250
Show file tree

Hide file tree

Showing 225 changed files with 3,090 additions and 2,307 deletions.
diff --git a/Sejima/Source/MUButton/MUButton.swift b/Sejima/Source/MUButton/MUButton.swift
@@ -177,6 +177,7 @@ open class MUButton: MUNibView {
 
     // MARK: - Public functions
 
+    /// Set a custom button progress view
     open func set(_ progress: MUActivityIndicatorProtocol) {
         guard let progressView = progress as? UIView else {
             return

diff --git a/Sejima/Source/MUCollectionButton/MUCollectionButton.swift b/Sejima/Source/MUCollectionButton/MUCollectionButton.swift
@@ -131,6 +131,7 @@ open class MUCollectionButton: MUNibView {
 
     // MARK: - Public functions
 
+    /// Set a custom button progress view
     open func set(_ progress: MUActivityIndicatorProtocol) {
         guard let progressView = progress as? UIView else {
             return

diff --git a/Sejima/Source/MUCore/MUMath.swift b/Sejima/Source/MUCore/MUMath.swift
@@ -8,11 +8,15 @@
 
 import UIKit
 
+/// FloatingPoint protocol
 public protocol MUFloatingPoint: FloatingPoint {
+    /// A very close to 0 number
     static var epsilon: Self { get }
 
+    /// The hypotenuse of given numbers
     static func hypotenuse(_ lhs: Self, _ rhs: Self) -> Self
 
+    /// Return a floating point from a given double
     init(_ double: Double)
 }
 
@@ -29,33 +33,41 @@ extension FloatingPoint {
 }
 
 extension CGFloat: MUFloatingPoint {
+    /// A very close to 0 number
     public static let epsilon: CGFloat = 8.85418782e-12
 
+    /// The hypotenuse of given numbers
     public static func hypotenuse(_ lhs: CGFloat, _ rhs: CGFloat) -> CGFloat {
         return hypot(lhs, rhs)
     }
 }
 
 extension Double: MUFloatingPoint {
+    /// A very close to 0 number
     public static let epsilon: Double = 8.85418782e-12
 
+    /// The hypotenuse of given numbers
     public static func hypotenuse(_ lhs: Double, _ rhs: Double) -> Double {
         return hypot(lhs, rhs)
     }
 }
 
 extension Float: MUFloatingPoint {
+    /// A very close to 0 number
     public static let epsilon: Float = 8.85418782e-12
 
+    /// The hypotenuse of given numbers
     public static func hypotenuse(_ lhs: Float, _ rhs: Float) -> Float {
         return hypot(lhs, rhs)
     }
 }
 
 #if !os(Windows) && (arch(i386) || arch(x86_64))
 extension Float80: MUFloatingPoint {
+    /// A very close to 0 number
     public static let epsilon: Float80 = 8.85418782e-12
 
+    /// The hypotenuse of given numbers
     public static func hypotenuse(_ lhs: Float80, _ rhs: Float80) -> Float80 {
         return hypot(lhs, rhs)
     }

diff --git a/Sejima/Source/MUCore/MUTransform3D.swift b/Sejima/Source/MUCore/MUTransform3D.swift
@@ -10,6 +10,7 @@ import UIKit
 
 extension CATransform3D {
     // See: https://github.com/joshrl/FreeTransform/blob/master/FreeTransform/UIView%2BQuadrilateral.m
+    /// Create CATransform3D to fit quad inside a given bounds
     public init(toFit quad: MUQuad, from bounds: CGRect) {
         let x1a = quad.topLeft.x
         let y1a = quad.topLeft.y
@@ -50,6 +51,7 @@ extension CATransform3D {
     }
 
     // See: https://github.com/agens-no/AGGeometryKit/blob/master/AGGeometryKit/Categories/UIImage%2BAGKQuad.m
+    /// Create CATransform3D to fit quad inside a given quad
     public init(perspectiveFrom quad: MUQuad, to destinationQuad: MUQuad) {
         var matrixA: MUMatrix<CGFloat>
         var matrixB: MUMatrix<CGFloat>

diff --git a/Sejima/Source/MUCore/Protocol/MUActivityIndicatorProtocol.swift b/Sejima/Source/MUCore/Protocol/MUActivityIndicatorProtocol.swift
@@ -17,8 +17,8 @@ import UIKit.UIColor
     /// Stop indicator animation.
     func stopAnimating()
 
-    /// Progress indicator tint color.
     // implicit unwrap to be objc compliant (see UIActivityIndicatorView)
+    /// Progress indicator tint color.
     var color: UIColor! { get set } //swiftlint:disable:this implicitly_unwrapped_optional
 
     /// Hide indicator progress when not animating.

diff --git a/docs/Classes.html b/docs/Classes.html
@@ -23,7 +23,7 @@
         <a class="header-link" href="index.html">
           Sejima Docs
         </a>
-         (98% documented)
+         (100% documented)
       </p>
 
       <p class="header-col--secondary">
@@ -234,9 +234,6 @@
               <li class="nav-group-task">
                 <a class="nav-group-task-link" href="Extensions/CGFloat.html">CGFloat</a>
               </li>
-              <li class="nav-group-task">
-                <a class="nav-group-task-link" href="Extensions/Date.html">Date</a>
-              </li>
               <li class="nav-group-task">
                 <a class="nav-group-task-link" href="Extensions/Double.html">Double</a>
               </li>
@@ -255,9 +252,6 @@
               <li class="nav-group-task">
                 <a class="nav-group-task-link" href="Extensions/String.html">String</a>
               </li>
-              <li class="nav-group-task">
-                <a class="nav-group-task-link" href="Extensions/TimeInterval.html">TimeInterval</a>
-              </li>
               <li class="nav-group-task">
                 <a class="nav-group-task-link" href="Extensions/UIColor.html">UIColor</a>
               </li>
@@ -275,6 +269,9 @@
           <li class="nav-group-name">
             <a class="nav-group-name-link" href="Protocols.html">Protocols</a>
             <ul class="nav-group-tasks">
+              <li class="nav-group-task">
+                <a class="nav-group-task-link" href="Protocols/MUActivityIndicatorProtocol.html">MUActivityIndicatorProtocol</a>
+              </li>
               <li class="nav-group-task">
                 <a class="nav-group-task-link" href="Protocols/MUAvatarDelegate.html">MUAvatarDelegate</a>
               </li>
@@ -1931,7 +1928,7 @@ <h4>Declaration</h4>
                     <section class="section">
                       <div class="pointer"></div>
                       <div class="abstract">
-                        <p>Class that define a card (title, description and image) with screen animation.</p>
+                        <p>Class that define a card (title, description, indicator and image) with screen animation.</p>
 
                         <a href="Classes/MUToast.html" class="slightly-smaller">See more</a>
                       </div>
@@ -1988,8 +1985,8 @@ <h4>Declaration</h4>
       </article>
     </div>
     <section class="footer">
-      <p>&copy; 2019 <a class="link" href="https://moveupwards.dev" target="_blank" rel="external">MoveUpwards</a>. All rights reserved. (Last updated: 2019-03-29)</p>
-      <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
+      <p>&copy; 2019 <a class="link" href="https://moveupwards.dev" target="_blank" rel="external">MoveUpwards</a>. All rights reserved. (Last updated: 2019-05-07)</p>
+      <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
     </section>
   </body>
 </div>

diff --git a/docs/Classes/MUAvatar.html b/docs/Classes/MUAvatar.html
@@ -23,7 +23,7 @@
         <a class="header-link" href="../index.html">
           Sejima Docs
         </a>
-         (98% documented)
+         (100% documented)
       </p>
 
       <p class="header-col--secondary">
@@ -234,9 +234,6 @@
               <li class="nav-group-task">
                 <a class="nav-group-task-link" href="../Extensions/CGFloat.html">CGFloat</a>
               </li>
-              <li class="nav-group-task">
-                <a class="nav-group-task-link" href="../Extensions/Date.html">Date</a>
-              </li>
               <li class="nav-group-task">
                 <a class="nav-group-task-link" href="../Extensions/Double.html">Double</a>
               </li>
@@ -255,9 +252,6 @@
               <li class="nav-group-task">
                 <a class="nav-group-task-link" href="../Extensions/String.html">String</a>
               </li>
-              <li class="nav-group-task">
-                <a class="nav-group-task-link" href="../Extensions/TimeInterval.html">TimeInterval</a>
-              </li>
               <li class="nav-group-task">
                 <a class="nav-group-task-link" href="../Extensions/UIColor.html">UIColor</a>
               </li>
@@ -275,6 +269,9 @@
           <li class="nav-group-name">
             <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
             <ul class="nav-group-tasks">
+              <li class="nav-group-task">
+                <a class="nav-group-task-link" href="../Protocols/MUActivityIndicatorProtocol.html">MUActivityIndicatorProtocol</a>
+              </li>
               <li class="nav-group-task">
                 <a class="nav-group-task-link" href="../Protocols/MUAvatarDelegate.html">MUAvatarDelegate</a>
               </li>
@@ -724,8 +721,8 @@ <h4>Declaration</h4>
       </article>
     </div>
     <section class="footer">
-      <p>&copy; 2019 <a class="link" href="https://moveupwards.dev" target="_blank" rel="external">MoveUpwards</a>. All rights reserved. (Last updated: 2019-03-29)</p>
-      <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
+      <p>&copy; 2019 <a class="link" href="https://moveupwards.dev" target="_blank" rel="external">MoveUpwards</a>. All rights reserved. (Last updated: 2019-05-07)</p>
+      <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
     </section>
   </body>
 </div>

diff --git a/docs/Classes/MUBar.html b/docs/Classes/MUBar.html
@@ -23,7 +23,7 @@
         <a class="header-link" href="../index.html">
           Sejima Docs
         </a>
-         (98% documented)
+         (100% documented)
       </p>
 
       <p class="header-col--secondary">
@@ -234,9 +234,6 @@
               <li class="nav-group-task">
                 <a class="nav-group-task-link" href="../Extensions/CGFloat.html">CGFloat</a>
               </li>
-              <li class="nav-group-task">
-                <a class="nav-group-task-link" href="../Extensions/Date.html">Date</a>
-              </li>
               <li class="nav-group-task">
                 <a class="nav-group-task-link" href="../Extensions/Double.html">Double</a>
               </li>
@@ -255,9 +252,6 @@
               <li class="nav-group-task">
                 <a class="nav-group-task-link" href="../Extensions/String.html">String</a>
               </li>
-              <li class="nav-group-task">
-                <a class="nav-group-task-link" href="../Extensions/TimeInterval.html">TimeInterval</a>
-              </li>
               <li class="nav-group-task">
                 <a class="nav-group-task-link" href="../Extensions/UIColor.html">UIColor</a>
               </li>
@@ -275,6 +269,9 @@
           <li class="nav-group-name">
             <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
             <ul class="nav-group-tasks">
+              <li class="nav-group-task">
+                <a class="nav-group-task-link" href="../Protocols/MUActivityIndicatorProtocol.html">MUActivityIndicatorProtocol</a>
+              </li>
               <li class="nav-group-task">
                 <a class="nav-group-task-link" href="../Protocols/MUAvatarDelegate.html">MUAvatarDelegate</a>
               </li>
@@ -770,8 +767,8 @@ <h4>Declaration</h4>
       </article>
     </div>
     <section class="footer">
-      <p>&copy; 2019 <a class="link" href="https://moveupwards.dev" target="_blank" rel="external">MoveUpwards</a>. All rights reserved. (Last updated: 2019-03-29)</p>
-      <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
+      <p>&copy; 2019 <a class="link" href="https://moveupwards.dev" target="_blank" rel="external">MoveUpwards</a>. All rights reserved. (Last updated: 2019-05-07)</p>
+      <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
     </section>
   </body>
 </div>

diff --git a/docs/Classes/MUBarGraph.html b/docs/Classes/MUBarGraph.html
@@ -23,7 +23,7 @@
         <a class="header-link" href="../index.html">
           Sejima Docs
         </a>
-         (98% documented)
+         (100% documented)
       </p>
 
       <p class="header-col--secondary">
@@ -234,9 +234,6 @@
               <li class="nav-group-task">
                 <a class="nav-group-task-link" href="../Extensions/CGFloat.html">CGFloat</a>
               </li>
-              <li class="nav-group-task">
-                <a class="nav-group-task-link" href="../Extensions/Date.html">Date</a>
-              </li>
               <li class="nav-group-task">
                 <a class="nav-group-task-link" href="../Extensions/Double.html">Double</a>
               </li>
@@ -255,9 +252,6 @@
               <li class="nav-group-task">
                 <a class="nav-group-task-link" href="../Extensions/String.html">String</a>
               </li>
-              <li class="nav-group-task">
-                <a class="nav-group-task-link" href="../Extensions/TimeInterval.html">TimeInterval</a>
-              </li>
               <li class="nav-group-task">
                 <a class="nav-group-task-link" href="../Extensions/UIColor.html">UIColor</a>
               </li>
@@ -275,6 +269,9 @@
           <li class="nav-group-name">
             <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
             <ul class="nav-group-tasks">
+              <li class="nav-group-task">
+                <a class="nav-group-task-link" href="../Protocols/MUActivityIndicatorProtocol.html">MUActivityIndicatorProtocol</a>
+              </li>
               <li class="nav-group-task">
                 <a class="nav-group-task-link" href="../Protocols/MUAvatarDelegate.html">MUAvatarDelegate</a>
               </li>
@@ -890,8 +887,8 @@ <h4>Declaration</h4>
       </article>
     </div>
     <section class="footer">
-      <p>&copy; 2019 <a class="link" href="https://moveupwards.dev" target="_blank" rel="external">MoveUpwards</a>. All rights reserved. (Last updated: 2019-03-29)</p>
-      <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
+      <p>&copy; 2019 <a class="link" href="https://moveupwards.dev" target="_blank" rel="external">MoveUpwards</a>. All rights reserved. (Last updated: 2019-05-07)</p>
+      <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
     </section>
   </body>
 </div>