Add more docs

Ahwinds · Jan 27, 2019 · 3196d55 · 3196d55
1 parent 155af34
commit 3196d55
Show file tree

Hide file tree

Showing 43 changed files with 276 additions and 133 deletions.
diff --git a/README.md b/README.md
@@ -19,6 +19,7 @@ Besides all the features a *Side Menu* should have, it supports:
 - Rubber band effect while panning
 - Custom transition animation
 - RTL supports
+- [API References](https://kukushi.github.io/SideMenu)
 
 ## Preview
 

diff --git a/SideMenu/Delegate.swift b/SideMenu/Delegate.swift
@@ -29,7 +29,21 @@ public protocol SideMenuControllerDelegate: class {
 
     // MARK: Switching
 
+
+    /// Side menu will show a view controller.
+    ///
+    /// - Parameters:
+    ///   - sideMenuController: current side menu controller
+    ///   - viewController: the view controller to show
+    ///   - animated: whether it's animated
     func sideMenuController(_ sideMenuController: SideMenuController, willShow viewController: UIViewController, animated: Bool)
+
+    /// Side menu did showed a view controller.
+    ///
+    /// - Parameters:
+    ///   - sideMenuController: current side menu controller
+    ///   - viewController: the view controller shown
+    ///   - animated: whether it's animated
     func sideMenuController(_ sideMenuController: SideMenuController, didShow viewController: UIViewController, animated: Bool)
 
     // MARK: Revealing

diff --git a/SideMenu/Preferences.swift b/SideMenu/Preferences.swift
@@ -106,7 +106,11 @@ extension SideMenuController {
             public var supportedOrientations: UIInterfaceOrientationMask = .portrait
         }
 
+
+        /// The basic configuration of side menu
         public var basic = Configuration()
+
+        /// The animation configuration of side menu
         public var animation = Animation()
     }
 }
diff --git a/SideMenu/Segue.swift b/SideMenu/Segue.swift
@@ -23,6 +23,8 @@ open class SideMenuSegue: UIStoryboardSegue {
     /// current content type
     public var contentType = ContentType.content
 
+    /// Peforming the segue, will change the corresponding view controller of side menu to `destination` vew controller.
+    /// This method is called when loading from storyboard.
     open override func perform() {
         guard let sideMenuController = source as? SideMenuController else {
             return

diff --git a/SideMenu/UIViewController+SideMenu.swift b/SideMenu/UIViewController+SideMenu.swift
@@ -11,7 +11,7 @@ import UIKit
 // Provides access to the side menu controller
 public extension UIViewController {
 
-    /// Access the nearest ancestor view controller  hierarchy that is a side menu controller.
+    /// Access the nearest ancestor view controller hierarchy that is a side menu controller.
     public var sideMenuController: SideMenuController? {
         return findSideMenuController(from: self)
     }

diff --git a/docs/Classes.html b/docs/Classes.html
@@ -23,7 +23,7 @@
         <a class="header-link" href="index.html">
           SideMenu Docs
         </a>
-         (51% documented)
+         (58% documented)
       </p>
 
       <p class="header-col--secondary">
@@ -216,7 +216,7 @@ <h4>Declaration</h4>
                         </div>
                       </div>
                       <div class="slightly-smaller">
-                        <a href="https://github.com/kukushi/SideMenu/1.0.0/SideMenu/Segue.swift#L12-L39">Show on GitHub</a>
+                        <a href="https://github.com/kukushi/SideMenu/1.0.0/SideMenu/Segue.swift#L12-L41">Show on GitHub</a>
                       </div>
                     </section>
                   </div>

diff --git a/docs/Classes/BasicTransitionAnimator.html b/docs/Classes/BasicTransitionAnimator.html
@@ -23,7 +23,7 @@
         <a class="header-link" href="../index.html">
           SideMenu Docs
         </a>
-         (51% documented)
+         (58% documented)
       </p>
 
       <p class="header-col--secondary">

diff --git a/docs/Classes/SideMenuController.html b/docs/Classes/SideMenuController.html
@@ -23,7 +23,7 @@
         <a class="header-link" href="../index.html">
           SideMenu Docs
         </a>
-         (51% documented)
+         (58% documented)
       </p>
 
       <p class="header-col--secondary">
@@ -1095,7 +1095,7 @@ <h4>Declaration</h4>
                         </div>
                       </div>
                       <div class="slightly-smaller">
-                        <a href="https://github.com/kukushi/SideMenu/1.0.0/SideMenu/Preferences.swift#L13-L111">Show on GitHub</a>
+                        <a href="https://github.com/kukushi/SideMenu/1.0.0/SideMenu/Preferences.swift#L13-L115">Show on GitHub</a>
                       </div>
                     </section>
                   </div>

diff --git a/docs/Classes/SideMenuController/Preferences.html b/docs/Classes/SideMenuController/Preferences.html
@@ -23,7 +23,7 @@
         <a class="header-link" href="../../index.html">
           SideMenu Docs
         </a>
-         (51% documented)
+         (58% documented)
       </p>
 
       <p class="header-col--secondary">
@@ -301,7 +301,7 @@ <h4>Declaration</h4>
                     <section class="section">
                       <div class="pointer"></div>
                       <div class="abstract">
-                        <p>Undocumented</p>
+                        <p>The basic configuration of side menu</p>
 
                       </div>
                       <div class="declaration">
@@ -313,7 +313,7 @@ <h4>Declaration</h4>
                         </div>
                       </div>
                       <div class="slightly-smaller">
-                        <a href="https://github.com/kukushi/SideMenu/1.0.0/SideMenu/Preferences.swift#L">Show on GitHub</a>
+                        <a href="https://github.com/kukushi/SideMenu/1.0.0/SideMenu/Preferences.swift#L111">Show on GitHub</a>
                       </div>
                     </section>
                   </div>
@@ -331,7 +331,7 @@ <h4>Declaration</h4>
                     <section class="section">
                       <div class="pointer"></div>
                       <div class="abstract">
-                        <p>Undocumented</p>
+                        <p>The animation configuration of side menu</p>
 
                       </div>
                       <div class="declaration">
@@ -343,7 +343,7 @@ <h4>Declaration</h4>
                         </div>
                       </div>
                       <div class="slightly-smaller">
-                        <a href="https://github.com/kukushi/SideMenu/1.0.0/SideMenu/Preferences.swift#L">Show on GitHub</a>
+                        <a href="https://github.com/kukushi/SideMenu/1.0.0/SideMenu/Preferences.swift#L114">Show on GitHub</a>
                       </div>
                     </section>
                   </div>

diff --git a/docs/Classes/SideMenuController/Preferences/Animation.html b/docs/Classes/SideMenuController/Preferences/Animation.html
@@ -23,7 +23,7 @@
         <a class="header-link" href="../../../index.html">
           SideMenu Docs
         </a>
-         (51% documented)
+         (58% documented)
       </p>
 
       <p class="header-col--secondary">

diff --git a/docs/Classes/SideMenuController/Preferences/Configuration.html b/docs/Classes/SideMenuController/Preferences/Configuration.html
@@ -23,7 +23,7 @@
         <a class="header-link" href="../../../index.html">
           SideMenu Docs
         </a>
-         (51% documented)
+         (58% documented)
       </p>
 
       <p class="header-col--secondary">

diff --git a/docs/Classes/SideMenuController/Preferences/MenuDirection.html b/docs/Classes/SideMenuController/Preferences/MenuDirection.html
@@ -23,7 +23,7 @@
         <a class="header-link" href="../../../index.html">
           SideMenu Docs
         </a>
-         (51% documented)
+         (58% documented)
       </p>
 
       <p class="header-col--secondary">

diff --git a/docs/Classes/SideMenuController/Preferences/MenuPosition.html b/docs/Classes/SideMenuController/Preferences/MenuPosition.html
@@ -23,7 +23,7 @@
         <a class="header-link" href="../../../index.html">
           SideMenu Docs
         </a>
-         (51% documented)
+         (58% documented)
       </p>
 
       <p class="header-col--secondary">

diff --git a/docs/Classes/SideMenuController/Preferences/StatusBarBehavior.html b/docs/Classes/SideMenuController/Preferences/StatusBarBehavior.html
@@ -23,7 +23,7 @@
         <a class="header-link" href="../../../index.html">
           SideMenu Docs
         </a>
-         (51% documented)
+         (58% documented)
       </p>
 
       <p class="header-col--secondary">

diff --git a/docs/Classes/SideMenuSegue.html b/docs/Classes/SideMenuSegue.html
@@ -23,7 +23,7 @@
         <a class="header-link" href="../index.html">
           SideMenu Docs
         </a>
-         (51% documented)
+         (58% documented)
       </p>
 
       <p class="header-col--secondary">
@@ -193,7 +193,8 @@ <h4>Declaration</h4>
                     <section class="section">
                       <div class="pointer"></div>
                       <div class="abstract">
-                        <p>Undocumented</p>
+                        <p>Peforming the segue, will change the corresponding view controller of side menu to <code>destination</code> vew controller.
+This method is called when loading from storyboard.</p>
 
                       </div>
                       <div class="declaration">
@@ -205,7 +206,7 @@ <h4>Declaration</h4>
                         </div>
                       </div>
                       <div class="slightly-smaller">
-                        <a href="https://github.com/kukushi/SideMenu/1.0.0/SideMenu/Segue.swift#L26-L37">Show on GitHub</a>
+                        <a href="https://github.com/kukushi/SideMenu/1.0.0/SideMenu/Segue.swift#L28-L39">Show on GitHub</a>
                       </div>
                     </section>
                   </div>

diff --git a/docs/Classes/SideMenuSegue/ContentType.html b/docs/Classes/SideMenuSegue/ContentType.html
@@ -23,7 +23,7 @@
         <a class="header-link" href="../../index.html">
           SideMenu Docs
         </a>
-         (51% documented)
+         (58% documented)
       </p>
 
       <p class="header-col--secondary">

diff --git a/docs/Extensions.html b/docs/Extensions.html
@@ -23,7 +23,7 @@
         <a class="header-link" href="index.html">
           SideMenu Docs
         </a>
-         (51% documented)
+         (58% documented)
       </p>
 
       <p class="header-col--secondary">

diff --git a/docs/Extensions/UIViewController.html b/docs/Extensions/UIViewController.html
@@ -23,7 +23,7 @@
         <a class="header-link" href="../index.html">
           SideMenu Docs
         </a>
-         (51% documented)
+         (58% documented)
       </p>
 
       <p class="header-col--secondary">
@@ -126,7 +126,7 @@ <h1>UIViewController</h1>
                     <section class="section">
                       <div class="pointer"></div>
                       <div class="abstract">
-                        <p>Access the nearest ancestor view controller  hierarchy that is a side menu controller.</p>
+                        <p>Access the nearest ancestor view controller hierarchy that is a side menu controller.</p>
 
                       </div>
                       <div class="declaration">

diff --git a/docs/Protocols.html b/docs/Protocols.html
@@ -23,7 +23,7 @@
         <a class="header-link" href="index.html">
           SideMenu Docs
         </a>
-         (51% documented)
+         (58% documented)
       </p>
 
       <p class="header-col--secondary">
@@ -134,7 +134,7 @@ <h4>Declaration</h4>
                         </div>
                       </div>
                       <div class="slightly-smaller">
-                        <a href="https://github.com/kukushi/SideMenu/1.0.0/SideMenu/Delegate.swift#L13-L62">Show on GitHub</a>
+                        <a href="https://github.com/kukushi/SideMenu/1.0.0/SideMenu/Delegate.swift#L13-L76">Show on GitHub</a>
                       </div>
                     </section>
                   </div>