Skip to content

Commit

Permalink
Adds Docs generated with Jazzy
Browse files Browse the repository at this point in the history
  • Loading branch information
s4cha committed Jul 9, 2016
1 parent 4eded83 commit da77999
Show file tree
Hide file tree
Showing 39 changed files with 6,670 additions and 0 deletions.
219 changes: 219 additions & 0 deletions docs/Classes.html
@@ -0,0 +1,219 @@
<!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 class="header">
<p class="header-col header-col--primary">
<a class="header-link" href="index.html">
Arrow Docs
</a>
(72% documented)
</p>

<p class="header-col header-col--secondary">
<a class="header-link" href="https://github.com/s4cha/Arrow">
<img class="header-icon" src="img/gh.png"/>
View on GitHub
</a>
</p>

</header>

<p class="breadcrumbs">
<a class="breadcrumb" href="index.html">Arrow Reference</a>
<img class="carat" src="img/carat.png" />
Classes Reference
</p>

<div class="content-wrapper">
<nav class="navigation">
<ul class="nav-groups">
<li class="nav-group-name">
<a class="nav-group-name-link" href="Guides.html">Guides</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="readme.html">README</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="Classes.html">Classes</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/Arrow.html">Arrow</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/JSON.html">JSON</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="Functions.html">Functions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Functions/&lt;--(_:_:).html">&lt;--(_:_:)</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Functions/&lt;--(_:_:).html">&lt;--(_:_:)</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Functions/&lt;--(_:_:).html">&lt;--(_:_:)</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Functions/&lt;--(_:_:).html">&lt;--(_:_:)</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Functions/&lt;--(_:_:).html">&lt;--(_:_:)</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Functions/&lt;--(_:_:).html">&lt;--(_:_:)</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Functions/&lt;--(_:_:).html">&lt;--(_:_:)</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Functions/&lt;--(_:_:).html">&lt;--(_:_:)</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Functions.html#/s:ZF5Arrowoi3lssFTRCSo6NSDateGSqCS_4JSON__T_">&lt;--(_:_:)</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Functions.html#/s:ZF5Arrowoi3lssFTRGSqCSo6NSDate_GSqCS_4JSON__T_">&lt;--(_:_:)</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Functions.html#/s:ZF5Arrowoi3lssFTRCSo5NSURLGSqCS_4JSON__T_">&lt;--(_:_:)</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Functions.html#/s:ZF5Arrowoi3lssFTRGSqCSo5NSURL_GSqCS_4JSON__T_">&lt;--(_:_:)</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Functions/&lt;--(_:_:).html">&lt;--(_:_:)</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Functions/&lt;--(_:_:).html">&lt;--(_:_:)</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/ArrowParsable.html">ArrowParsable</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">

<section class="section">
<div class="section-content">
<h1>Classes</h1>
<p>The following classes are available globally.</p>

</div>
</section>

<section class="section">
<div class="section-content">
<div class="task-group">
<ul class="item-container">
<li class="item">
<div>
<code>
<a name="/s:C5Arrow4JSON"></a>
<a name="//apple_ref/swift/Class/JSON" class="dashAnchor"></a>
<a class="token" href="#/s:C5Arrow4JSON">JSON</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>This abstraction helps working with the JSON Format.</p>

<p>It provives a way to access JSON values via subscripting, whether
it&rsquo;s an array or a dictionary.</p>

<a href="Classes/JSON.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">class</span> <span class="kt">JSON</span><span class="p">:</span> <span class="kt">AnyObject</span><span class="p">,</span> <span class="kt">CustomDebugStringConvertible</span></code></pre>

</div>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul class="item-container">
<li class="item">
<div>
<code>
<a name="/s:C5Arrow5Arrow"></a>
<a name="//apple_ref/swift/Class/Arrow" class="dashAnchor"></a>
<a class="token" href="#/s:C5Arrow5Arrow">Arrow</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>This is used to configure NSDate parsing on a global scale.</p>

<pre class="highlight plaintext"><code> Arrow.setDateFormat("yyyy-MM-dd'T'HH:mm:ssZZZZZ")
// or
Arrow.setUseTimeIntervalSinceReferenceDate(true)
</code></pre>

<p>For more fine grained control, use <code>dateFormat</code> on a per field basis :</p>

<pre class="highlight plaintext"><code> createdAt &lt;-- json["created_at"]?.dateFormat("yyyy-MM-dd'T'HH:mm:ssZZZZZ")
</code></pre>

<a href="Classes/Arrow.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">class</span> <span class="kt">Arrow</span></code></pre>

</div>
</div>
</section>
</div>
</li>
</ul>
</div>
</div>
</section>

</article>
</div>
<section class="footer">
<p>&copy; 2016 <a class="link" href="https://github.com/s4cha" target="_blank" rel="external">S4cha</a>. All rights reserved. (Last updated: 2016-07-09)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.7.0</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
</div>
</html>

0 comments on commit da77999

Please sign in to comment.