Skip to content

Commit 74c45d5

Browse files
nuclearacenuclearace
committed
update docs
1 parent 619db00 commit 74c45d5

25 files changed

+90
-89
lines changed

Diff for: ‎docs/Classes.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -364,8 +364,8 @@ <h4>Declaration</h4>
364364
</article>
365365
</div>
366366
<section class="footer">
367-
<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-07-24)</p>
368-
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.3</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
367+
<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-06)</p>
368+
<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>
369369
</section>
370370
</body>
371371
</div>

Diff for: ‎docs/Classes/OnAckCallback.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -213,7 +213,7 @@ <h4>Parameters</h4>
213213
<td>
214214
<div>
215215
<p>The callback called when an ack is received, or when a timeout happens.
216-
To check for timeout, use <code>SocketAckStatus</code>&rsquo;s <code>noAck</code> case.</p>
216+
To check for timeout, use <code>SocketAckStatus</code>&lsquo;s <code>noAck</code> case.</p>
217217
</div>
218218
</td>
219219
</tr>
@@ -231,8 +231,8 @@ <h4>Parameters</h4>
231231
</article>
232232
</div>
233233
<section class="footer">
234-
<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-07-24)</p>
235-
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.3</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
234+
<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-06)</p>
235+
<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>
236236
</section>
237237
</body>
238238
</div>

Diff for: ‎docs/Classes/SocketAckEmitter.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -301,8 +301,8 @@ <h4>Parameters</h4>
301301
</article>
302302
</div>
303303
<section class="footer">
304-
<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-07-24)</p>
305-
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.3</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
304+
<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-06)</p>
305+
<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>
306306
</section>
307307
</body>
308308
</div>

Diff for: ‎docs/Classes/SocketAnyEvent.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -247,8 +247,8 @@ <h4>Declaration</h4>
247247
</article>
248248
</div>
249249
<section class="footer">
250-
<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-07-24)</p>
251-
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.3</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
250+
<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-06)</p>
251+
<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>
252252
</section>
253253
</body>
254254
</div>

Diff for: ‎docs/Classes/SocketClientManager.html

+16-16
Original file line numberDiff line numberDiff line change
@@ -176,58 +176,58 @@ <h3 class="section-name">Properties.</h3>
176176
<li class="item">
177177
<div>
178178
<code>
179-
<a name="/s:ZvC8SocketIO19SocketClientManager13sharedManagerS0_"></a>
180-
<a name="//apple_ref/swift/Variable/sharedManager" class="dashAnchor"></a>
181-
<a class="token" href="#/s:ZvC8SocketIO19SocketClientManager13sharedManagerS0_">sharedManager</a>
179+
<a name="/s:iC8SocketIO19SocketClientManager9subscriptFSSGSqCS_14SocketIOClient_"></a>
180+
<a name="//apple_ref/swift/Method/subscript(_:)" class="dashAnchor"></a>
181+
<a class="token" href="#/s:iC8SocketIO19SocketClientManager9subscriptFSSGSqCS_14SocketIOClient_">subscript(_:)</a>
182182
</code>
183183
</div>
184184
<div class="height-container">
185185
<div class="pointer-container"></div>
186186
<section class="section">
187187
<div class="pointer"></div>
188188
<div class="abstract">
189-
<p>The shared manager.</p>
189+
<p>Gets a socket by its name.</p>
190190

191191
</div>
192192
<div class="declaration">
193193
<h4>Declaration</h4>
194194
<div class="language">
195195
<p class="aside-title">Swift</p>
196-
<pre class="highlight"><code><span class="n">open</span> <span class="kd">static</span> <span class="k">let</span> <span class="nv">sharedManager</span> <span class="o">=</span> <span class="kt">SocketClientManager</span><span class="p">()</span></code></pre>
196+
<pre class="highlight"><code><span class="n">open</span> <span class="nf">subscript</span><span class="p">(</span><span class="nv">string</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Classes/SocketIOClient.html">SocketIOClient</a></span><span class="p">?</span></code></pre>
197197

198198
</div>
199199
</div>
200+
<div>
201+
<h4>Return Value</h4>
202+
<p>The socket, if one had the given name.</p>
203+
</div>
200204
</section>
201205
</div>
202206
</li>
203207
<li class="item">
204208
<div>
205209
<code>
206-
<a name="/s:iC8SocketIO19SocketClientManager9subscriptFSSGSqCS_14SocketIOClient_"></a>
207-
<a name="//apple_ref/swift/Method/subscript(_:)" class="dashAnchor"></a>
208-
<a class="token" href="#/s:iC8SocketIO19SocketClientManager9subscriptFSSGSqCS_14SocketIOClient_">subscript(_:)</a>
210+
<a name="/s:ZvC8SocketIO19SocketClientManager13sharedManagerS0_"></a>
211+
<a name="//apple_ref/swift/Variable/sharedManager" class="dashAnchor"></a>
212+
<a class="token" href="#/s:ZvC8SocketIO19SocketClientManager13sharedManagerS0_">sharedManager</a>
209213
</code>
210214
</div>
211215
<div class="height-container">
212216
<div class="pointer-container"></div>
213217
<section class="section">
214218
<div class="pointer"></div>
215219
<div class="abstract">
216-
<p>Gets a socket by its name.</p>
220+
<p>The shared manager.</p>
217221

218222
</div>
219223
<div class="declaration">
220224
<h4>Declaration</h4>
221225
<div class="language">
222226
<p class="aside-title">Swift</p>
223-
<pre class="highlight"><code><span class="n">open</span> <span class="nf">subscript</span><span class="p">(</span><span class="nv">string</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Classes/SocketIOClient.html">SocketIOClient</a></span><span class="p">?</span></code></pre>
227+
<pre class="highlight"><code><span class="n">open</span> <span class="kd">static</span> <span class="k">let</span> <span class="nv">sharedManager</span> <span class="o">=</span> <span class="kt">SocketClientManager</span><span class="p">()</span></code></pre>
224228

225229
</div>
226230
</div>
227-
<div>
228-
<h4>Return Value</h4>
229-
<p>The socket, if one had the given name.</p>
230-
</div>
231231
</section>
232232
</div>
233233
</li>
@@ -435,8 +435,8 @@ <h4>Declaration</h4>
435435
</article>
436436
</div>
437437
<section class="footer">
438-
<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-07-24)</p>
439-
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.3</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
438+
<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-06)</p>
439+
<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>
440440
</section>
441441
</body>
442442
</div>

Diff for: ‎docs/Classes/SocketEngine.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -1425,8 +1425,8 @@ <h4>Declaration</h4>
14251425
</article>
14261426
</div>
14271427
<section class="footer">
1428-
<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-07-24)</p>
1429-
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.3</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
1428+
<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-06)</p>
1429+
<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>
14301430
</section>
14311431
</body>
14321432
</div>

Diff for: ‎docs/Classes/SocketIOClient.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -1738,8 +1738,8 @@ <h4>Declaration</h4>
17381738
</article>
17391739
</div>
17401740
<section class="footer">
1741-
<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-07-24)</p>
1742-
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.3</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
1741+
<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-06)</p>
1742+
<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>
17431743
</section>
17441744
</body>
17451745
</div>

Diff for: ‎docs/Enums.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -308,8 +308,8 @@ <h4>Declaration</h4>
308308
</article>
309309
</div>
310310
<section class="footer">
311-
<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-07-24)</p>
312-
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.3</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
311+
<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-06)</p>
312+
<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>
313313
</section>
314314
</body>
315315
</div>

Diff for: ‎docs/Enums/SocketAckStatus.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -186,8 +186,8 @@ <h4>Declaration</h4>
186186
</article>
187187
</div>
188188
<section class="footer">
189-
<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-07-24)</p>
190-
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.3</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
189+
<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-06)</p>
190+
<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>
191191
</section>
192192
</body>
193193
</div>

Diff for: ‎docs/Enums/SocketClientEvent.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -347,8 +347,8 @@ <h4>Declaration</h4>
347347
</article>
348348
</div>
349349
<section class="footer">
350-
<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-07-24)</p>
351-
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.3</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
350+
<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-06)</p>
351+
<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>
352352
</section>
353353
</body>
354354
</div>

Diff for: ‎docs/Enums/SocketEnginePacketType.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -372,8 +372,8 @@ <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-07-24)</p>
376-
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.3</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</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-06)</p>
376+
<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>
379379
</div>

Diff for: ‎docs/Enums/SocketIOClientOption.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -922,8 +922,8 @@ <h4>Return Value</h4>
922922
</article>
923923
</div>
924924
<section class="footer">
925-
<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-07-24)</p>
926-
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.3</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
925+
<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-06)</p>
926+
<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>
927927
</section>
928928
</body>
929929
</div>

Diff for: ‎docs/Enums/SocketIOClientStatus.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -279,8 +279,8 @@ <h4>Declaration</h4>
279279
</article>
280280
</div>
281281
<section class="footer">
282-
<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-07-24)</p>
283-
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.3</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
282+
<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-06)</p>
283+
<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>
284284
</section>
285285
</body>
286286
</div>

Diff for: ‎docs/Protocols.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -353,8 +353,8 @@ <h4>Declaration</h4>
353353
</article>
354354
</div>
355355
<section class="footer">
356-
<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-07-24)</p>
357-
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.3</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
356+
<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-06)</p>
357+
<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>
358358
</section>
359359
</body>
360360
</div>

Diff for: ‎docs/Protocols/SocketData.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -214,8 +214,8 @@ <h4>Declaration</h4>
214214
</article>
215215
</div>
216216
<section class="footer">
217-
<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-07-24)</p>
218-
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.3</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
217+
<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-06)</p>
218+
<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>
219219
</section>
220220
</body>
221221
</div>

0 commit comments

Comments
 (0)