Skip to content

Commit 3a09e7d

Browse files
nuclearacenuclearace
committed
update docs
1 parent 31aed9e commit 3a09e7d

38 files changed

+59
-221
lines changed

‎docs/12to13.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -274,7 +274,7 @@ <h2 id='what-to-call-connect-on' class='heading'>What to call connect on</h2>
274274
</article>
275275
</div>
276276
<section class="footer">
277-
<p>&copy; 2018 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2018-01-10)</p>
277+
<p>&copy; 2018 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2018-03-11)</p>
278278
<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>
279279
</section>
280280
</body>

‎docs/Classes.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -446,7 +446,7 @@ <h4>Declaration</h4>
446446
</article>
447447
</div>
448448
<section class="footer">
449-
<p>&copy; 2018 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2018-01-10)</p>
449+
<p>&copy; 2018 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2018-03-11)</p>
450450
<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>
451451
</section>
452452
</body>

‎docs/Classes/OnAckCallback.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -236,7 +236,7 @@ <h4>Parameters</h4>
236236
<tr>
237237
<td>
238238
<code>
239-
<em>after</em>
239+
<em>seconds</em>
240240
</code>
241241
</td>
242242
<td>
@@ -272,7 +272,7 @@ <h4>Parameters</h4>
272272
</article>
273273
</div>
274274
<section class="footer">
275-
<p>&copy; 2018 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2018-01-10)</p>
275+
<p>&copy; 2018 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2018-03-11)</p>
276276
<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>
277277
</section>
278278
</body>

‎docs/Classes/SSLSecurity.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -418,7 +418,7 @@ <h4>Return Value</h4>
418418
</article>
419419
</div>
420420
<section class="footer">
421-
<p>&copy; 2018 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2018-01-10)</p>
421+
<p>&copy; 2018 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2018-03-11)</p>
422422
<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>
423423
</section>
424424
</body>

‎docs/Classes/SocketAckEmitter.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -411,7 +411,7 @@ <h4>Parameters</h4>
411411
</article>
412412
</div>
413413
<section class="footer">
414-
<p>&copy; 2018 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2018-01-10)</p>
414+
<p>&copy; 2018 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2018-03-11)</p>
415415
<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>
416416
</section>
417417
</body>

‎docs/Classes/SocketAnyEvent.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -288,7 +288,7 @@ <h4>Declaration</h4>
288288
</article>
289289
</div>
290290
<section class="footer">
291-
<p>&copy; 2018 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2018-01-10)</p>
291+
<p>&copy; 2018 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2018-03-11)</p>
292292
<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>
293293
</section>
294294
</body>

‎docs/Classes/SocketEngine.html

+3-81
Original file line numberDiff line numberDiff line change
@@ -1267,19 +1267,6 @@ <h4>Parameters</h4>
12671267
</div>
12681268
</td>
12691269
</tr>
1270-
<tr>
1271-
<td>
1272-
<code>
1273-
<em>fromPolling</em>
1274-
</code>
1275-
</td>
1276-
<td>
1277-
<div>
1278-
<p>Whether this message is from long-polling.
1279-
If <code>true</code> we might have to fix utf8 encoding.</p>
1280-
</div>
1281-
</td>
1282-
</tr>
12831270
</tbody>
12841271
</table>
12851272
</div>
@@ -1358,7 +1345,7 @@ <h4>Parameters</h4>
13581345
<tr>
13591346
<td>
13601347
<code>
1361-
<em>withType</em>
1348+
<em>type</em>
13621349
</code>
13631350
</td>
13641351
<td>
@@ -1370,7 +1357,7 @@ <h4>Parameters</h4>
13701357
<tr>
13711358
<td>
13721359
<code>
1373-
<em>withData</em>
1360+
<em>data</em>
13741361
</code>
13751362
</td>
13761363
<td>
@@ -1387,71 +1374,6 @@ <h4>Parameters</h4>
13871374
</li>
13881375
</ul>
13891376
</div>
1390-
<div class="task-group">
1391-
<div class="task-name-container">
1392-
<a name="/Starscream%20delegate%20conformance"></a>
1393-
<a name="//apple_ref/swift/Section/Starscream delegate conformance" class="dashAnchor"></a>
1394-
<a href="#/Starscream%20delegate%20conformance">
1395-
<h3 class="section-name">Starscream delegate conformance</h3>
1396-
</a>
1397-
</div>
1398-
<ul class="item-container">
1399-
<li class="item">
1400-
<div>
1401-
<code>
1402-
<a name="/s:8SocketIO0A6EngineC19websocketDidConnecty10Starscream03WebA6Client_p6socket_tF"></a>
1403-
<a name="//apple_ref/swift/Method/websocketDidConnect(socket:)" class="dashAnchor"></a>
1404-
<a class="token" href="#/s:8SocketIO0A6EngineC19websocketDidConnecty10Starscream03WebA6Client_p6socket_tF">websocketDidConnect(socket:)</a>
1405-
</code>
1406-
</div>
1407-
<div class="height-container">
1408-
<div class="pointer-container"></div>
1409-
<section class="section">
1410-
<div class="pointer"></div>
1411-
<div class="abstract">
1412-
<p>Delegate method for connection.</p>
1413-
1414-
</div>
1415-
<div class="declaration">
1416-
<h4>Declaration</h4>
1417-
<div class="language">
1418-
<p class="aside-title">Swift</p>
1419-
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">websocketDidConnect</span><span class="p">(</span><span class="nv">socket</span><span class="p">:</span> <span class="kt">WebSocketClient</span><span class="p">)</span></code></pre>
1420-
1421-
</div>
1422-
</div>
1423-
</section>
1424-
</div>
1425-
</li>
1426-
<li class="item">
1427-
<div>
1428-
<code>
1429-
<a name="/s:8SocketIO0A6EngineC22websocketDidDisconnecty10Starscream03WebA6Client_p6socket_s5Error_pSg5errortF"></a>
1430-
<a name="//apple_ref/swift/Method/websocketDidDisconnect(socket:error:)" class="dashAnchor"></a>
1431-
<a class="token" href="#/s:8SocketIO0A6EngineC22websocketDidDisconnecty10Starscream03WebA6Client_p6socket_s5Error_pSg5errortF">websocketDidDisconnect(socket:error:)</a>
1432-
</code>
1433-
</div>
1434-
<div class="height-container">
1435-
<div class="pointer-container"></div>
1436-
<section class="section">
1437-
<div class="pointer"></div>
1438-
<div class="abstract">
1439-
<p>Delegate method for disconnection.</p>
1440-
1441-
</div>
1442-
<div class="declaration">
1443-
<h4>Declaration</h4>
1444-
<div class="language">
1445-
<p class="aside-title">Swift</p>
1446-
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">websocketDidDisconnect</span><span class="p">(</span><span class="nv">socket</span><span class="p">:</span> <span class="kt">WebSocketClient</span><span class="p">,</span> <span class="nv">error</span><span class="p">:</span> <span class="kt">Error</span><span class="p">?)</span></code></pre>
1447-
1448-
</div>
1449-
</div>
1450-
</section>
1451-
</div>
1452-
</li>
1453-
</ul>
1454-
</div>
14551377
<div class="task-group">
14561378
<div class="task-name-container">
14571379
<a name="/URLSessionDelegate%20methods"></a>
@@ -1496,7 +1418,7 @@ <h4>Declaration</h4>
14961418
</article>
14971419
</div>
14981420
<section class="footer">
1499-
<p>&copy; 2018 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2018-01-10)</p>
1421+
<p>&copy; 2018 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2018-03-11)</p>
15001422
<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>
15011423
</section>
15021424
</body>

‎docs/Classes/SocketIOClient.html

+7-7
Original file line numberDiff line numberDiff line change
@@ -428,12 +428,12 @@ <h4>Parameters</h4>
428428
<tr>
429429
<td>
430430
<code>
431-
<em>socketURL</em>
431+
<em>nsp</em>
432432
</code>
433433
</td>
434434
<td>
435435
<div>
436-
<p>The url of the socket.io server.</p>
436+
<p>The namespace of the socket.</p>
437437
</div>
438438
</td>
439439
</tr>
@@ -529,7 +529,7 @@ <h4>Parameters</h4>
529529
<tr>
530530
<td>
531531
<code>
532-
<em>withHandler</em>
532+
<em>handler</em>
533533
</code>
534534
</td>
535535
<td>
@@ -771,7 +771,7 @@ <h4>Parameters</h4>
771771
<tr>
772772
<td>
773773
<code>
774-
<em>with</em>
774+
<em>items</em>
775775
</code>
776776
</td>
777777
<td>
@@ -912,7 +912,7 @@ <h4>Parameters</h4>
912912
<tr>
913913
<td>
914914
<code>
915-
<em>with</em>
915+
<em>items</em>
916916
</code>
917917
</td>
918918
<td>
@@ -1174,7 +1174,7 @@ <h4>Parameters</h4>
11741174
<tr>
11751175
<td>
11761176
<code>
1177-
<em>withAck</em>
1177+
<em>ack</em>
11781178
</code>
11791179
</td>
11801180
<td>
@@ -1818,7 +1818,7 @@ <h4>Parameters</h4>
18181818
</article>
18191819
</div>
18201820
<section class="footer">
1821-
<p>&copy; 2018 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2018-01-10)</p>
1821+
<p>&copy; 2018 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2018-03-11)</p>
18221822
<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>
18231823
</section>
18241824
</body>

‎docs/Classes/SocketManager.html

+4-4
Original file line numberDiff line numberDiff line change
@@ -895,7 +895,7 @@ <h4>Parameters</h4>
895895
<tr>
896896
<td>
897897
<code>
898-
<em>forNamespace</em>
898+
<em>nsp</em>
899899
</code>
900900
</td>
901901
<td>
@@ -1059,7 +1059,7 @@ <h4>Parameters</h4>
10591059
<tr>
10601060
<td>
10611061
<code>
1062-
<em>withItems</em>
1062+
<em>items</em>
10631063
</code>
10641064
</td>
10651065
<td>
@@ -1507,7 +1507,7 @@ <h4>Parameters</h4>
15071507
<tr>
15081508
<td>
15091509
<code>
1510-
<em>forNamespace</em>
1510+
<em>nsp</em>
15111511
</code>
15121512
</td>
15131513
<td>
@@ -1534,7 +1534,7 @@ <h4>Return Value</h4>
15341534
</article>
15351535
</div>
15361536
<section class="footer">
1537-
<p>&copy; 2018 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2018-01-10)</p>
1537+
<p>&copy; 2018 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2018-03-11)</p>
15381538
<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>
15391539
</section>
15401540
</body>

‎docs/Enums.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -381,7 +381,7 @@ <h4>Declaration</h4>
381381
</article>
382382
</div>
383383
<section class="footer">
384-
<p>&copy; 2018 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2018-01-10)</p>
384+
<p>&copy; 2018 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2018-03-11)</p>
385385
<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>
386386
</section>
387387
</body>

‎docs/Enums/SocketAckStatus.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -227,7 +227,7 @@ <h4>Declaration</h4>
227227
</article>
228228
</div>
229229
<section class="footer">
230-
<p>&copy; 2018 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2018-01-10)</p>
230+
<p>&copy; 2018 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2018-03-11)</p>
231231
<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>
232232
</section>
233233
</body>

‎docs/Enums/SocketClientEvent.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -492,7 +492,7 @@ <h4>Declaration</h4>
492492
</article>
493493
</div>
494494
<section class="footer">
495-
<p>&copy; 2018 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2018-01-10)</p>
495+
<p>&copy; 2018 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2018-03-11)</p>
496496
<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>
497497
</section>
498498
</body>

‎docs/Enums/SocketEnginePacketType.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -413,7 +413,7 @@ <h4>Declaration</h4>
413413
</article>
414414
</div>
415415
<section class="footer">
416-
<p>&copy; 2018 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2018-01-10)</p>
416+
<p>&copy; 2018 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2018-03-11)</p>
417417
<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>
418418
</section>
419419
</body>

‎docs/Enums/SocketIOClientOption.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -868,7 +868,7 @@ <h4>Return Value</h4>
868868
</article>
869869
</div>
870870
<section class="footer">
871-
<p>&copy; 2018 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2018-01-10)</p>
871+
<p>&copy; 2018 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2018-03-11)</p>
872872
<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>
873873
</section>
874874
</body>

‎docs/Enums/SocketIOStatus.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -387,7 +387,7 @@ <h4>Declaration</h4>
387387
</article>
388388
</div>
389389
<section class="footer">
390-
<p>&copy; 2018 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2018-01-10)</p>
390+
<p>&copy; 2018 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2018-03-11)</p>
391391
<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>
392392
</section>
393393
</body>

0 commit comments

Comments
 (0)