Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@fethica
fethica committed Jan 3, 2018
1 parent c56733e commit 6f4fe1c
Show file tree
Hide file tree
Showing 20 changed files with 226 additions and 73 deletions.
7 changes: 5 additions & 2 deletions docs/Classes.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,9 @@
<li class="nav-group-name">
<a href="Enums.html">Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Enums/FRadioPlaybackState.html">FRadioPlaybackState</a>
</li>
<li class="nav-group-task">
<a href="Enums/FRadioPlayerState.html">FRadioPlayerState</a>
</li>
Expand Down Expand Up @@ -102,8 +105,8 @@ <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-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>
<p>&copy; 2018 <a class="link" href="https://fethica.com" target="_blank" rel="external">Fethi El Hassasna</a>. All rights reserved. (Last updated: 2018-01-03)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.4</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
</div>
Expand Down
36 changes: 33 additions & 3 deletions docs/Classes/FRadioPlayer.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,9 @@
<li class="nav-group-name">
<a href="../Enums.html">Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Enums/FRadioPlaybackState.html">FRadioPlaybackState</a>
</li>
<li class="nav-group-task">
<a href="../Enums/FRadioPlayerState.html">FRadioPlayerState</a>
</li>
Expand Down Expand Up @@ -286,7 +289,7 @@ <h4>Declaration</h4>
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="n">open</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">isPlaying</span><span class="p">:</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="kc">false</span></code></pre>
<pre class="highlight"><code><span class="n">open</span> <span class="k">var</span> <span class="nv">isPlaying</span><span class="p">:</span> <span class="kt">Bool</span></code></pre>

</div>
</div>
Expand Down Expand Up @@ -320,6 +323,33 @@ <h4>Declaration</h4>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:12FRadioPlayerAAC13playbackStateAA0a8PlaybackD0Ov"></a>
<a name="//apple_ref/swift/Property/playbackState" class="dashAnchor"></a>
<a class="token" href="#/s:12FRadioPlayerAAC13playbackStateAA0a8PlaybackD0Ov">playbackState</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Playing state of type <code><a href="../Enums/FRadioPlaybackState.html">FRadioPlaybackState</a></code></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">private(set)</span> <span class="k">var</span> <span class="nv">playbackState</span> <span class="o">=</span> <span class="kt"><a href="../Enums/FRadioPlaybackState.html">FRadioPlaybackState</a></span><span class="o">.</span><span class="n">stopped</span></code></pre>

</div>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
Expand Down Expand Up @@ -444,8 +474,8 @@ <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-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>
<p>&copy; 2018 <a class="link" href="https://fethica.com" target="_blank" rel="external">Fethi El Hassasna</a>. All rights reserved. (Last updated: 2018-01-03)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.4</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
</div>
Expand Down
46 changes: 44 additions & 2 deletions docs/Enums.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,9 @@
<li class="nav-group-name">
<a href="Enums.html">Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Enums/FRadioPlaybackState.html">FRadioPlaybackState</a>
</li>
<li class="nav-group-task">
<a href="Enums/FRadioPlayerState.html">FRadioPlayerState</a>
</li>
Expand All @@ -60,6 +63,45 @@ <h1>Enumerations</h1>

</section>
<section class="section task-group-section">
<div class="task-group">
<div class="task-name-container">
<a name="/FRadioPlayingState"></a>
<a name="//apple_ref/swift/Section/FRadioPlayingState" class="dashAnchor"></a>
<a href="#/FRadioPlayingState">
<h3 class="section-name">FRadioPlayingState</h3>
</a>
</div>
<ul>
<li class="item">
<div>
<code>
<a name="/c:@M@FRadioPlayer@E@FRadioPlaybackState"></a>
<a name="//apple_ref/swift/Enum/FRadioPlaybackState" class="dashAnchor"></a>
<a class="token" href="#/c:@M@FRadioPlayer@E@FRadioPlaybackState">FRadioPlaybackState</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p><code>FRadioPlayingState</code> is the Player playing state enum</p>

<a href="Enums/FRadioPlaybackState.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">@objc</span> <span class="kd">public</span> <span class="kd">enum</span> <span class="kt">FRadioPlaybackState</span><span class="p">:</span> <span class="kt">Int</span></code></pre>

</div>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<div class="task-name-container">
<a name="/FRadioPlayerState"></a>
Expand Down Expand Up @@ -102,8 +144,8 @@ <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-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>
<p>&copy; 2018 <a class="link" href="https://fethica.com" target="_blank" rel="external">Fethi El Hassasna</a>. All rights reserved. (Last updated: 2018-01-03)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.4</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
</div>
Expand Down
7 changes: 5 additions & 2 deletions docs/Enums/FRadioPlayerState.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,9 @@
<li class="nav-group-name">
<a href="../Enums.html">Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Enums/FRadioPlaybackState.html">FRadioPlaybackState</a>
</li>
<li class="nav-group-task">
<a href="../Enums/FRadioPlayerState.html">FRadioPlayerState</a>
</li>
Expand Down Expand Up @@ -256,8 +259,8 @@ <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-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>
<p>&copy; 2018 <a class="link" href="https://fethica.com" target="_blank" rel="external">Fethi El Hassasna</a>. All rights reserved. (Last updated: 2018-01-03)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.4</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
</div>
Expand Down
7 changes: 5 additions & 2 deletions docs/Protocols.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,9 @@
<li class="nav-group-name">
<a href="Enums.html">Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Enums/FRadioPlaybackState.html">FRadioPlaybackState</a>
</li>
<li class="nav-group-task">
<a href="Enums/FRadioPlayerState.html">FRadioPlayerState</a>
</li>
Expand Down Expand Up @@ -102,8 +105,8 @@ <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-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>
<p>&copy; 2018 <a class="link" href="https://fethica.com" target="_blank" rel="external">Fethi El Hassasna</a>. All rights reserved. (Last updated: 2018-01-03)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.4</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
</div>
Expand Down
19 changes: 11 additions & 8 deletions docs/Protocols/FRadioPlayerDelegate.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,9 @@
<li class="nav-group-name">
<a href="../Enums.html">Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Enums/FRadioPlaybackState.html">FRadioPlaybackState</a>
</li>
<li class="nav-group-task">
<a href="../Enums/FRadioPlayerState.html">FRadioPlayerState</a>
</li>
Expand Down Expand Up @@ -130,9 +133,9 @@ <h4>Parameters</h4>
<li class="item">
<div>
<code>
<a name="/c:@M@FRadioPlayer@objc(pl)FRadioPlayerDelegate(im)radioPlayer:player:"></a>
<a name="//apple_ref/swift/Method/radioPlayer(_:player:)" class="dashAnchor"></a>
<a class="token" href="#/c:@M@FRadioPlayer@objc(pl)FRadioPlayerDelegate(im)radioPlayer:player:">radioPlayer(_:player:)</a>
<a name="/c:@M@FRadioPlayer@objc(pl)FRadioPlayerDelegate(im)radioPlayer:playbackStateDidChange:"></a>
<a name="//apple_ref/swift/Method/radioPlayer(_:playbackStateDidChange:)" class="dashAnchor"></a>
<a class="token" href="#/c:@M@FRadioPlayer@objc(pl)FRadioPlayerDelegate(im)radioPlayer:playbackStateDidChange:">radioPlayer(_:playbackStateDidChange:)</a>
</code>
</div>
<div class="height-container">
Expand All @@ -147,7 +150,7 @@ <h4>Parameters</h4>
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">@objc</span> <span class="kd">optional</span> <span class="kd">func</span> <span class="nf">radioPlayer</span><span class="p">(</span><span class="n">_</span> <span class="nv">player</span><span class="p">:</span> <span class="kt"><a href="../Classes/FRadioPlayer.html">FRadioPlayer</a></span><span class="p">,</span> <span class="n">player</span> <span class="nv">isPlaying</span><span class="p">:</span> <span class="kt">Bool</span><span class="p">)</span></code></pre>
<pre class="highlight"><code><span class="kd">func</span> <span class="nf">radioPlayer</span><span class="p">(</span><span class="n">_</span> <span class="nv">player</span><span class="p">:</span> <span class="kt"><a href="../Classes/FRadioPlayer.html">FRadioPlayer</a></span><span class="p">,</span> <span class="n">playbackStateDidChange</span> <span class="nv">state</span><span class="p">:</span> <span class="kt"><a href="../Enums/FRadioPlaybackState.html">FRadioPlaybackState</a></span><span class="p">)</span></code></pre>

</div>
</div>
Expand All @@ -170,12 +173,12 @@ <h4>Parameters</h4>
<tr>
<td>
<code>
<em>playing</em>
<em>state</em>
</code>
</td>
<td>
<div>
<p>Bool value</p>
<p>FRadioPlaybackState</p>
</div>
</td>
</tr>
Expand Down Expand Up @@ -434,8 +437,8 @@ <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-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>
<p>&copy; 2018 <a class="link" href="https://fethica.com" target="_blank" rel="external">Fethi El Hassasna</a>. All rights reserved. (Last updated: 2018-01-03)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.4</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
</div>
Expand Down
29 changes: 1 addition & 28 deletions docs/badge.svg
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 5 additions & 2 deletions docs/docsets/FRadioPlayer.docset/Contents/Resources/Documents/Classes.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,9 @@
<li class="nav-group-name">
<a href="Enums.html">Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Enums/FRadioPlaybackState.html">FRadioPlaybackState</a>
</li>
<li class="nav-group-task">
<a href="Enums/FRadioPlayerState.html">FRadioPlayerState</a>
</li>
Expand Down Expand Up @@ -102,8 +105,8 @@ <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-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>
<p>&copy; 2018 <a class="link" href="https://fethica.com" target="_blank" rel="external">Fethi El Hassasna</a>. All rights reserved. (Last updated: 2018-01-03)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.4</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
</div>
Expand Down
Loading

0 comments on commit 6f4fe1c

Please sign in to comment.