Skip to content

Commit 8f50c5a

Browse files
nuclearacenuclearace
committed
update docs
1 parent 8364815 commit 8f50c5a

27 files changed

+578
-582
lines changed

‎docs/Classes.html

+16-16
Original file line numberDiff line numberDiff line change
@@ -129,10 +129,10 @@
129129
<a class="nav-group-name-link" href="Typealiases.html">Typealiases</a>
130130
<ul class="nav-group-tasks">
131131
<li class="nav-group-task">
132-
<a class="nav-group-task-link" href="Typealiases.html#/s:8SocketIO11AckCallback">AckCallback</a>
132+
<a class="nav-group-task-link" href="Typealiases.html#/s:8SocketIO11AckCallbacka">AckCallback</a>
133133
</li>
134134
<li class="nav-group-task">
135-
<a class="nav-group-task-link" href="Typealiases.html#/s:8SocketIO14NormalCallback">NormalCallback</a>
135+
<a class="nav-group-task-link" href="Typealiases.html#/s:8SocketIO14NormalCallbacka">NormalCallback</a>
136136
</li>
137137
</ul>
138138
</li>
@@ -155,9 +155,9 @@ <h1>Classes</h1>
155155
<li class="item">
156156
<div>
157157
<code>
158-
<a name="/s:C8SocketIO12SocketEngine"></a>
158+
<a name="/c:@M@SocketIO@objc(cs)SocketEngine"></a>
159159
<a name="//apple_ref/swift/Class/SocketEngine" class="dashAnchor"></a>
160-
<a class="token" href="#/s:C8SocketIO12SocketEngine">SocketEngine</a>
160+
<a class="token" href="#/c:@M@SocketIO@objc(cs)SocketEngine">SocketEngine</a>
161161
</code>
162162
</div>
163163
<div class="height-container">
@@ -188,9 +188,9 @@ <h4>Declaration</h4>
188188
<li class="item">
189189
<div>
190190
<code>
191-
<a name="/s:C8SocketIO16SocketAckEmitter"></a>
191+
<a name="/c:@M@SocketIO@objc(cs)SocketAckEmitter"></a>
192192
<a name="//apple_ref/swift/Class/SocketAckEmitter" class="dashAnchor"></a>
193-
<a class="token" href="#/s:C8SocketIO16SocketAckEmitter">SocketAckEmitter</a>
193+
<a class="token" href="#/c:@M@SocketIO@objc(cs)SocketAckEmitter">SocketAckEmitter</a>
194194
</code>
195195
</div>
196196
<div class="height-container">
@@ -218,9 +218,9 @@ <h4>Declaration</h4>
218218
<li class="item">
219219
<div>
220220
<code>
221-
<a name="/s:C8SocketIO13OnAckCallback"></a>
221+
<a name="/c:@M@SocketIO@objc(cs)OnAckCallback"></a>
222222
<a name="//apple_ref/swift/Class/OnAckCallback" class="dashAnchor"></a>
223-
<a class="token" href="#/s:C8SocketIO13OnAckCallback">OnAckCallback</a>
223+
<a class="token" href="#/c:@M@SocketIO@objc(cs)OnAckCallback">OnAckCallback</a>
224224
</code>
225225
</div>
226226
<div class="height-container">
@@ -256,9 +256,9 @@ <h4>Declaration</h4>
256256
<li class="item">
257257
<div>
258258
<code>
259-
<a name="/s:C8SocketIO14SocketAnyEvent"></a>
259+
<a name="/c:@M@SocketIO@objc(cs)SocketAnyEvent"></a>
260260
<a name="//apple_ref/swift/Class/SocketAnyEvent" class="dashAnchor"></a>
261-
<a class="token" href="#/s:C8SocketIO14SocketAnyEvent">SocketAnyEvent</a>
261+
<a class="token" href="#/c:@M@SocketIO@objc(cs)SocketAnyEvent">SocketAnyEvent</a>
262262
</code>
263263
</div>
264264
<div class="height-container">
@@ -288,9 +288,9 @@ <h4>Declaration</h4>
288288
<li class="item">
289289
<div>
290290
<code>
291-
<a name="/s:C8SocketIO14SocketIOClient"></a>
291+
<a name="/c:@M@SocketIO@objc(cs)SocketIOClient"></a>
292292
<a name="//apple_ref/swift/Class/SocketIOClient" class="dashAnchor"></a>
293-
<a class="token" href="#/s:C8SocketIO14SocketIOClient">SocketIOClient</a>
293+
<a class="token" href="#/c:@M@SocketIO@objc(cs)SocketIOClient">SocketIOClient</a>
294294
</code>
295295
</div>
296296
<div class="height-container">
@@ -324,9 +324,9 @@ <h4>Declaration</h4>
324324
<li class="item">
325325
<div>
326326
<code>
327-
<a name="/s:C8SocketIO19SocketClientManager"></a>
327+
<a name="/c:@M@SocketIO@objc(cs)SocketClientManager"></a>
328328
<a name="//apple_ref/swift/Class/SocketClientManager" class="dashAnchor"></a>
329-
<a class="token" href="#/s:C8SocketIO19SocketClientManager">SocketClientManager</a>
329+
<a class="token" href="#/c:@M@SocketIO@objc(cs)SocketClientManager">SocketClientManager</a>
330330
</code>
331331
</div>
332332
<div class="height-container">
@@ -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-09-17)</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>
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-09-20)</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>
377377
</section>
378378
</body>
379379
</div>

‎docs/Classes/OnAckCallback.html

+8-8
Original file line numberDiff line numberDiff line change
@@ -130,10 +130,10 @@
130130
<a class="nav-group-name-link" href="../Typealiases.html">Typealiases</a>
131131
<ul class="nav-group-tasks">
132132
<li class="nav-group-task">
133-
<a class="nav-group-task-link" href="../Typealiases.html#/s:8SocketIO11AckCallback">AckCallback</a>
133+
<a class="nav-group-task-link" href="../Typealiases.html#/s:8SocketIO11AckCallbacka">AckCallback</a>
134134
</li>
135135
<li class="nav-group-task">
136-
<a class="nav-group-task-link" href="../Typealiases.html#/s:8SocketIO14NormalCallback">NormalCallback</a>
136+
<a class="nav-group-task-link" href="../Typealiases.html#/s:8SocketIO14NormalCallbacka">NormalCallback</a>
137137
</li>
138138
</ul>
139139
</li>
@@ -175,9 +175,9 @@ <h3 class="section-name">Methods</h3>
175175
<li class="item">
176176
<div>
177177
<code>
178-
<a name="/s:FC8SocketIO13OnAckCallback9timingOutFT5afterSd8callbackFGSaP__T__T_"></a>
178+
<a name="/c:@M@SocketIO@objc(cs)OnAckCallback(im)timingOutAfter:callback:"></a>
179179
<a name="//apple_ref/swift/Method/timingOut(after:callback:)" class="dashAnchor"></a>
180-
<a class="token" href="#/s:FC8SocketIO13OnAckCallback9timingOutFT5afterSd8callbackFGSaP__T__T_">timingOut(after:callback:)</a>
180+
<a class="token" href="#/c:@M@SocketIO@objc(cs)OnAckCallback(im)timingOutAfter:callback:">timingOut(after:callback:)</a>
181181
</code>
182182
</div>
183183
<div class="height-container">
@@ -192,7 +192,7 @@ <h3 class="section-name">Methods</h3>
192192
<h4>Declaration</h4>
193193
<div class="language">
194194
<p class="aside-title">Swift</p>
195-
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">timingOut</span><span class="p">(</span><span class="n">after</span> <span class="nv">seconds</span><span class="p">:</span> <span class="kt">Double</span><span class="p">,</span> <span class="nv">callback</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="kt"><a href="../Typealiases.html#/s:8SocketIO11AckCallback">AckCallback</a></span><span class="p">)</span></code></pre>
195+
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">timingOut</span><span class="p">(</span><span class="n">after</span> <span class="nv">seconds</span><span class="p">:</span> <span class="kt">Double</span><span class="p">,</span> <span class="nv">callback</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="kt"><a href="../Typealiases.html#/s:8SocketIO11AckCallbacka">AckCallback</a></span><span class="p">)</span></code></pre>
196196

197197
</div>
198198
</div>
@@ -221,7 +221,7 @@ <h4>Parameters</h4>
221221
<td>
222222
<div>
223223
<p>The callback called when an ack is received, or when a timeout happens.
224-
To check for timeout, use <code>SocketAckStatus</code>&lsquo;s <code>noAck</code> case.</p>
224+
To check for timeout, use <code>SocketAckStatus</code>&rsquo;s <code>noAck</code> case.</p>
225225
</div>
226226
</td>
227227
</tr>
@@ -239,8 +239,8 @@ <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-09-17)</p>
243-
<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>
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-09-20)</p>
243+
<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>
244244
</section>
245245
</body>
246246
</div>

‎docs/Classes/SocketAckEmitter.html

+11-11
Original file line numberDiff line numberDiff line change
@@ -130,10 +130,10 @@
130130
<a class="nav-group-name-link" href="../Typealiases.html">Typealiases</a>
131131
<ul class="nav-group-tasks">
132132
<li class="nav-group-task">
133-
<a class="nav-group-task-link" href="../Typealiases.html#/s:8SocketIO11AckCallback">AckCallback</a>
133+
<a class="nav-group-task-link" href="../Typealiases.html#/s:8SocketIO11AckCallbacka">AckCallback</a>
134134
</li>
135135
<li class="nav-group-task">
136-
<a class="nav-group-task-link" href="../Typealiases.html#/s:8SocketIO14NormalCallback">NormalCallback</a>
136+
<a class="nav-group-task-link" href="../Typealiases.html#/s:8SocketIO14NormalCallbacka">NormalCallback</a>
137137
</li>
138138
</ul>
139139
</li>
@@ -171,9 +171,9 @@ <h3 class="section-name">Properties</h3>
171171
<li class="item">
172172
<div>
173173
<code>
174-
<a name="/s:vC8SocketIO16SocketAckEmitter8expectedSb"></a>
174+
<a name="/c:@M@SocketIO@objc(cs)SocketAckEmitter(py)expected"></a>
175175
<a name="//apple_ref/swift/Property/expected" class="dashAnchor"></a>
176-
<a class="token" href="#/s:vC8SocketIO16SocketAckEmitter8expectedSb">expected</a>
176+
<a class="token" href="#/c:@M@SocketIO@objc(cs)SocketAckEmitter(py)expected">expected</a>
177177
</code>
178178
</div>
179179
<div class="height-container">
@@ -209,9 +209,9 @@ <h3 class="section-name">Methods</h3>
209209
<li class="item">
210210
<div>
211211
<code>
212-
<a name="/s:FC8SocketIO16SocketAckEmitter4withFtGSaPS_10SocketData___T_"></a>
212+
<a name="/s:8SocketIO0A10AckEmitterC4withySayAA0A4Data_pGd_tF"></a>
213213
<a name="//apple_ref/swift/Method/with(_:)" class="dashAnchor"></a>
214-
<a class="token" href="#/s:FC8SocketIO16SocketAckEmitter4withFtGSaPS_10SocketData___T_">with(_:)</a>
214+
<a class="token" href="#/s:8SocketIO0A10AckEmitterC4withySayAA0A4Data_pGd_tF">with(_:)</a>
215215
</code>
216216
</div>
217217
<div class="height-container">
@@ -221,7 +221,7 @@ <h3 class="section-name">Methods</h3>
221221
<div class="abstract">
222222
<p>Call to ack receiving this event.</p>
223223

224-
<p>If an error occurs trying to transform <code>items</code> into their socket representation, a <code><a href="../Enums/SocketClientEvent.html#/s:FO8SocketIO17SocketClientEvent5errorFMS0_S0_">SocketClientEvent.error</a></code>
224+
<p>If an error occurs trying to transform <code>items</code> into their socket representation, a <code><a href="../Enums/SocketClientEvent.html#/s:8SocketIO0A11ClientEventO5errorA2CmF">SocketClientEvent.error</a></code>
225225
will be emitted. The structure of the error data is <code>[ackNum, items, theError]</code></p>
226226

227227
</div>
@@ -258,9 +258,9 @@ <h4>Parameters</h4>
258258
<li class="item">
259259
<div>
260260
<code>
261-
<a name="/s:FC8SocketIO16SocketAckEmitter4withFGSaP__T_"></a>
261+
<a name="/c:@M@SocketIO@objc(cs)SocketAckEmitter(im)with:"></a>
262262
<a name="//apple_ref/swift/Method/with(_:)" class="dashAnchor"></a>
263-
<a class="token" href="#/s:FC8SocketIO16SocketAckEmitter4withFGSaP__T_">with(_:)</a>
263+
<a class="token" href="#/c:@M@SocketIO@objc(cs)SocketAckEmitter(im)with:">with(_:)</a>
264264
</code>
265265
</div>
266266
<div class="height-container">
@@ -309,8 +309,8 @@ <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-09-17)</p>
313-
<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>
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-09-20)</p>
313+
<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>
314314
</section>
315315
</body>
316316
</div>

‎docs/Classes/SocketAnyEvent.html

+10-10
Original file line numberDiff line numberDiff line change
@@ -130,10 +130,10 @@
130130
<a class="nav-group-name-link" href="../Typealiases.html">Typealiases</a>
131131
<ul class="nav-group-tasks">
132132
<li class="nav-group-task">
133-
<a class="nav-group-task-link" href="../Typealiases.html#/s:8SocketIO11AckCallback">AckCallback</a>
133+
<a class="nav-group-task-link" href="../Typealiases.html#/s:8SocketIO11AckCallbacka">AckCallback</a>
134134
</li>
135135
<li class="nav-group-task">
136-
<a class="nav-group-task-link" href="../Typealiases.html#/s:8SocketIO14NormalCallback">NormalCallback</a>
136+
<a class="nav-group-task-link" href="../Typealiases.html#/s:8SocketIO14NormalCallbacka">NormalCallback</a>
137137
</li>
138138
</ul>
139139
</li>
@@ -169,9 +169,9 @@ <h3 class="section-name">Properties</h3>
169169
<li class="item">
170170
<div>
171171
<code>
172-
<a name="/s:vC8SocketIO14SocketAnyEvent5eventSS"></a>
172+
<a name="/c:@M@SocketIO@objc(cs)SocketAnyEvent(py)event"></a>
173173
<a name="//apple_ref/swift/Property/event" class="dashAnchor"></a>
174-
<a class="token" href="#/s:vC8SocketIO14SocketAnyEvent5eventSS">event</a>
174+
<a class="token" href="#/c:@M@SocketIO@objc(cs)SocketAnyEvent(py)event">event</a>
175175
</code>
176176
</div>
177177
<div class="height-container">
@@ -196,9 +196,9 @@ <h4>Declaration</h4>
196196
<li class="item">
197197
<div>
198198
<code>
199-
<a name="/s:vC8SocketIO14SocketAnyEvent5itemsGSqGSaP___"></a>
199+
<a name="/c:@M@SocketIO@objc(cs)SocketAnyEvent(py)items"></a>
200200
<a name="//apple_ref/swift/Property/items" class="dashAnchor"></a>
201-
<a class="token" href="#/s:vC8SocketIO14SocketAnyEvent5itemsGSqGSaP___">items</a>
201+
<a class="token" href="#/c:@M@SocketIO@objc(cs)SocketAnyEvent(py)items">items</a>
202202
</code>
203203
</div>
204204
<div class="height-container">
@@ -223,9 +223,9 @@ <h4>Declaration</h4>
223223
<li class="item">
224224
<div>
225225
<code>
226-
<a name="/s:vC8SocketIO14SocketAnyEvent11descriptionSS"></a>
226+
<a name="/c:@M@SocketIO@objc(cs)SocketAnyEvent(py)description"></a>
227227
<a name="//apple_ref/swift/Property/description" class="dashAnchor"></a>
228-
<a class="token" href="#/s:vC8SocketIO14SocketAnyEvent11descriptionSS">description</a>
228+
<a class="token" href="#/c:@M@SocketIO@objc(cs)SocketAnyEvent(py)description">description</a>
229229
</code>
230230
</div>
231231
<div class="height-container">
@@ -255,8 +255,8 @@ <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-09-17)</p>
259-
<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>
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-09-20)</p>
259+
<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>
260260
</section>
261261
</body>
262262
</div>

0 commit comments

Comments
 (0)