Skip to content

Commit 84218d5

Browse files
nuclearacenuclearace
committed
update docs
1 parent 665cfef commit 84218d5

34 files changed

+5346
-261
lines changed

‎docs/Classes.html

+59-6
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,9 @@
5757
<li class="nav-group-task">
5858
<a class="nav-group-task-link" href="Classes/OnAckCallback.html">OnAckCallback</a>
5959
</li>
60+
<li class="nav-group-task">
61+
<a class="nav-group-task-link" href="Classes/SSLSecurity.html">SSLSecurity</a>
62+
</li>
6063
<li class="nav-group-task">
6164
<a class="nav-group-task-link" href="Classes/SocketAckEmitter.html">SocketAckEmitter</a>
6265
</li>
@@ -75,7 +78,7 @@
7578
</ul>
7679
</li>
7780
<li class="nav-group-name">
78-
<a class="nav-group-name-link" href="Enums.html">Enums</a>
81+
<a class="nav-group-name-link" href="Enums.html">Enumerations</a>
7982
<ul class="nav-group-tasks">
8083
<li class="nav-group-task">
8184
<a class="nav-group-task-link" href="Enums/SocketAckStatus.html">SocketAckStatus</a>
@@ -92,6 +95,9 @@
9295
<li class="nav-group-task">
9396
<a class="nav-group-task-link" href="Enums/SocketIOClientStatus.html">SocketIOClientStatus</a>
9497
</li>
98+
<li class="nav-group-task">
99+
<a class="nav-group-task-link" href="Enums/SocketParsableError.html">SocketParsableError</a>
100+
</li>
95101
</ul>
96102
</li>
97103
<li class="nav-group-name">
@@ -112,21 +118,36 @@
112118
<li class="nav-group-task">
113119
<a class="nav-group-task-link" href="Protocols/SocketEngineWebsocket.html">SocketEngineWebsocket</a>
114120
</li>
121+
<li class="nav-group-task">
122+
<a class="nav-group-task-link" href="Protocols/SocketIOClientSpec.html">SocketIOClientSpec</a>
123+
</li>
115124
<li class="nav-group-task">
116125
<a class="nav-group-task-link" href="Protocols/SocketLogger.html">SocketLogger</a>
117126
</li>
127+
<li class="nav-group-task">
128+
<a class="nav-group-task-link" href="Protocols/SocketParsable.html">SocketParsable</a>
129+
</li>
118130
</ul>
119131
</li>
120132
<li class="nav-group-name">
121-
<a class="nav-group-name-link" href="Structs.html">Structs</a>
133+
<a class="nav-group-name-link" href="Structs.html">Structures</a>
122134
<ul class="nav-group-tasks">
135+
<li class="nav-group-task">
136+
<a class="nav-group-task-link" href="Structs/SocketEventHandler.html">SocketEventHandler</a>
137+
</li>
123138
<li class="nav-group-task">
124139
<a class="nav-group-task-link" href="Structs/SocketIOClientConfiguration.html">SocketIOClientConfiguration</a>
125140
</li>
141+
<li class="nav-group-task">
142+
<a class="nav-group-task-link" href="Structs/SocketPacket.html">SocketPacket</a>
143+
</li>
144+
<li class="nav-group-task">
145+
<a class="nav-group-task-link" href="Structs/SocketPacket/PacketType.html">– PacketType</a>
146+
</li>
126147
</ul>
127148
</li>
128149
<li class="nav-group-name">
129-
<a class="nav-group-name-link" href="Typealiases.html">Typealiases</a>
150+
<a class="nav-group-name-link" href="Typealiases.html">Type Aliases</a>
130151
<ul class="nav-group-tasks">
131152
<li class="nav-group-task">
132153
<a class="nav-group-task-link" href="Typealiases.html#/s:8SocketIO11AckCallbacka">AckCallback</a>
@@ -310,7 +331,39 @@ <h4>Declaration</h4>
310331
<h4>Declaration</h4>
311332
<div class="language">
312333
<p class="aside-title">Swift</p>
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>
334+
<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"><a href="Protocols/SocketIOClientSpec.html">SocketIOClientSpec</a></span><span class="p">,</span> <span class="kt"><a href="Protocols/SocketEngineClient.html">SocketEngineClient</a></span><span class="p">,</span> <span class="kt"><a href="Protocols/SocketParsable.html">SocketParsable</a></span></code></pre>
335+
336+
</div>
337+
</div>
338+
</section>
339+
</div>
340+
</li>
341+
</ul>
342+
</div>
343+
<div class="task-group">
344+
<ul class="item-container">
345+
<li class="item">
346+
<div>
347+
<code>
348+
<a name="/c:@M@SocketIO@objc(cs)SSLSecurity"></a>
349+
<a name="//apple_ref/swift/Class/SSLSecurity" class="dashAnchor"></a>
350+
<a class="token" href="#/c:@M@SocketIO@objc(cs)SSLSecurity">SSLSecurity</a>
351+
</code>
352+
</div>
353+
<div class="height-container">
354+
<div class="pointer-container"></div>
355+
<section class="section">
356+
<div class="pointer"></div>
357+
<div class="abstract">
358+
<p>A wrapper around Starscream&rsquo;s SSLSecurity that provides a minimal Objective-C interface.</p>
359+
360+
<a href="Classes/SSLSecurity.html" class="slightly-smaller">See more</a>
361+
</div>
362+
<div class="declaration">
363+
<h4>Declaration</h4>
364+
<div class="language">
365+
<p class="aside-title">Swift</p>
366+
<pre class="highlight"><code><span class="n">open</span> <span class="kd">class</span> <span class="kt">SSLSecurity</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre>
314367

315368
</div>
316369
</div>
@@ -372,8 +425,8 @@ <h4>Declaration</h4>
372425
</article>
373426
</div>
374427
<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-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>
428+
<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-10-01)</p>
429+
<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>
377430
</section>
378431
</body>
379432
</div>

‎docs/Classes/OnAckCallback.html

+27-6
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,9 @@
5858
<li class="nav-group-task">
5959
<a class="nav-group-task-link" href="../Classes/OnAckCallback.html">OnAckCallback</a>
6060
</li>
61+
<li class="nav-group-task">
62+
<a class="nav-group-task-link" href="../Classes/SSLSecurity.html">SSLSecurity</a>
63+
</li>
6164
<li class="nav-group-task">
6265
<a class="nav-group-task-link" href="../Classes/SocketAckEmitter.html">SocketAckEmitter</a>
6366
</li>
@@ -76,7 +79,7 @@
7679
</ul>
7780
</li>
7881
<li class="nav-group-name">
79-
<a class="nav-group-name-link" href="../Enums.html">Enums</a>
82+
<a class="nav-group-name-link" href="../Enums.html">Enumerations</a>
8083
<ul class="nav-group-tasks">
8184
<li class="nav-group-task">
8285
<a class="nav-group-task-link" href="../Enums/SocketAckStatus.html">SocketAckStatus</a>
@@ -93,6 +96,9 @@
9396
<li class="nav-group-task">
9497
<a class="nav-group-task-link" href="../Enums/SocketIOClientStatus.html">SocketIOClientStatus</a>
9598
</li>
99+
<li class="nav-group-task">
100+
<a class="nav-group-task-link" href="../Enums/SocketParsableError.html">SocketParsableError</a>
101+
</li>
96102
</ul>
97103
</li>
98104
<li class="nav-group-name">
@@ -113,21 +119,36 @@
113119
<li class="nav-group-task">
114120
<a class="nav-group-task-link" href="../Protocols/SocketEngineWebsocket.html">SocketEngineWebsocket</a>
115121
</li>
122+
<li class="nav-group-task">
123+
<a class="nav-group-task-link" href="../Protocols/SocketIOClientSpec.html">SocketIOClientSpec</a>
124+
</li>
116125
<li class="nav-group-task">
117126
<a class="nav-group-task-link" href="../Protocols/SocketLogger.html">SocketLogger</a>
118127
</li>
128+
<li class="nav-group-task">
129+
<a class="nav-group-task-link" href="../Protocols/SocketParsable.html">SocketParsable</a>
130+
</li>
119131
</ul>
120132
</li>
121133
<li class="nav-group-name">
122-
<a class="nav-group-name-link" href="../Structs.html">Structs</a>
134+
<a class="nav-group-name-link" href="../Structs.html">Structures</a>
123135
<ul class="nav-group-tasks">
136+
<li class="nav-group-task">
137+
<a class="nav-group-task-link" href="../Structs/SocketEventHandler.html">SocketEventHandler</a>
138+
</li>
124139
<li class="nav-group-task">
125140
<a class="nav-group-task-link" href="../Structs/SocketIOClientConfiguration.html">SocketIOClientConfiguration</a>
126141
</li>
142+
<li class="nav-group-task">
143+
<a class="nav-group-task-link" href="../Structs/SocketPacket.html">SocketPacket</a>
144+
</li>
145+
<li class="nav-group-task">
146+
<a class="nav-group-task-link" href="../Structs/SocketPacket/PacketType.html">– PacketType</a>
147+
</li>
127148
</ul>
128149
</li>
129150
<li class="nav-group-name">
130-
<a class="nav-group-name-link" href="../Typealiases.html">Typealiases</a>
151+
<a class="nav-group-name-link" href="../Typealiases.html">Type Aliases</a>
131152
<ul class="nav-group-tasks">
132153
<li class="nav-group-task">
133154
<a class="nav-group-task-link" href="../Typealiases.html#/s:8SocketIO11AckCallbacka">AckCallback</a>
@@ -221,7 +242,7 @@ <h4>Parameters</h4>
221242
<td>
222243
<div>
223244
<p>The callback called when an ack is received, or when a timeout happens.
224-
To check for timeout, use <code>SocketAckStatus</code>&rsquo;s <code>noAck</code> case.</p>
245+
To check for timeout, use <code><a href="../Enums/SocketAckStatus.html">SocketAckStatus</a></code>&lsquo;s <code>noAck</code> case.</p>
225246
</div>
226247
</td>
227248
</tr>
@@ -239,8 +260,8 @@ <h4>Parameters</h4>
239260
</article>
240261
</div>
241262
<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-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>
263+
<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-10-01)</p>
264+
<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>
244265
</section>
245266
</body>
246267
</div>

0 commit comments

Comments
 (0)