Skip to content

Commit

Permalink
docs: Update documentation for #45 (#48)
Browse files Browse the repository at this point in the history
  • Loading branch information
@djones6
djones6 authored Sep 20, 2019
1 parent bf06108 commit 316e301
Show file tree
Hide file tree
Showing 110 changed files with 3,361 additions and 1,321 deletions.
16 changes: 10 additions & 6 deletions docs/Classes.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
</head>
<body>

<a name="//apple_ref/swift/Section/Classes" class="dashAnchor"></a>

<a title="Classes Reference"></a>

Expand All @@ -22,7 +23,7 @@
<a class="header-link" href="index.html">
KituraContracts Docs
</a>
(100% documented)
(99% documented)
</p>

<p class="header-col--secondary">
Expand Down Expand Up @@ -86,6 +87,9 @@
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions/Bool.html">Bool</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions/DateError.html">DateError</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions/Double.html">Double</a>
</li>
Expand Down Expand Up @@ -143,7 +147,7 @@
<a class="nav-group-task-link" href="Protocols/Operation.html">Operation</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols.html#/s:15KituraContracts11QueryParamsP">QueryParams</a>
<a class="nav-group-task-link" href="Protocols/QueryParams.html">QueryParams</a>
</li>
</ul>
</li>
Expand Down Expand Up @@ -326,7 +330,7 @@ <h3 id='decoding-empty-values' class='heading'>Decoding Empty Values:</h3>
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">QueryDecoder</span><span class="p">:</span> <span class="kt"><a href="Classes/Coder.html">Coder</a></span><span class="p">,</span> <span class="kt">Decoder</span><span class="p">,</span> <span class="kt"><a href="Protocols/BodyDecoder.html">BodyDecoder</a></span></code></pre>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">QueryDecoder</span> <span class="p">:</span> <span class="kt"><a href="Classes/Coder.html">Coder</a></span><span class="p">,</span> <span class="kt">Decoder</span><span class="p">,</span> <span class="kt"><a href="Protocols/BodyDecoder.html">BodyDecoder</a></span></code></pre>

</div>
</div>
Expand Down Expand Up @@ -369,7 +373,7 @@ <h3 id='usage-example' class='heading'>Usage Example:</h3>
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">QueryEncoder</span><span class="p">:</span> <span class="kt"><a href="Classes/Coder.html">Coder</a></span><span class="p">,</span> <span class="kt">Encoder</span><span class="p">,</span> <span class="kt"><a href="Protocols/BodyEncoder.html">BodyEncoder</a></span></code></pre>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">QueryEncoder</span> <span class="p">:</span> <span class="kt"><a href="Classes/Coder.html">Coder</a></span><span class="p">,</span> <span class="kt">Encoder</span><span class="p">,</span> <span class="kt"><a href="Protocols/BodyEncoder.html">BodyEncoder</a></span></code></pre>

</div>
</div>
Expand All @@ -384,8 +388,8 @@ <h4>Declaration</h4>
</article>
</div>
<section class="footer">
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">IBM</a>. All rights reserved. (Last updated: 2018-08-31)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
<p>&copy; 2019 <a class="link" href="https://github.com/IBM-Swift/KituraContracts" target="_blank" rel="external">IBM</a>. All rights reserved. (Last updated: 2019-09-20)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
</div>
Expand Down
19 changes: 11 additions & 8 deletions docs/Classes/Coder.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
<a class="header-link" href="../index.html">
KituraContracts Docs
</a>
(100% documented)
(99% documented)
</p>

<p class="header-col--secondary">
Expand Down Expand Up @@ -87,6 +87,9 @@
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions/Bool.html">Bool</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions/DateError.html">DateError</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions/Double.html">Double</a>
</li>
Expand Down Expand Up @@ -144,7 +147,7 @@
<a class="nav-group-task-link" href="../Protocols/Operation.html">Operation</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols.html#/s:15KituraContracts11QueryParamsP">QueryParams</a>
<a class="nav-group-task-link" href="../Protocols/QueryParams.html">QueryParams</a>
</li>
</ul>
</li>
Expand Down Expand Up @@ -264,9 +267,9 @@ <h3 id='usage-example' class='heading'>Usage Example:</h3>
<li class="item">
<div>
<code>
<a name="/s:15KituraContracts5CoderC13dateFormatterSo04DateE0Cvp"></a>
<a name="/s:15KituraContracts5CoderC13dateFormatterSo06NSDateE0Cvp"></a>
<a name="//apple_ref/swift/Property/dateFormatter" class="dashAnchor"></a>
<a class="token" href="#/s:15KituraContracts5CoderC13dateFormatterSo04DateE0Cvp">dateFormatter</a>
<a class="token" href="#/s:15KituraContracts5CoderC13dateFormatterSo06NSDateE0Cvp">dateFormatter</a>
</code>
</div>
<div class="height-container">
Expand Down Expand Up @@ -322,9 +325,9 @@ <h4>Declaration</h4>
<li class="item">
<div>
<code>
<a name="/s:15KituraContracts5CoderC12getFieldNameSSSays9CodingKey_pG4from_tFZ"></a>
<a name="/s:15KituraContracts5CoderC12getFieldName4fromSSSays9CodingKey_pG_tFZ"></a>
<a name="//apple_ref/swift/Method/getFieldName(from:)" class="dashAnchor"></a>
<a class="token" href="#/s:15KituraContracts5CoderC12getFieldNameSSSays9CodingKey_pG4from_tFZ">getFieldName(from:)</a>
<a class="token" href="#/s:15KituraContracts5CoderC12getFieldName4fromSSSays9CodingKey_pG_tFZ">getFieldName(from:)</a>
</code>
</div>
<div class="height-container">
Expand Down Expand Up @@ -357,8 +360,8 @@ <h4>Declaration</h4>
</article>
</div>
<section class="footer">
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">IBM</a>. All rights reserved. (Last updated: 2018-08-31)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
<p>&copy; 2019 <a class="link" href="https://github.com/IBM-Swift/KituraContracts" target="_blank" rel="external">IBM</a>. All rights reserved. (Last updated: 2019-09-20)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
</div>
Expand Down
Loading

0 comments on commit 316e301

Please sign in to comment.