Created Jazzy docs

carrot-ar · Nov 7, 2017 · c8f8526 · c8f8526
1 parent 8090f71
commit c8f8526
Show file tree

Hide file tree

Showing 41 changed files with 4,111 additions and 0 deletions.
diff --git a/Parrot/BeaconAdvertiser.swift b/Parrot/BeaconAdvertiser.swift
@@ -86,6 +86,7 @@ public final class BeaconAdvertiser: NSObject {
   }
 }
 
+/// :nodoc:
 extension BeaconAdvertiser: CBPeripheralManagerDelegate {
 
   public func peripheralManagerDidUpdateState(_ peripheral: CBPeripheralManager) {

diff --git a/Parrot/BeaconMonitor.swift b/Parrot/BeaconMonitor.swift
@@ -100,6 +100,7 @@ public final class BeaconMonitor: NSObject {
   }
 }
 
+/// :nodoc:
 extension BeaconMonitor: CLLocationManagerDelegate {
 
   public func locationManager(

diff --git a/docs/Classes.html b/docs/Classes.html
@@ -0,0 +1,138 @@
+<!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"> Docs</a> (100% documented)</p>
+      </div>
+    </header>
+    <div class="content-wrapper">
+      <p id="breadcrumbs">
+        <a href="index.html"> 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/BeaconAdvertiser.html">BeaconAdvertiser</a>
+              </li>
+              <li class="nav-group-task">
+                <a href="Classes/BeaconMonitor.html">BeaconMonitor</a>
+              </li>
+            </ul>
+          </li>
+          <li class="nav-group-name">
+            <a href="Enums.html">Enumerations</a>
+            <ul class="nav-group-tasks">
+              <li class="nav-group-task">
+                <a href="Enums/BeaconAdvertiserError.html">BeaconAdvertiserError</a>
+              </li>
+              <li class="nav-group-task">
+                <a href="Enums/BeaconAdvertisingState.html">BeaconAdvertisingState</a>
+              </li>
+              <li class="nav-group-task">
+                <a href="Enums/BeaconRegionParams.html">BeaconRegionParams</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="/c:@M@Parrot@objc(cs)BeaconMonitor"></a>
+                    <a name="//apple_ref/swift/Class/BeaconMonitor" class="dashAnchor"></a>
+                    <a class="token" href="#/c:@M@Parrot@objc(cs)BeaconMonitor">BeaconMonitor</a>
+                    </code>
+                  </div>
+                  <div class="height-container">
+                    <div class="pointer-container"></div>
+                    <section class="section">
+                      <div class="pointer"></div>
+                      <div class="abstract">
+                        <p>A class that allows a <code>CLBeaconRegion</code> to be monitored.</p>
+
+                        <a href="Classes/BeaconMonitor.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">final</span> <span class="kd">class</span> <span class="kt">BeaconMonitor</span><span class="p">:</span> <span class="kt">NSObject</span></code></pre>
+
+                        </div>
+                      </div>
+                    </section>
+                  </div>
+                </li>
+              </ul>
+            </div>
+            <div class="task-group">
+              <ul>
+                <li class="item">
+                  <div>
+                    <code>
+                    <a name="/c:@M@Parrot@objc(cs)BeaconAdvertiser"></a>
+                    <a name="//apple_ref/swift/Class/BeaconAdvertiser" class="dashAnchor"></a>
+                    <a class="token" href="#/c:@M@Parrot@objc(cs)BeaconAdvertiser">BeaconAdvertiser</a>
+                    </code>
+                  </div>
+                  <div class="height-container">
+                    <div class="pointer-container"></div>
+                    <section class="section">
+                      <div class="pointer"></div>
+                      <div class="abstract">
+                        <p>A class that allows a <code>CLBeaconRegion</code> to be advertised.</p>
+
+                        <a href="Classes/BeaconAdvertiser.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">final</span> <span class="kd">class</span> <span class="kt">BeaconAdvertiser</span><span class="p">:</span> <span class="kt">NSObject</span></code></pre>
+
+                        </div>
+                      </div>
+                    </section>
+                  </div>
+                </li>
+              </ul>
+            </div>
+          </section>
+        </section>
+        <section id="footer">
+          <p>&copy; 2017 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2017-11-07)</p>
+          <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.0</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
+        </section>
+      </article>
+    </div>
+  </body>
+</div>
+</html>
-Original file line number
+Diff line change
@@ Expand Up / @@ -86,6 +86,7 @@ public final class BeaconAdvertiser: NSObject { @@
       }
     }
+    /// :nodoc:
     extension BeaconAdvertiser: CBPeripheralManagerDelegate {
       public func peripheralManagerDidUpdateState(_ peripheral: CBPeripheralManager) {
@@ Expand Down @@