Skip to content

Commit

Permalink
added docs
Browse files Browse the repository at this point in the history
  • Loading branch information
piemonte committed Feb 3, 2017
1 parent f2733d2 commit 7e190e8
Show file tree
Hide file tree
Showing 41 changed files with 7,091 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,10 @@ Adjust the fill mode for the video, if needed.
self.player.fillMode = FillMode.resizeAspectFit
```

## Documentation

You can find [the docs here](https://github.com/piemonte/Player). Documentation is generated with [jazzy](https://github.com/realm/jazzy) and hosted on [GitHub-Pages](https://pages.github.com).

## Community

- Need help? Use [Stack Overflow](http://stackoverflow.com/questions/tagged/player-swift) with the tag 'player-swift'.
Expand Down
17 changes: 17 additions & 0 deletions build_docs.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
#!/bin/bash

# Docs by jazzy
# https://github.com/realm/jazzy
# ------------------------------

jazzy \
--clean \
--author 'Patrick Piemonte' \
--author_url 'https://patrickpiemonte.com' \
--github_url 'https://github.com/piemonte/Player' \
--sdk iphonesimulator \
--xcodebuild-arguments -scheme,'Player' \
--module 'Player' \
--framework-root . \
--readme README.md \
--output docs/
122 changes: 122 additions & 0 deletions docs/Classes.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,122 @@
<!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">Player Docs</a> (58% 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" />
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/Player.html">Player</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Enums.html">Enums</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>
</li>
<li class="nav-group-task">
<a href="Enums/PlaybackState.html">PlaybackState</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/PlayerDelegate.html">PlayerDelegate</a>
</li>
<li class="nav-group-task">
<a href="Protocols/PlayerPlaybackDelegate.html">PlayerPlaybackDelegate</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">
<div class="task-name-container">
<a name="/Player"></a>
<a name="//apple_ref/swift/Section/Player" class="dashAnchor"></a>
<a href="#/Player">
<h3 class="section-name">Player</h3>
</a>
</div>
<ul>
<li class="item">
<div>
<code>
<a name="/s:C6Player6Player"></a>
<a name="//apple_ref/swift/Class/Player" class="dashAnchor"></a>
<a class="token" href="#/s:C6Player6Player">Player</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>▶️ Player, simple way to play and stream media</p>

<a href="Classes/Player.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="n">open</span> <span class="kd">class</span> <span class="kt">Player</span><span class="p">:</span> <span class="kt">UIViewController</span></code></pre>

</div>
</div>
</section>
</div>
</li>
</ul>
</div>
</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>
</section>
</article>
</div>
</body>
</div>
</html>
Loading

0 comments on commit 7e190e8

Please sign in to comment.