Update the documentation

fethica · Dec 23, 2017 · 472c785 · 472c785
1 parent 22c79de
commit 472c785
Show file tree

Hide file tree

Showing 18 changed files with 86 additions and 18 deletions.
diff --git a/docs/Classes.html b/docs/Classes.html
@@ -102,7 +102,7 @@ <h4>Declaration</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2017 <a class="link" href="https://fethica.com" target="_blank" rel="external">Fethi El Hassasna</a>. All rights reserved. (Last updated: 2017-12-09)</p>
+          <p>&copy; 2017 <a class="link" href="https://fethica.com" target="_blank" rel="external">Fethi El Hassasna</a>. All rights reserved. (Last updated: 2017-12-23)</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>

diff --git a/docs/Classes/FRadioPlayer.html b/docs/Classes/FRadioPlayer.html
@@ -412,12 +412,39 @@ <h4>Declaration</h4>
                     </section>
                   </div>
                 </li>
+                <li class="item">
+                  <div>
+                    <code>
+                    <a name="/s:12FRadioPlayerAAC13togglePlayingyyF"></a>
+                    <a name="//apple_ref/swift/Method/togglePlaying()" class="dashAnchor"></a>
+                    <a class="token" href="#/s:12FRadioPlayerAAC13togglePlayingyyF">togglePlaying()</a>
+                    </code>
+                  </div>
+                  <div class="height-container">
+                    <div class="pointer-container"></div>
+                    <section class="section">
+                      <div class="pointer"></div>
+                      <div class="abstract">
+                        <p>Toggle isPlaying state</p>
+
+                      </div>
+                      <div class="declaration">
+                        <h4>Declaration</h4>
+                        <div class="language">
+                          <p class="aside-title">Swift</p>
+                          <pre class="highlight"><code><span class="n">open</span> <span class="kd">func</span> <span class="nf">togglePlaying</span><span class="p">()</span></code></pre>
+
+                        </div>
+                      </div>
+                    </section>
+                  </div>
+                </li>
               </ul>
             </div>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2017 <a class="link" href="https://fethica.com" target="_blank" rel="external">Fethi El Hassasna</a>. All rights reserved. (Last updated: 2017-12-09)</p>
+          <p>&copy; 2017 <a class="link" href="https://fethica.com" target="_blank" rel="external">Fethi El Hassasna</a>. All rights reserved. (Last updated: 2017-12-23)</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>

diff --git a/docs/Enums.html b/docs/Enums.html
@@ -102,7 +102,7 @@ <h4>Declaration</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2017 <a class="link" href="https://fethica.com" target="_blank" rel="external">Fethi El Hassasna</a>. All rights reserved. (Last updated: 2017-12-09)</p>
+          <p>&copy; 2017 <a class="link" href="https://fethica.com" target="_blank" rel="external">Fethi El Hassasna</a>. All rights reserved. (Last updated: 2017-12-23)</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>

diff --git a/docs/Enums/FRadioPlayerState.html b/docs/Enums/FRadioPlayerState.html
@@ -256,7 +256,7 @@ <h4>Declaration</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2017 <a class="link" href="https://fethica.com" target="_blank" rel="external">Fethi El Hassasna</a>. All rights reserved. (Last updated: 2017-12-09)</p>
+          <p>&copy; 2017 <a class="link" href="https://fethica.com" target="_blank" rel="external">Fethi El Hassasna</a>. All rights reserved. (Last updated: 2017-12-23)</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>

diff --git a/docs/Protocols.html b/docs/Protocols.html
@@ -102,7 +102,7 @@ <h4>Declaration</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2017 <a class="link" href="https://fethica.com" target="_blank" rel="external">Fethi El Hassasna</a>. All rights reserved. (Last updated: 2017-12-09)</p>
+          <p>&copy; 2017 <a class="link" href="https://fethica.com" target="_blank" rel="external">Fethi El Hassasna</a>. All rights reserved. (Last updated: 2017-12-23)</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>

diff --git a/docs/Protocols/FRadioPlayerDelegate.html b/docs/Protocols/FRadioPlayerDelegate.html
@@ -434,7 +434,7 @@ <h4>Parameters</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2017 <a class="link" href="https://fethica.com" target="_blank" rel="external">Fethi El Hassasna</a>. All rights reserved. (Last updated: 2017-12-09)</p>
+          <p>&copy; 2017 <a class="link" href="https://fethica.com" target="_blank" rel="external">Fethi El Hassasna</a>. All rights reserved. (Last updated: 2017-12-23)</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>

diff --git a/docs/docsets/FRadioPlayer.docset/Contents/Resources/Documents/Classes.html b/docs/docsets/FRadioPlayer.docset/Contents/Resources/Documents/Classes.html
@@ -102,7 +102,7 @@ <h4>Declaration</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2017 <a class="link" href="https://fethica.com" target="_blank" rel="external">Fethi El Hassasna</a>. All rights reserved. (Last updated: 2017-12-09)</p>
+          <p>&copy; 2017 <a class="link" href="https://fethica.com" target="_blank" rel="external">Fethi El Hassasna</a>. All rights reserved. (Last updated: 2017-12-23)</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>

diff --git a/docs/docsets/FRadioPlayer.docset/Contents/Resources/Documents/Classes/FRadioPlayer.html b/docs/docsets/FRadioPlayer.docset/Contents/Resources/Documents/Classes/FRadioPlayer.html
@@ -412,12 +412,39 @@ <h4>Declaration</h4>
                     </section>
                   </div>
                 </li>
+                <li class="item">
+                  <div>
+                    <code>
+                    <a name="/s:12FRadioPlayerAAC13togglePlayingyyF"></a>
+                    <a name="//apple_ref/swift/Method/togglePlaying()" class="dashAnchor"></a>
+                    <a class="token" href="#/s:12FRadioPlayerAAC13togglePlayingyyF">togglePlaying()</a>
+                    </code>
+                  </div>
+                  <div class="height-container">
+                    <div class="pointer-container"></div>
+                    <section class="section">
+                      <div class="pointer"></div>
+                      <div class="abstract">
+                        <p>Toggle isPlaying state</p>
+
+                      </div>
+                      <div class="declaration">
+                        <h4>Declaration</h4>
+                        <div class="language">
+                          <p class="aside-title">Swift</p>
+                          <pre class="highlight"><code><span class="n">open</span> <span class="kd">func</span> <span class="nf">togglePlaying</span><span class="p">()</span></code></pre>
+
+                        </div>
+                      </div>
+                    </section>
+                  </div>
+                </li>
               </ul>
             </div>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2017 <a class="link" href="https://fethica.com" target="_blank" rel="external">Fethi El Hassasna</a>. All rights reserved. (Last updated: 2017-12-09)</p>
+          <p>&copy; 2017 <a class="link" href="https://fethica.com" target="_blank" rel="external">Fethi El Hassasna</a>. All rights reserved. (Last updated: 2017-12-23)</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>

diff --git a/docs/docsets/FRadioPlayer.docset/Contents/Resources/Documents/Enums.html b/docs/docsets/FRadioPlayer.docset/Contents/Resources/Documents/Enums.html
@@ -102,7 +102,7 @@ <h4>Declaration</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2017 <a class="link" href="https://fethica.com" target="_blank" rel="external">Fethi El Hassasna</a>. All rights reserved. (Last updated: 2017-12-09)</p>
+          <p>&copy; 2017 <a class="link" href="https://fethica.com" target="_blank" rel="external">Fethi El Hassasna</a>. All rights reserved. (Last updated: 2017-12-23)</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>

diff --git a/docs/docsets/FRadioPlayer.docset/Contents/Resources/Documents/Enums/FRadioPlayerState.html b/docs/docsets/FRadioPlayer.docset/Contents/Resources/Documents/Enums/FRadioPlayerState.html
@@ -256,7 +256,7 @@ <h4>Declaration</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2017 <a class="link" href="https://fethica.com" target="_blank" rel="external">Fethi El Hassasna</a>. All rights reserved. (Last updated: 2017-12-09)</p>
+          <p>&copy; 2017 <a class="link" href="https://fethica.com" target="_blank" rel="external">Fethi El Hassasna</a>. All rights reserved. (Last updated: 2017-12-23)</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>

diff --git a/docs/docsets/FRadioPlayer.docset/Contents/Resources/Documents/Protocols.html b/docs/docsets/FRadioPlayer.docset/Contents/Resources/Documents/Protocols.html
@@ -102,7 +102,7 @@ <h4>Declaration</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2017 <a class="link" href="https://fethica.com" target="_blank" rel="external">Fethi El Hassasna</a>. All rights reserved. (Last updated: 2017-12-09)</p>
+          <p>&copy; 2017 <a class="link" href="https://fethica.com" target="_blank" rel="external">Fethi El Hassasna</a>. All rights reserved. (Last updated: 2017-12-23)</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>

diff --git a/...sets/FRadioPlayer.docset/Contents/Resources/Documents/Protocols/FRadioPlayerDelegate.html b/...sets/FRadioPlayer.docset/Contents/Resources/Documents/Protocols/FRadioPlayerDelegate.html
@@ -434,7 +434,7 @@ <h4>Parameters</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2017 <a class="link" href="https://fethica.com" target="_blank" rel="external">Fethi El Hassasna</a>. All rights reserved. (Last updated: 2017-12-09)</p>
+          <p>&copy; 2017 <a class="link" href="https://fethica.com" target="_blank" rel="external">Fethi El Hassasna</a>. All rights reserved. (Last updated: 2017-12-23)</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>

diff --git a/docs/docsets/FRadioPlayer.docset/Contents/Resources/Documents/index.html b/docs/docsets/FRadioPlayer.docset/Contents/Resources/Documents/index.html
@@ -56,7 +56,10 @@
         <section>
           <section class="section">
 
-            <h1 id='fradioplayer' class='heading'>FRadioPlayer</h1>
+            <p align="center">
+<img alt="FRadioPlayer" src="https://fethica.com/img/web/repo-hero.png" width="749">
+</p>
+<h1 id='fradioplayer' class='heading'>FRadioPlayer</h1>
 
 <p><a href="https://travis-ci.org/fethica/FRadioPlayer"><img src="http://img.shields.io/travis/fethica/FRadioPlayer.svg?style=flat" alt="CI Status"></a>
 <a href="http://cocoapods.org/pods/FRadioPlayer"><img src="https://img.shields.io/cocoapods/v/FRadioPlayer.svg?style=flat" alt="Version"></a>
@@ -67,6 +70,10 @@ <h1 id='fradioplayer' class='heading'>FRadioPlayer</h1>
 <h2 id='example' class='heading'>Example</h2>
 
 <p>To run the example project, clone the repo, and run <code>pod install</code> from the Example directory first.</p>
+
+<p align="center">
+    <img alt="FRadioPlayer" src="https://fethica.com/img/web/fradioplayer-example.png" width="485">
+</p>
 <h2 id='features' class='heading'>Features</h2>
 
 <ul>
@@ -185,7 +192,7 @@ <h2 id='license' class='heading'>License</h2>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2017 <a class="link" href="https://fethica.com" target="_blank" rel="external">Fethi El Hassasna</a>. All rights reserved. (Last updated: 2017-12-09)</p>
+          <p>&copy; 2017 <a class="link" href="https://fethica.com" target="_blank" rel="external">Fethi El Hassasna</a>. All rights reserved. (Last updated: 2017-12-23)</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>