Skip to content

Commit 4929c84

Browse files
committed
update docs
1 parent 04e90fc commit 4929c84

27 files changed

+124
-131
lines changed

docs/Classes.html

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -256,29 +256,25 @@ <h4>Declaration</h4>
256256
<li class="item">
257257
<div>
258258
<code>
259-
<a name="/s:C8SocketIO14SocketIOClient"></a>
260-
<a name="//apple_ref/swift/Class/SocketIOClient" class="dashAnchor"></a>
261-
<a class="token" href="#/s:C8SocketIO14SocketIOClient">SocketIOClient</a>
259+
<a name="/s:C8SocketIO14SocketAnyEvent"></a>
260+
<a name="//apple_ref/swift/Class/SocketAnyEvent" class="dashAnchor"></a>
261+
<a class="token" href="#/s:C8SocketIO14SocketAnyEvent">SocketAnyEvent</a>
262262
</code>
263263
</div>
264264
<div class="height-container">
265265
<div class="pointer-container"></div>
266266
<section class="section">
267267
<div class="pointer"></div>
268268
<div class="abstract">
269-
<p>The main class for SocketIOClientSwift.</p>
270-
271-
<p><strong>NOTE</strong>: The client is not thread/queue safe, all interaction with the socket should be done on the <code>handleQueue</code></p>
272-
273-
<p>Represents a socket.io-client. Most interaction with socket.io will be through this class.</p>
269+
<p>Represents some event that was received.</p>
274270

275-
<a href="Classes/SocketIOClient.html" class="slightly-smaller">See more</a>
271+
<a href="Classes/SocketAnyEvent.html" class="slightly-smaller">See more</a>
276272
</div>
277273
<div class="declaration">
278274
<h4>Declaration</h4>
279275
<div class="language">
280276
<p class="aside-title">Swift</p>
281-
<pre class="highlight"><code><span class="n">open</span> <span class="kd">class</span> <span class="kt">SocketIOClient</span> <span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span> <span class="kt">SocketIOClientSpec</span><span class="p">,</span> <span class="kt"><a href="Protocols/SocketEngineClient.html">SocketEngineClient</a></span><span class="p">,</span> <span class="kt">SocketParsable</span></code></pre>
277+
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">final</span> <span class="kd">class</span> <span class="kt">SocketAnyEvent</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre>
282278

283279
</div>
284280
</div>
@@ -292,25 +288,29 @@ <h4>Declaration</h4>
292288
<li class="item">
293289
<div>
294290
<code>
295-
<a name="/s:C8SocketIO14SocketAnyEvent"></a>
296-
<a name="//apple_ref/swift/Class/SocketAnyEvent" class="dashAnchor"></a>
297-
<a class="token" href="#/s:C8SocketIO14SocketAnyEvent">SocketAnyEvent</a>
291+
<a name="/s:C8SocketIO14SocketIOClient"></a>
292+
<a name="//apple_ref/swift/Class/SocketIOClient" class="dashAnchor"></a>
293+
<a class="token" href="#/s:C8SocketIO14SocketIOClient">SocketIOClient</a>
298294
</code>
299295
</div>
300296
<div class="height-container">
301297
<div class="pointer-container"></div>
302298
<section class="section">
303299
<div class="pointer"></div>
304300
<div class="abstract">
305-
<p>Represents some event that was received.</p>
301+
<p>The main class for SocketIOClientSwift.</p>
306302

307-
<a href="Classes/SocketAnyEvent.html" class="slightly-smaller">See more</a>
303+
<p><strong>NOTE</strong>: The client is not thread/queue safe, all interaction with the socket should be done on the <code>handleQueue</code></p>
304+
305+
<p>Represents a socket.io-client. Most interaction with socket.io will be through this class.</p>
306+
307+
<a href="Classes/SocketIOClient.html" class="slightly-smaller">See more</a>
308308
</div>
309309
<div class="declaration">
310310
<h4>Declaration</h4>
311311
<div class="language">
312312
<p class="aside-title">Swift</p>
313-
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">final</span> <span class="kd">class</span> <span class="kt">SocketAnyEvent</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre>
313+
<pre class="highlight"><code><span class="n">open</span> <span class="kd">class</span> <span class="kt">SocketIOClient</span> <span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span> <span class="kt">SocketIOClientSpec</span><span class="p">,</span> <span class="kt"><a href="Protocols/SocketEngineClient.html">SocketEngineClient</a></span><span class="p">,</span> <span class="kt">SocketParsable</span></code></pre>
314314

315315
</div>
316316
</div>
@@ -372,7 +372,7 @@ <h4>Declaration</h4>
372372
</article>
373373
</div>
374374
<section class="footer">
375-
<p>&copy; 2017 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2017-08-17)</p>
375+
<p>&copy; 2017 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2017-08-31)</p>
376376
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
377377
</section>
378378
</body>

docs/Classes/OnAckCallback.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -239,7 +239,7 @@ <h4>Parameters</h4>
239239
</article>
240240
</div>
241241
<section class="footer">
242-
<p>&copy; 2017 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2017-08-17)</p>
242+
<p>&copy; 2017 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2017-08-31)</p>
243243
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
244244
</section>
245245
</body>

docs/Classes/SocketAckEmitter.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -309,7 +309,7 @@ <h4>Parameters</h4>
309309
</article>
310310
</div>
311311
<section class="footer">
312-
<p>&copy; 2017 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2017-08-17)</p>
312+
<p>&copy; 2017 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2017-08-31)</p>
313313
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
314314
</section>
315315
</body>

docs/Classes/SocketAnyEvent.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -255,7 +255,7 @@ <h4>Declaration</h4>
255255
</article>
256256
</div>
257257
<section class="footer">
258-
<p>&copy; 2017 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2017-08-17)</p>
258+
<p>&copy; 2017 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2017-08-31)</p>
259259
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
260260
</section>
261261
</body>

docs/Classes/SocketClientManager.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -443,7 +443,7 @@ <h4>Declaration</h4>
443443
</article>
444444
</div>
445445
<section class="footer">
446-
<p>&copy; 2017 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2017-08-17)</p>
446+
<p>&copy; 2017 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2017-08-31)</p>
447447
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
448448
</section>
449449
</body>

docs/Classes/SocketEngine.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1433,7 +1433,7 @@ <h4>Declaration</h4>
14331433
</article>
14341434
</div>
14351435
<section class="footer">
1436-
<p>&copy; 2017 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2017-08-17)</p>
1436+
<p>&copy; 2017 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2017-08-31)</p>
14371437
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
14381438
</section>
14391439
</body>

docs/Classes/SocketIOClient.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1856,7 +1856,7 @@ <h4>Declaration</h4>
18561856
</article>
18571857
</div>
18581858
<section class="footer">
1859-
<p>&copy; 2017 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2017-08-17)</p>
1859+
<p>&copy; 2017 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2017-08-31)</p>
18601860
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
18611861
</section>
18621862
</body>

0 commit comments

Comments
 (0)