Skip to content

Commit

Permalink
Update API documentation (#38)
Browse files Browse the repository at this point in the history
  • Loading branch information
@djones6 @kilnerm
djones6 authored and kilnerm committed Jan 7, 2019
1 parent 4e0163e commit e899be7
Show file tree
Hide file tree
Showing 20 changed files with 262 additions and 140 deletions.
2 changes: 1 addition & 1 deletion docs/Classes.html
View file
Expand Up @@ -168,7 +168,7 @@ <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-06-29)</p>
<p>&copy; 2019 <a class="link" href="" target="_blank" rel="external">IBM</a>. All rights reserved. (Last updated: 2019-01-07)</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>
</section>
</body>
Expand Down
107 changes: 72 additions & 35 deletions docs/Classes/SQLiteConnection.html
View file
Expand Up @@ -103,9 +103,9 @@ <h1>SQLiteConnection</h1>
<li class="item">
<div>
<code>
<a name="/s:16SwiftKuerySQLite0C10ConnectionC11isConnectedSbv"></a>
<a name="/s:16SwiftKuerySQLite0C10ConnectionC11isConnectedSbvp"></a>
<a name="//apple_ref/swift/Property/isConnected" class="dashAnchor"></a>
<a class="token" href="#/s:16SwiftKuerySQLite0C10ConnectionC11isConnectedSbv">isConnected</a>
<a class="token" href="#/s:16SwiftKuerySQLite0C10ConnectionC11isConnectedSbvp">isConnected</a>
</code>
</div>
<div class="height-container">
Expand All @@ -130,9 +130,9 @@ <h4>Declaration</h4>
<li class="item">
<div>
<code>
<a name="/s:16SwiftKuerySQLite0C10ConnectionC12queryBuilder0aB005QueryF0Cv"></a>
<a name="/s:16SwiftKuerySQLite0C10ConnectionC12queryBuilder0aB005QueryF0Cvp"></a>
<a name="//apple_ref/swift/Property/queryBuilder" class="dashAnchor"></a>
<a class="token" href="#/s:16SwiftKuerySQLite0C10ConnectionC12queryBuilder0aB005QueryF0Cv">queryBuilder</a>
<a class="token" href="#/s:16SwiftKuerySQLite0C10ConnectionC12queryBuilder0aB005QueryF0Cvp">queryBuilder</a>
</code>
</div>
<div class="height-container">
Expand Down Expand Up @@ -224,7 +224,7 @@ <h4>Return Value</h4>
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="n">convenience</span> <span class="nf">init</span><span class="p">(</span><span class="nv">filename</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span></code></pre>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">convenience</span> <span class="nf">init</span><span class="p">(</span><span class="nv">filename</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span></code></pre>

</div>
</div>
Expand Down Expand Up @@ -357,9 +357,9 @@ <h4>Return Value</h4>
<li class="item">
<div>
<code>
<a name="/s:16SwiftKuerySQLite0C10ConnectionC7connectyy0aB010QueryErrorOSgc12onCompletion_tF"></a>
<a name="/s:16SwiftKuerySQLite0C10ConnectionC7connectyy0aB011QueryResultOc12onCompletion_tF"></a>
<a name="//apple_ref/swift/Method/connect(onCompletion:)" class="dashAnchor"></a>
<a class="token" href="#/s:16SwiftKuerySQLite0C10ConnectionC7connectyy0aB010QueryErrorOSgc12onCompletion_tF">connect(onCompletion:)</a>
<a class="token" href="#/s:16SwiftKuerySQLite0C10ConnectionC7connectyy0aB011QueryResultOc12onCompletion_tF">connect(onCompletion:)</a>
</code>
</div>
<div class="height-container">
Expand All @@ -374,7 +374,7 @@ <h4>Return Value</h4>
<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">func</span> <span class="nf">connect</span><span class="p">(</span><span class="nv">onCompletion</span><span class="p">:</span> <span class="p">(</span><span class="kt">QueryError</span><span class="p">?)</span> <span class="o">-&gt;</span> <span class="p">())</span></code></pre>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">connect</span><span class="p">(</span><span class="nv">onCompletion</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt">QueryResult</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="p">())</span></code></pre>

</div>
</div>
Expand All @@ -400,6 +400,37 @@ <h4>Parameters</h4>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:16SwiftKuerySQLite0C10ConnectionC11connectSync0aB011QueryResultOyF"></a>
<a name="//apple_ref/swift/Method/connectSync()" class="dashAnchor"></a>
<a class="token" href="#/s:16SwiftKuerySQLite0C10ConnectionC11connectSync0aB011QueryResultOyF">connectSync()</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Establish a connection with the database.</p>

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

</div>
</div>
<div>
<h4>Return Value</h4>
<p>A QueryError if the connection cannot connect, otherwise nil</p>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
Expand Down Expand Up @@ -881,9 +912,9 @@ <h4>Parameters</h4>
<li class="item">
<div>
<code>
<a name="/s:16SwiftKuerySQLite0C10ConnectionC16prepareStatement0aB008PreparedF0_pAE5Query_pKF"></a>
<a name="//apple_ref/swift/Method/prepareStatement(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:16SwiftKuerySQLite0C10ConnectionC16prepareStatement0aB008PreparedF0_pAE5Query_pKF">prepareStatement(_:)</a>
<a name="/s:16SwiftKuerySQLite0C10ConnectionC16prepareStatementy0aB05Query_p_yAE0G6ResultOc12onCompletiontF"></a>
<a name="//apple_ref/swift/Method/prepareStatement(_:onCompletion:)" class="dashAnchor"></a>
<a class="token" href="#/s:16SwiftKuerySQLite0C10ConnectionC16prepareStatementy0aB05Query_p_yAE0G6ResultOc12onCompletiontF">prepareStatement(_:onCompletion:)</a>
</code>
</div>
<div class="height-container">
Expand All @@ -892,18 +923,13 @@ <h4>Parameters</h4>
<div class="pointer"></div>
<div class="abstract">
<p>Prepare statement.</p>
<div class="aside aside-throws">
<p class="aside-title">Throws</p>
QueryError.syntaxError if query build fails, or a database error if it fails to prepare statement.

</div>

</div>
<div class="declaration">
<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">func</span> <span class="nf">prepareStatement</span><span class="p">(</span><span class="n">_</span> <span class="nv">query</span><span class="p">:</span> <span class="kt">Query</span><span class="p">)</span> <span class="k">throws</span> <span class="o">-&gt;</span> <span class="kt">PreparedStatement</span></code></pre>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">prepareStatement</span><span class="p">(</span><span class="n">_</span> <span class="nv">query</span><span class="p">:</span> <span class="kt">Query</span><span class="p">,</span> <span class="nv">onCompletion</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">((</span><span class="kt">QueryResult</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="p">()))</span></code></pre>

</div>
</div>
Expand All @@ -923,22 +949,30 @@ <h4>Parameters</h4>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>onCompletion</em>
</code>
</td>
<td>
<div>
<p>The function to be called when the statementhas been prepared.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p>The prepared statement.</p>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:16SwiftKuerySQLite0C10ConnectionC16prepareStatement0aB008PreparedF0_pSSKF"></a>
<a name="//apple_ref/swift/Method/prepareStatement(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:16SwiftKuerySQLite0C10ConnectionC16prepareStatement0aB008PreparedF0_pSSKF">prepareStatement(_:)</a>
<a name="/s:16SwiftKuerySQLite0C10ConnectionC16prepareStatementySS_y0aB011QueryResultOc12onCompletiontF"></a>
<a name="//apple_ref/swift/Method/prepareStatement(_:onCompletion:)" class="dashAnchor"></a>
<a class="token" href="#/s:16SwiftKuerySQLite0C10ConnectionC16prepareStatementySS_y0aB011QueryResultOc12onCompletiontF">prepareStatement(_:onCompletion:)</a>
</code>
</div>
<div class="height-container">
Expand All @@ -947,18 +981,13 @@ <h4>Return Value</h4>
<div class="pointer"></div>
<div class="abstract">
<p>Prepare statement.</p>
<div class="aside aside-throws">
<p class="aside-title">Throws</p>
QueryError.syntaxError if query build fails, or a database error if it fails to prepare statement.

</div>

</div>
<div class="declaration">
<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">func</span> <span class="nf">prepareStatement</span><span class="p">(</span><span class="n">_</span> <span class="nv">raw</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="k">throws</span> <span class="o">-&gt;</span> <span class="kt">PreparedStatement</span></code></pre>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">prepareStatement</span><span class="p">(</span><span class="n">_</span> <span class="nv">raw</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">onCompletion</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">((</span><span class="kt">QueryResult</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="p">()))</span></code></pre>

</div>
</div>
Expand All @@ -978,13 +1007,21 @@ <h4>Parameters</h4>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>onCompletion</em>
</code>
</td>
<td>
<div>
<p>The function to be called when the statementhas been prepared.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p>The prepared statement.</p>
</div>
</section>
</div>
</li>
Expand Down Expand Up @@ -1552,7 +1589,7 @@ <h4>Parameters</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-06-29)</p>
<p>&copy; 2019 <a class="link" href="" target="_blank" rel="external">IBM</a>. All rights reserved. (Last updated: 2019-01-07)</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>
</section>
</body>
Expand Down

0 comments on commit e899be7

Please sign in to comment.