Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@piemonte
piemonte committed Oct 8, 2017
1 parent 62840c7 commit 722615b
Show file tree
Hide file tree
Showing 31 changed files with 1,041 additions and 763 deletions.
16 changes: 8 additions & 8 deletions docs/Classes.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
<a title="Classes Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="index.html">Player Docs</a> (58% documented)</p>
<p><a href="index.html">Player Docs</a> (60% documented)</p>
<p class="header-right"><a href="https://github.com/piemonte/Player"><img src="img/gh.png"/>View on GitHub</a></p>
</div>
</header>
Expand All @@ -36,16 +36,16 @@
</ul>
</li>
<li class="nav-group-name">
<a href="Enums.html">Enums</a>
<a href="Enums.html">Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Enums/BufferingState.html">BufferingState</a>
</li>
<li class="nav-group-task">
<a href="Enums/FillMode.html">FillMode</a>
<a href="Enums/PlaybackState.html">PlaybackState</a>
</li>
<li class="nav-group-task">
<a href="Enums/PlaybackState.html">PlaybackState</a>
<a href="Enums/PlayerFillMode.html">PlayerFillMode</a>
</li>
</ul>
</li>
Expand Down Expand Up @@ -82,9 +82,9 @@ <h3 class="section-name">Player</h3>
<li class="item">
<div>
<code>
<a name="/s:C6Player6Player"></a>
<a name="/c:@M@Player@objc(cs)Player"></a>
<a name="//apple_ref/swift/Class/Player" class="dashAnchor"></a>
<a class="token" href="#/s:C6Player6Player">Player</a>
<a class="token" href="#/c:@M@Player@objc(cs)Player">Player</a>
</code>
</div>
<div class="height-container">
Expand Down Expand Up @@ -112,8 +112,8 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2017 <a class="link" href="https://patrickpiemonte.com" target="_blank" rel="external">Patrick Piemonte</a>. All rights reserved. (Last updated: 2017-02-02)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.7.2</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
<p>&copy; 2017 <a class="link" href="https://patrickpiemonte.com" target="_blank" rel="external">Patrick Piemonte</a>. All rights reserved. (Last updated: 2017-10-08)</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
364 changes: 255 additions & 109 deletions docs/Classes/Player.html
View file

Large diffs are not rendered by default.

42 changes: 21 additions & 21 deletions docs/Enums.html
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>Enums Reference</title>
<title>Enumerations 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'>
Expand All @@ -10,18 +10,18 @@

</head>
<body>
<a title="Enums Reference"></a>
<a title="Enumerations Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="index.html">Player Docs</a> (58% documented)</p>
<p><a href="index.html">Player Docs</a> (60% documented)</p>
<p class="header-right"><a href="https://github.com/piemonte/Player"><img src="img/gh.png"/>View on GitHub</a></p>
</div>
</header>
<div class="content-wrapper">
<p id="breadcrumbs">
<a href="index.html">Player Reference</a>
<img id="carat" src="img/carat.png" />
Enums Reference
Enumerations Reference
</p>
</div>
<div class="content-wrapper">
Expand All @@ -36,16 +36,16 @@
</ul>
</li>
<li class="nav-group-name">
<a href="Enums.html">Enums</a>
<a href="Enums.html">Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Enums/BufferingState.html">BufferingState</a>
</li>
<li class="nav-group-task">
<a href="Enums/FillMode.html">FillMode</a>
<a href="Enums/PlaybackState.html">PlaybackState</a>
</li>
<li class="nav-group-task">
<a href="Enums/PlaybackState.html">PlaybackState</a>
<a href="Enums/PlayerFillMode.html">PlayerFillMode</a>
</li>
</ul>
</li>
Expand All @@ -65,8 +65,8 @@
<article class="main-content">
<section>
<section class="section">
<h1>Enums</h1>
<p>The following enums are available globally.</p>
<h1>Enumerations</h1>
<p>The following enumerations are available globally.</p>

</section>
<section class="section task-group-section">
Expand All @@ -82,31 +82,31 @@ <h3 class="section-name">types</h3>
<li class="item">
<div>
<code>
<a name="/s:O6Player8FillMode"></a>
<a name="//apple_ref/swift/Enum/FillMode" class="dashAnchor"></a>
<a class="token" href="#/s:O6Player8FillMode">FillMode</a>
<a name="/s:6Player0A8FillModeO"></a>
<a name="//apple_ref/swift/Enum/PlayerFillMode" class="dashAnchor"></a>
<a class="token" href="#/s:6Player0A8FillModeO">PlayerFillMode</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Video fill mode options for <code><a href="Classes/Player.html#/s:vC6Player6Player8fillModeSS">Player.fillMode</a></code>.</p>
<p>Video fill mode options for <code><a href="Classes/Player.html#/s:6PlayerAAC8fillModeSSv">Player.fillMode</a></code>.</p>

<ul>
<li>resize: Stretch to fill.</li>
<li>resizeAspectFill: Preserve aspect ratio, filling bounds.</li>
<li>resizeAspectFit: Preserve aspect ratio, fill within bounds.</li>
</ul>

<a href="Enums/FillMode.html" class="slightly-smaller">See more</a>
<a href="Enums/PlayerFillMode.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">enum</span> <span class="kt">FillMode</span><span class="p">:</span> <span class="kt">String</span></code></pre>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">PlayerFillMode</span></code></pre>

</div>
</div>
Expand All @@ -116,9 +116,9 @@ <h4>Declaration</h4>
<li class="item">
<div>
<code>
<a name="/s:O6Player13PlaybackState"></a>
<a name="/s:6Player13PlaybackStateO"></a>
<a name="//apple_ref/swift/Enum/PlaybackState" class="dashAnchor"></a>
<a class="token" href="#/s:O6Player13PlaybackState">PlaybackState</a>
<a class="token" href="#/s:6Player13PlaybackStateO">PlaybackState</a>
</code>
</div>
<div class="height-container">
Expand All @@ -144,9 +144,9 @@ <h4>Declaration</h4>
<li class="item">
<div>
<code>
<a name="/s:O6Player14BufferingState"></a>
<a name="/s:6Player14BufferingStateO"></a>
<a name="//apple_ref/swift/Enum/BufferingState" class="dashAnchor"></a>
<a class="token" href="#/s:O6Player14BufferingState">BufferingState</a>
<a class="token" href="#/s:6Player14BufferingStateO">BufferingState</a>
</code>
</div>
<div class="height-container">
Expand Down Expand Up @@ -174,8 +174,8 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2017 <a class="link" href="https://patrickpiemonte.com" target="_blank" rel="external">Patrick Piemonte</a>. All rights reserved. (Last updated: 2017-02-02)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.7.2</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
<p>&copy; 2017 <a class="link" href="https://patrickpiemonte.com" target="_blank" rel="external">Patrick Piemonte</a>. All rights reserved. (Last updated: 2017-10-08)</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
37 changes: 18 additions & 19 deletions docs/Enums/BufferingState.html
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>BufferingState Enum Reference</title>
<title>BufferingState Enumeration 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'>
Expand All @@ -11,18 +11,18 @@
</head>
<body>
<a name="//apple_ref/swift/Enum/BufferingState" class="dashAnchor"></a>
<a title="BufferingState Enum Reference"></a>
<a title="BufferingState Enumeration Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">Player Docs</a> (58% documented)</p>
<p><a href="../index.html">Player Docs</a> (60% documented)</p>
<p class="header-right"><a href="https://github.com/piemonte/Player"><img src="../img/gh.png"/>View on GitHub</a></p>
</div>
</header>
<div class="content-wrapper">
<p id="breadcrumbs">
<a href="../index.html">Player Reference</a>
<img id="carat" src="../img/carat.png" />
BufferingState Enum Reference
BufferingState Enumeration Reference
</p>
</div>
<div class="content-wrapper">
Expand All @@ -37,16 +37,16 @@
</ul>
</li>
<li class="nav-group-name">
<a href="../Enums.html">Enums</a>
<a href="../Enums.html">Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Enums/BufferingState.html">BufferingState</a>
</li>
<li class="nav-group-task">
<a href="../Enums/FillMode.html">FillMode</a>
<a href="../Enums/PlaybackState.html">PlaybackState</a>
</li>
<li class="nav-group-task">
<a href="../Enums/PlaybackState.html">PlaybackState</a>
<a href="../Enums/PlayerFillMode.html">PlayerFillMode</a>
</li>
</ul>
</li>
Expand Down Expand Up @@ -82,9 +82,9 @@ <h1>BufferingState</h1>
<li class="item">
<div>
<code>
<a name="/s:FO6Player14BufferingState7unknownFMS0_S0_"></a>
<a name="/s:6Player14BufferingStateO7unknownA2CmF"></a>
<a name="//apple_ref/swift/Element/unknown" class="dashAnchor"></a>
<a class="token" href="#/s:FO6Player14BufferingState7unknownFMS0_S0_">unknown</a>
<a class="token" href="#/s:6Player14BufferingStateO7unknownA2CmF">unknown</a>
</code>
</div>
<div class="height-container">
Expand Down Expand Up @@ -113,9 +113,9 @@ <h4>Declaration</h4>
<li class="item">
<div>
<code>
<a name="/s:FO6Player14BufferingState5readyFMS0_S0_"></a>
<a name="/s:6Player14BufferingStateO5readyA2CmF"></a>
<a name="//apple_ref/swift/Element/ready" class="dashAnchor"></a>
<a class="token" href="#/s:FO6Player14BufferingState5readyFMS0_S0_">ready</a>
<a class="token" href="#/s:6Player14BufferingStateO5readyA2CmF">ready</a>
</code>
</div>
<div class="height-container">
Expand Down Expand Up @@ -144,9 +144,9 @@ <h4>Declaration</h4>
<li class="item">
<div>
<code>
<a name="/s:FO6Player14BufferingState7delayedFMS0_S0_"></a>
<a name="/s:6Player14BufferingStateO7delayedA2CmF"></a>
<a name="//apple_ref/swift/Element/delayed" class="dashAnchor"></a>
<a class="token" href="#/s:FO6Player14BufferingState7delayedFMS0_S0_">delayed</a>
<a class="token" href="#/s:6Player14BufferingStateO7delayedA2CmF">delayed</a>
</code>
</div>
<div class="height-container">
Expand Down Expand Up @@ -175,18 +175,17 @@ <h4>Declaration</h4>
<li class="item">
<div>
<code>
<a name="/s:vPs23CustomStringConvertible11descriptionSS"></a>
<a name="/s:s23CustomStringConvertibleP11descriptionSSv"></a>
<a name="//apple_ref/swift/Property/description" class="dashAnchor"></a>
<a class="token" href="#/s:vPs23CustomStringConvertible11descriptionSS">description</a>
<a class="token" href="#/s:s23CustomStringConvertibleP11descriptionSSv">description</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Asset buffering states.</p>


</div>
<div class="declaration">
<h4>Declaration</h4>
Expand All @@ -204,8 +203,8 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2017 <a class="link" href="https://patrickpiemonte.com" target="_blank" rel="external">Patrick Piemonte</a>. All rights reserved. (Last updated: 2017-02-02)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.7.2</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
<p>&copy; 2017 <a class="link" href="https://patrickpiemonte.com" target="_blank" rel="external">Patrick Piemonte</a>. All rights reserved. (Last updated: 2017-10-08)</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 722615b

Please sign in to comment.