added docs

Ramotion · Jun 7, 2016 · 7d2c2ef · 7d2c2ef
1 parent 91cadb4
commit 7d2c2ef
Show file tree

Hide file tree

Showing 32 changed files with 3,177 additions and 3 deletions.
diff --git a/Source/PaperOnboarding.swift b/Source/PaperOnboarding.swift
@@ -62,18 +62,20 @@ public protocol PaperOnboardingDelegate {
   func onboardingConfigurationItem(item: OnboardingContentViewItem, index: Int)
 }
 
+///An instance of PaperOnboarding which display collection of information.
 public class PaperOnboarding: UIView {
 
-  //  The object that acts as the data source of the  PaperOnboardingDataSource.
+  ///  The object that acts as the data source of the  PaperOnboardingDataSource.
   @IBOutlet public var dataSource: AnyObject? {
     didSet {
       commonInit()
     }
   }
 
-  // The object that acts as the delegate of the PaperOnboarding. PaperOnboardingDelegate protocol
+  /// The object that acts as the delegate of the PaperOnboarding. PaperOnboardingDelegate protocol
   @IBOutlet public var delegate: AnyObject?
 
+  /// current index item
   public private(set) var currentIndex: Int = 0
   var itemsCount: Int = 3
 
@@ -105,7 +107,7 @@ public class PaperOnboarding: UIView {
   }
 }
 
-// MARK: public
+// MARK: methods
 
 public extension PaperOnboarding {
 

diff --git a/docs/Classes.html b/docs/Classes.html
@@ -0,0 +1,100 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <title>Classes  Reference</title>
+    <link rel="stylesheet" type="text/css" href="css/jazzy.css" />
+    <link rel="stylesheet" type="text/css" href="css/highlight.css" />
+    <meta charset='utf-8'>
+    <script src="js/jquery.min.js" defer></script>
+    <script src="js/jazzy.js" defer></script>
+
+  </head>
+  <body>
+    <a title="Classes  Reference"></a>
+    <header>
+      <div class="content-wrapper">
+        <p><a href="index.html">PaperOnboardingDemo Docs</a> (100% documented)</p>
+      </div>
+    </header>
+    <div class="content-wrapper">
+      <p id="breadcrumbs">
+        <a href="index.html">PaperOnboardingDemo Reference</a>
+        <img id="carat" src="img/carat.png" />
+        Classes  Reference
+      </p>
+    </div>
+    <div class="content-wrapper">
+      <nav class="sidebar">
+        <ul class="nav-groups">
+          <li class="nav-group-name">
+            <a href="Classes.html">Classes</a>
+            <ul class="nav-group-tasks">
+              <li class="nav-group-task">
+                <a href="Classes/PaperOnboarding.html">PaperOnboarding</a>
+              </li>
+            </ul>
+          </li>
+          <li class="nav-group-name">
+            <a href="Protocols.html">Protocols</a>
+            <ul class="nav-group-tasks">
+              <li class="nav-group-task">
+                <a href="Protocols/PaperOnboardingDataSource.html">PaperOnboardingDataSource</a>
+              </li>
+              <li class="nav-group-task">
+                <a href="Protocols/PaperOnboardingDelegate.html">PaperOnboardingDelegate</a>
+              </li>
+            </ul>
+          </li>
+        </ul>
+      </nav>
+      <article class="main-content">
+        <section>
+          <section class="section">
+            <h1>Classes</h1>
+            <p>The following classes are available globally.</p>
+
+          </section>
+          <section class="section task-group-section">
+            <div class="task-group">
+              <ul>
+                <li class="item">
+                  <div>
+                    <code>
+                    <a name="/s:C19PaperOnboardingDemo15PaperOnboarding"></a>
+                    <a name="//apple_ref/swift/Class/PaperOnboarding" class="dashAnchor"></a>
+                    <a class="token" href="#/s:C19PaperOnboardingDemo15PaperOnboarding">PaperOnboarding</a>
+                    </code>
+                  </div>
+                  <div class="height-container">
+                    <div class="pointer-container"></div>
+                    <section class="section">
+                      <div class="pointer"></div>
+                      <div class="abstract">
+                        <p>An instance of PaperOnboarding which display collection of information.</p>
+
+                        <a href="Classes/PaperOnboarding.html" class="slightly-smaller">See more</a>
+                      </div>
+                      <div class="declaration">
+                        <h4>Declaration</h4>
+                        <div class="language">
+                          <p class="aside-title">Swift</p>
+                          <pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">PaperOnboarding</span><span class="p">:</span> <span class="kt">UIView</span></code></pre>
+
+                        </div>
+                      </div>
+                    </section>
+                  </div>
+                </li>
+              </ul>
+            </div>
+          </section>
+        </section>
+        <section id="footer">
+          <p>&copy; 2016 <a class="link" href="" target="_blank" rel="external">AlexKalinkin</a>. All rights reserved. (Last updated: 2016-06-07)</p>
+          <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.5.0</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
+        </section>
+      </article>
+    </div>
+  </body>
+</div>
+</html>