Skip to content

Commit 18f3d01

Browse files
mwahligmwahlig
authored
Fix readme logo sparodev#15 (sparodev#16)
* Fix logo in readme * Update url of logo in readme * Update readme logo to reference relative filepath. sparodev#15 - Regenerated the docs website.
1 parent 7ce7d88 commit 18f3d01

File tree

81 files changed

+3855
-673
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

81 files changed

+3855
-673
lines changed

‎README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
![WingKit: a Lung Function Test SDK](../wingkit-logo.png)
1+
![WingKit: a Lung Function Test SDK](./wingkit-logo.png)
22

33
WingKit is a library that allows third parties to integrate with the Wing REST API to perform lung function tests.
44

‎docs/Classes.html

+125-8
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
<a class="header-link" href="index.html">
2323
WingKit Docs
2424
</a>
25-
(100% documented)
25+
(97% documented)
2626
</p>
2727

2828
<p class="header-col--secondary">
@@ -58,18 +58,30 @@
5858
<li class="nav-group-task">
5959
<a class="nav-group-task-link" href="Classes/Client.html">Client</a>
6060
</li>
61+
<li class="nav-group-task">
62+
<a class="nav-group-task-link" href="Classes.html#/s:7WingKit11JSONDecoderC">JSONDecoder</a>
63+
</li>
6164
<li class="nav-group-task">
6265
<a class="nav-group-task-link" href="Classes/ReachabilityMonitor.html">ReachabilityMonitor</a>
6366
</li>
6467
<li class="nav-group-task">
6568
<a class="nav-group-task-link" href="Classes/SensorMonitor.html">SensorMonitor</a>
6669
</li>
70+
<li class="nav-group-task">
71+
<a class="nav-group-task-link" href="Classes/Test.html">Test</a>
72+
</li>
73+
<li class="nav-group-task">
74+
<a class="nav-group-task-link" href="Classes/TestSession.html">TestSession</a>
75+
</li>
6776
<li class="nav-group-task">
6877
<a class="nav-group-task-link" href="Classes/TestSessionManager.html">TestSessionManager</a>
6978
</li>
7079
<li class="nav-group-task">
7180
<a class="nav-group-task-link" href="Classes/TestSessionRecorder.html">TestSessionRecorder</a>
7281
</li>
82+
<li class="nav-group-task">
83+
<a class="nav-group-task-link" href="Classes/UploadTarget.html">UploadTarget</a>
84+
</li>
7385
</ul>
7486
</li>
7587
<li class="nav-group-name">
@@ -148,12 +160,6 @@
148160
<li class="nav-group-task">
149161
<a class="nav-group-task-link" href="Structs/PatientData.html">PatientData</a>
150162
</li>
151-
<li class="nav-group-task">
152-
<a class="nav-group-task-link" href="Structs/Test.html">Test</a>
153-
</li>
154-
<li class="nav-group-task">
155-
<a class="nav-group-task-link" href="Structs/TestSession.html">TestSession</a>
156-
</li>
157163
</ul>
158164
</li>
159165
</ul>
@@ -301,6 +307,85 @@ <h4>Declaration</h4>
301307
</li>
302308
</ul>
303309
</div>
310+
<div class="task-group">
311+
<ul class="item-container">
312+
<li class="item">
313+
<div>
314+
<code>
315+
<a name="/s:7WingKit12UploadTargetC"></a>
316+
<a name="//apple_ref/swift/Class/UploadTarget" class="dashAnchor"></a>
317+
<a class="token" href="#/s:7WingKit12UploadTargetC">UploadTarget</a>
318+
</code>
319+
</div>
320+
<div class="height-container">
321+
<div class="pointer-container"></div>
322+
<section class="section">
323+
<div class="pointer"></div>
324+
<div class="abstract">
325+
<p>Undocumented</p>
326+
327+
<a href="Classes/UploadTarget.html" class="slightly-smaller">See more</a>
328+
</div>
329+
</section>
330+
</div>
331+
</li>
332+
</ul>
333+
</div>
334+
<div class="task-group">
335+
<ul class="item-container">
336+
<li class="item">
337+
<div>
338+
<code>
339+
<a name="/s:7WingKit11JSONDecoderC"></a>
340+
<a name="//apple_ref/swift/Class/JSONDecoder" class="dashAnchor"></a>
341+
<a class="token" href="#/s:7WingKit11JSONDecoderC">JSONDecoder</a>
342+
</code>
343+
</div>
344+
<div class="height-container">
345+
<div class="pointer-container"></div>
346+
<section class="section">
347+
<div class="pointer"></div>
348+
<div class="abstract">
349+
<p>Undocumented</p>
350+
351+
</div>
352+
</section>
353+
</div>
354+
</li>
355+
</ul>
356+
</div>
357+
<div class="task-group">
358+
<ul class="item-container">
359+
<li class="item">
360+
<div>
361+
<code>
362+
<a name="/s:7WingKit11TestSessionC"></a>
363+
<a name="//apple_ref/swift/Class/TestSession" class="dashAnchor"></a>
364+
<a class="token" href="#/s:7WingKit11TestSessionC">TestSession</a>
365+
</code>
366+
</div>
367+
<div class="height-container">
368+
<div class="pointer-container"></div>
369+
<section class="section">
370+
<div class="pointer"></div>
371+
<div class="abstract">
372+
<p>The <code>TestSession</code> struct represents a session of multiple lung function tests.</p>
373+
374+
<a href="Classes/TestSession.html" class="slightly-smaller">See more</a>
375+
</div>
376+
<div class="declaration">
377+
<h4>Declaration</h4>
378+
<div class="language">
379+
<p class="aside-title">Swift</p>
380+
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">TestSession</span><span class="p">:</span> <span class="kt">Decodable</span></code></pre>
381+
382+
</div>
383+
</div>
384+
</section>
385+
</div>
386+
</li>
387+
</ul>
388+
</div>
304389
<div class="task-group">
305390
<ul class="item-container">
306391
<li class="item">
@@ -366,13 +451,45 @@ <h4>Declaration</h4>
366451
</li>
367452
</ul>
368453
</div>
454+
<div class="task-group">
455+
<ul class="item-container">
456+
<li class="item">
457+
<div>
458+
<code>
459+
<a name="/s:7WingKit4TestC"></a>
460+
<a name="//apple_ref/swift/Class/Test" class="dashAnchor"></a>
461+
<a class="token" href="#/s:7WingKit4TestC">Test</a>
462+
</code>
463+
</div>
464+
<div class="height-container">
465+
<div class="pointer-container"></div>
466+
<section class="section">
467+
<div class="pointer"></div>
468+
<div class="abstract">
469+
<p>The <code>Test</code> struct represents a lung function test.</p>
470+
471+
<a href="Classes/Test.html" class="slightly-smaller">See more</a>
472+
</div>
473+
<div class="declaration">
474+
<h4>Declaration</h4>
475+
<div class="language">
476+
<p class="aside-title">Swift</p>
477+
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">Test</span><span class="p">:</span> <span class="kt">Decodable</span></code></pre>
478+
479+
</div>
480+
</div>
481+
</section>
482+
</div>
483+
</li>
484+
</ul>
485+
</div>
369486
</div>
370487
</section>
371488

372489
</article>
373490
</div>
374491
<section class="footer">
375-
<p>&copy; 2017 <a class="link" href="https://sparohealth.com" target="_blank" rel="external">Sparo</a>. All rights reserved. (Last updated: 2017-11-11)</p>
492+
<p>&copy; 2017 <a class="link" href="https://sparohealth.com" target="_blank" rel="external">Sparo</a>. All rights reserved. (Last updated: 2017-11-13)</p>
376493
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.4</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
377494
</section>
378495
</body>

‎docs/Classes/AmbientNoiseMonitor.html

+14-8
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
<a class="header-link" href="../index.html">
2424
WingKit Docs
2525
</a>
26-
(100% documented)
26+
(97% documented)
2727
</p>
2828

2929
<p class="header-col--secondary">
@@ -59,18 +59,30 @@
5959
<li class="nav-group-task">
6060
<a class="nav-group-task-link" href="../Classes/Client.html">Client</a>
6161
</li>
62+
<li class="nav-group-task">
63+
<a class="nav-group-task-link" href="../Classes.html#/s:7WingKit11JSONDecoderC">JSONDecoder</a>
64+
</li>
6265
<li class="nav-group-task">
6366
<a class="nav-group-task-link" href="../Classes/ReachabilityMonitor.html">ReachabilityMonitor</a>
6467
</li>
6568
<li class="nav-group-task">
6669
<a class="nav-group-task-link" href="../Classes/SensorMonitor.html">SensorMonitor</a>
6770
</li>
71+
<li class="nav-group-task">
72+
<a class="nav-group-task-link" href="../Classes/Test.html">Test</a>
73+
</li>
74+
<li class="nav-group-task">
75+
<a class="nav-group-task-link" href="../Classes/TestSession.html">TestSession</a>
76+
</li>
6877
<li class="nav-group-task">
6978
<a class="nav-group-task-link" href="../Classes/TestSessionManager.html">TestSessionManager</a>
7079
</li>
7180
<li class="nav-group-task">
7281
<a class="nav-group-task-link" href="../Classes/TestSessionRecorder.html">TestSessionRecorder</a>
7382
</li>
83+
<li class="nav-group-task">
84+
<a class="nav-group-task-link" href="../Classes/UploadTarget.html">UploadTarget</a>
85+
</li>
7486
</ul>
7587
</li>
7688
<li class="nav-group-name">
@@ -149,12 +161,6 @@
149161
<li class="nav-group-task">
150162
<a class="nav-group-task-link" href="../Structs/PatientData.html">PatientData</a>
151163
</li>
152-
<li class="nav-group-task">
153-
<a class="nav-group-task-link" href="../Structs/Test.html">Test</a>
154-
</li>
155-
<li class="nav-group-task">
156-
<a class="nav-group-task-link" href="../Structs/TestSession.html">TestSession</a>
157-
</li>
158164
</ul>
159165
</li>
160166
</ul>
@@ -389,7 +395,7 @@ <h4>Declaration</h4>
389395
</article>
390396
</div>
391397
<section class="footer">
392-
<p>&copy; 2017 <a class="link" href="https://sparohealth.com" target="_blank" rel="external">Sparo</a>. All rights reserved. (Last updated: 2017-11-11)</p>
398+
<p>&copy; 2017 <a class="link" href="https://sparohealth.com" target="_blank" rel="external">Sparo</a>. All rights reserved. (Last updated: 2017-11-13)</p>
393399
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.4</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
394400
</section>
395401
</body>

‎docs/Classes/Client.html

+20-14
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
<a class="header-link" href="../index.html">
2424
WingKit Docs
2525
</a>
26-
(100% documented)
26+
(97% documented)
2727
</p>
2828

2929
<p class="header-col--secondary">
@@ -59,18 +59,30 @@
5959
<li class="nav-group-task">
6060
<a class="nav-group-task-link" href="../Classes/Client.html">Client</a>
6161
</li>
62+
<li class="nav-group-task">
63+
<a class="nav-group-task-link" href="../Classes.html#/s:7WingKit11JSONDecoderC">JSONDecoder</a>
64+
</li>
6265
<li class="nav-group-task">
6366
<a class="nav-group-task-link" href="../Classes/ReachabilityMonitor.html">ReachabilityMonitor</a>
6467
</li>
6568
<li class="nav-group-task">
6669
<a class="nav-group-task-link" href="../Classes/SensorMonitor.html">SensorMonitor</a>
6770
</li>
71+
<li class="nav-group-task">
72+
<a class="nav-group-task-link" href="../Classes/Test.html">Test</a>
73+
</li>
74+
<li class="nav-group-task">
75+
<a class="nav-group-task-link" href="../Classes/TestSession.html">TestSession</a>
76+
</li>
6877
<li class="nav-group-task">
6978
<a class="nav-group-task-link" href="../Classes/TestSessionManager.html">TestSessionManager</a>
7079
</li>
7180
<li class="nav-group-task">
7281
<a class="nav-group-task-link" href="../Classes/TestSessionRecorder.html">TestSessionRecorder</a>
7382
</li>
83+
<li class="nav-group-task">
84+
<a class="nav-group-task-link" href="../Classes/UploadTarget.html">UploadTarget</a>
85+
</li>
7486
</ul>
7587
</li>
7688
<li class="nav-group-name">
@@ -149,12 +161,6 @@
149161
<li class="nav-group-task">
150162
<a class="nav-group-task-link" href="../Structs/PatientData.html">PatientData</a>
151163
</li>
152-
<li class="nav-group-task">
153-
<a class="nav-group-task-link" href="../Structs/Test.html">Test</a>
154-
</li>
155-
<li class="nav-group-task">
156-
<a class="nav-group-task-link" href="../Structs/TestSession.html">TestSession</a>
157-
</li>
158164
</ul>
159165
</li>
160166
</ul>
@@ -387,9 +393,9 @@ <h3 class="section-name">Test Sessions</h3>
387393
<li class="item">
388394
<div>
389395
<code>
390-
<a name="/s:7WingKit6ClientC17createTestSessionyAA11PatientDataV4with_yAA0eF0VSg_s5Error_pSgtc10completiontF"></a>
396+
<a name="/s:7WingKit6ClientC17createTestSessionyAA11PatientDataV4with_yAA0eF0CSg_s5Error_pSgtc10completiontF"></a>
391397
<a name="//apple_ref/swift/Method/createTestSession(with:completion:)" class="dashAnchor"></a>
392-
<a class="token" href="#/s:7WingKit6ClientC17createTestSessionyAA11PatientDataV4with_yAA0eF0VSg_s5Error_pSgtc10completiontF">createTestSession(with:completion:)</a>
398+
<a class="token" href="#/s:7WingKit6ClientC17createTestSessionyAA11PatientDataV4with_yAA0eF0CSg_s5Error_pSgtc10completiontF">createTestSession(with:completion:)</a>
393399
</code>
394400
</div>
395401
<div class="height-container">
@@ -419,7 +425,7 @@ <h4>Declaration</h4>
419425
<div class="language">
420426
<p class="aside-title">Swift</p>
421427
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">createTestSession</span><span class="p">(</span><span class="n">with</span> <span class="nv">patientData</span><span class="p">:</span> <span class="kt"><a href="../Structs/PatientData.html">PatientData</a></span><span class="p">,</span>
422-
<span class="nv">completion</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="n">_</span> <span class="nv">testSession</span><span class="p">:</span> <span class="kt"><a href="../Structs/TestSession.html">TestSession</a></span><span class="p">?,</span> <span class="n">_</span> <span class="nv">error</span><span class="p">:</span> <span class="kt">Error</span><span class="p">?)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)</span></code></pre>
428+
<span class="nv">completion</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="n">_</span> <span class="nv">testSession</span><span class="p">:</span> <span class="kt"><a href="../Classes/TestSession.html">TestSession</a></span><span class="p">?,</span> <span class="n">_</span> <span class="nv">error</span><span class="p">:</span> <span class="kt">Error</span><span class="p">?)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)</span></code></pre>
423429

424430
</div>
425431
</div>
@@ -484,9 +490,9 @@ <h4>Parameters</h4>
484490
<li class="item">
485491
<div>
486492
<code>
487-
<a name="/s:7WingKit6ClientC19retrieveTestSessionySS6withId_yAA0eF0VSg_s5Error_pSgtc10completiontF"></a>
493+
<a name="/s:7WingKit6ClientC19retrieveTestSessionySS6withId_yAA0eF0CSg_s5Error_pSgtc10completiontF"></a>
488494
<a name="//apple_ref/swift/Method/retrieveTestSession(withId:completion:)" class="dashAnchor"></a>
489-
<a class="token" href="#/s:7WingKit6ClientC19retrieveTestSessionySS6withId_yAA0eF0VSg_s5Error_pSgtc10completiontF">retrieveTestSession(withId:completion:)</a>
495+
<a class="token" href="#/s:7WingKit6ClientC19retrieveTestSessionySS6withId_yAA0eF0CSg_s5Error_pSgtc10completiontF">retrieveTestSession(withId:completion:)</a>
490496
</code>
491497
</div>
492498
<div class="height-container">
@@ -515,7 +521,7 @@ <h4>Parameters</h4>
515521
<h4>Declaration</h4>
516522
<div class="language">
517523
<p class="aside-title">Swift</p>
518-
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">retrieveTestSession</span><span class="p">(</span><span class="n">withId</span> <span class="nv">id</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="n">_</span> <span class="nv">testSession</span><span class="p">:</span> <span class="kt"><a href="../Structs/TestSession.html">TestSession</a></span><span class="p">?,</span> <span class="n">_</span> <span class="nv">error</span><span class="p">:</span> <span class="kt">Error</span><span class="p">?)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)</span></code></pre>
524+
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">retrieveTestSession</span><span class="p">(</span><span class="n">withId</span> <span class="nv">id</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="n">_</span> <span class="nv">testSession</span><span class="p">:</span> <span class="kt"><a href="../Classes/TestSession.html">TestSession</a></span><span class="p">?,</span> <span class="n">_</span> <span class="nv">error</span><span class="p">:</span> <span class="kt">Error</span><span class="p">?)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)</span></code></pre>
519525

520526
</div>
521527
</div>
@@ -585,7 +591,7 @@ <h4>Parameters</h4>
585591
</article>
586592
</div>
587593
<section class="footer">
588-
<p>&copy; 2017 <a class="link" href="https://sparohealth.com" target="_blank" rel="external">Sparo</a>. All rights reserved. (Last updated: 2017-11-11)</p>
594+
<p>&copy; 2017 <a class="link" href="https://sparohealth.com" target="_blank" rel="external">Sparo</a>. All rights reserved. (Last updated: 2017-11-13)</p>
589595
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.4</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
590596
</section>
591597
</body>

0 commit comments

Comments
 (0)