Skip to content

Commit

Permalink
Update docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
scottrhoyt committed Jan 2, 2017
1 parent 0f5a8b1 commit b2133fd
Show file tree
Hide file tree
Showing 28 changed files with 683 additions and 55 deletions.
127 changes: 127 additions & 0 deletions docs/Extensions.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,127 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>Extensions 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="Extensions Reference"></a>

<header class="header">
<p class="header-col header-col--primary">
<a class="header-link" href="index.html">
SwiftyTextTable Docs
</a>
(100% documented)
</p>


</header>

<p class="breadcrumbs">
<a class="breadcrumb" href="index.html">SwiftyTextTable Reference</a>
<img class="carat" src="img/carat.png" />
Extensions 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="Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions/Array.html">Array</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/TextTableRepresentable.html">TextTableRepresentable</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="Structs.html">Structs</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/TextTable.html">TextTable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/TextTableColumn.html">TextTableColumn</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">

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

</div>
</section>

<section class="section">
<div class="section-content">
<div class="task-group">
<div class="task-name-container">
<a name="/TextTableRepresentable"></a>
<a name="//apple_ref/swift/Section/TextTableRepresentable" class="dashAnchor"></a>
<a href="#/TextTableRepresentable">
<h3 class="section-name">TextTableRepresentable</h3>
</a>
</div>
<ul class="item-container">
<li class="item">
<div>
<code>
<a name="/s:Sa"></a>
<a name="//apple_ref/swift/Extension/Array" class="dashAnchor"></a>
<a class="token" href="#/s:Sa">Array</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">

<a href="Extensions/Array.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">struct</span> <span class="kt">Array</span><span class="o">&lt;</span><span class="kt">Element</span><span class="o">&gt;</span> <span class="p">:</span> <span class="kt">RandomAccessCollection</span><span class="p">,</span> <span class="kt">MutableCollection</span></code></pre>

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

</article>
</div>
<section class="footer">
<p>&copy; 2017 <a class="link" href="https://github.com/scottrhoyt/SwiftyTextTable" target="_blank" rel="external">Scott Hoyt</a>. All rights reserved. (Last updated: 2017-01-01)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.7.3</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
</div>
</html>
132 changes: 132 additions & 0 deletions docs/Extensions/Array.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,132 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>Array Extension 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 name="//apple_ref/swift/Extension/Array" class="dashAnchor"></a>

<a title="Array Extension Reference"></a>

<header class="header">
<p class="header-col header-col--primary">
<a class="header-link" href="../index.html">
SwiftyTextTable Docs
</a>
(100% documented)
</p>


</header>

<p class="breadcrumbs">
<a class="breadcrumb" href="../index.html">SwiftyTextTable Reference</a>
<img class="carat" src="../img/carat.png" />
Array Extension 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="../Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions/Array.html">Array</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/TextTableRepresentable.html">TextTableRepresentable</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Structs.html">Structs</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/TextTable.html">TextTable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/TextTableColumn.html">TextTableColumn</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">

<section class="section">
<div class="section-content">
<h1>Array</h1>
<div class="declaration">
<div class="language">
<pre class="highlight"><code><span class="kd">struct</span> <span class="kt">Array</span><span class="o">&lt;</span><span class="kt">Element</span><span class="o">&gt;</span> <span class="p">:</span> <span class="kt">RandomAccessCollection</span><span class="p">,</span> <span class="kt">MutableCollection</span></code></pre>

</div>
</div>

</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:Fe15SwiftyTextTableRxS_22TextTableRepresentablerSa15renderTextTableFT_SS"></a>
<a name="//apple_ref/swift/Method/renderTextTable()" class="dashAnchor"></a>
<a class="token" href="#/s:Fe15SwiftyTextTableRxS_22TextTableRepresentablerSa15renderTextTableFT_SS">renderTextTable()</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Returns a rendered text table containing the data in the array.
- returns: A <code>String</code> containing the rendered text table.</p>

</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">func</span> <span class="nf">renderTextTable</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="kt">String</span></code></pre>

</div>
</div>
<div>
<h4>Return Value</h4>
<p>A <code>String</code> containing the rendered text table.</p>

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

</article>
</div>
<section class="footer">
<p>&copy; 2017 <a class="link" href="https://github.com/scottrhoyt/SwiftyTextTable" target="_blank" rel="external">Scott Hoyt</a>. All rights reserved. (Last updated: 2017-01-01)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.7.3</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
</div>
</html>
14 changes: 11 additions & 3 deletions docs/Protocols.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<header class="header">
<p class="header-col header-col--primary">
<a class="header-link" href="index.html">
Docs
SwiftyTextTable Docs
</a>
(100% documented)
</p>
Expand All @@ -26,14 +26,22 @@
</header>

<p class="breadcrumbs">
<a class="breadcrumb" href="index.html"> Reference</a>
<a class="breadcrumb" href="index.html">SwiftyTextTable Reference</a>
<img class="carat" src="img/carat.png" />
Protocols 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="Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions/Array.html">Array</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">
Expand Down Expand Up @@ -112,7 +120,7 @@ <h4>Declaration</h4>
</article>
</div>
<section class="footer">
<p>&copy; 2017 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2017-01-01)</p>
<p>&copy; 2017 <a class="link" href="https://github.com/scottrhoyt/SwiftyTextTable" target="_blank" rel="external">Scott Hoyt</a>. All rights reserved. (Last updated: 2017-01-01)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.7.3</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
Expand Down
14 changes: 11 additions & 3 deletions docs/Protocols/TextTableRepresentable.html
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
<header class="header">
<p class="header-col header-col--primary">
<a class="header-link" href="../index.html">
Docs
SwiftyTextTable Docs
</a>
(100% documented)
</p>
Expand All @@ -27,14 +27,22 @@
</header>

<p class="breadcrumbs">
<a class="breadcrumb" href="../index.html"> Reference</a>
<a class="breadcrumb" href="../index.html">SwiftyTextTable Reference</a>
<img class="carat" src="../img/carat.png" />
TextTableRepresentable Protocol 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="../Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions/Array.html">Array</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">
Expand Down Expand Up @@ -173,7 +181,7 @@ <h4>Declaration</h4>
</article>
</div>
<section class="footer">
<p>&copy; 2017 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2017-01-01)</p>
<p>&copy; 2017 <a class="link" href="https://github.com/scottrhoyt/SwiftyTextTable" target="_blank" rel="external">Scott Hoyt</a>. All rights reserved. (Last updated: 2017-01-01)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.7.3</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
Expand Down
14 changes: 11 additions & 3 deletions docs/Structs.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<header class="header">
<p class="header-col header-col--primary">
<a class="header-link" href="index.html">
Docs
SwiftyTextTable Docs
</a>
(100% documented)
</p>
Expand All @@ -26,14 +26,22 @@
</header>

<p class="breadcrumbs">
<a class="breadcrumb" href="index.html"> Reference</a>
<a class="breadcrumb" href="index.html">SwiftyTextTable Reference</a>
<img class="carat" src="img/carat.png" />
Structs 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="Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions/Array.html">Array</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">
Expand Down Expand Up @@ -140,7 +148,7 @@ <h4>Declaration</h4>
</article>
</div>
<section class="footer">
<p>&copy; 2017 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2017-01-01)</p>
<p>&copy; 2017 <a class="link" href="https://github.com/scottrhoyt/SwiftyTextTable" target="_blank" rel="external">Scott Hoyt</a>. All rights reserved. (Last updated: 2017-01-01)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.7.3</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
Expand Down
Loading

0 comments on commit b2133fd

Please sign in to comment.