Skip to content

Commit 817f36e

Browse files
nuclearacenuclearace
committed
update docs
1 parent 3ba3354 commit 817f36e

39 files changed

+140
-5839
lines changed

‎README.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ import PackageDescription
7878
let package = Package(
7979
name: "YourSocketIOProject",
8080
dependencies: [
81-
.Package(url: "https://github.com/socketio/socket.io-client-swift", majorVersion: 10)
81+
.Package(url: "https://github.com/socketio/socket.io-client-swift", majorVersion: 11)
8282
]
8383
)
8484
```
@@ -88,7 +88,7 @@ Then import `import SocketIO`.
8888
### Carthage
8989
Add this line to your `Cartfile`:
9090
```
91-
github "socketio/socket.io-client-swift" ~> 10.2.0 # Or latest version
91+
github "socketio/socket.io-client-swift" ~> 11.0.0 # Or latest version
9292
```
9393

9494
Run `carthage update --platform ios,macosx`.
@@ -100,7 +100,7 @@ Create `Podfile` and add `pod 'Socket.IO-Client-Swift'`:
100100
use_frameworks!
101101

102102
target 'YourApp' do
103-
pod 'Socket.IO-Client-Swift', '~> 10.2.0' # Or latest version
103+
pod 'Socket.IO-Client-Swift', '~> 11.0.0' # Or latest version
104104
end
105105
```
106106

@@ -128,7 +128,7 @@ Objective-C:
128128
Add this line to your `Seedfile`:
129129

130130
```
131-
github "socketio/socket.io-client-swift", "v10.2.0", :files => "Source/*.swift" # Or latest version
131+
github "socketio/socket.io-client-swift", "v11.0.0", :files => "Source/*.swift" # Or latest version
132132
```
133133

134134
Run `seed install`.

‎docs/Classes.html‎

Lines changed: 3 additions & 118 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
<a class="header-link" href="index.html">
2323
SocketIO Docs
2424
</a>
25-
(77% documented)
25+
(100% documented)
2626
</p>
2727

2828
<p class="header-col--secondary">
@@ -49,12 +49,6 @@
4949
<li class="nav-group-task">
5050
<a class="nav-group-task-link" href="Classes/OnAckCallback.html">OnAckCallback</a>
5151
</li>
52-
<li class="nav-group-task">
53-
<a class="nav-group-task-link" href="Classes/SSLCert.html">SSLCert</a>
54-
</li>
55-
<li class="nav-group-task">
56-
<a class="nav-group-task-link" href="Classes/SSLSecurity.html">SSLSecurity</a>
57-
</li>
5852
<li class="nav-group-task">
5953
<a class="nav-group-task-link" href="Classes/SocketAckEmitter.html">SocketAckEmitter</a>
6054
</li>
@@ -70,35 +64,6 @@
7064
<li class="nav-group-task">
7165
<a class="nav-group-task-link" href="Classes/SocketIOClient.html">SocketIOClient</a>
7266
</li>
73-
<li class="nav-group-task">
74-
<a class="nav-group-task-link" href="Classes/WebSocket.html">WebSocket</a>
75-
</li>
76-
<li class="nav-group-task">
77-
<a class="nav-group-task-link" href="Classes/WebSocket/OpCode.html">– OpCode</a>
78-
</li>
79-
<li class="nav-group-task">
80-
<a class="nav-group-task-link" href="Classes/WebSocket/CloseCode.html">– CloseCode</a>
81-
</li>
82-
<li class="nav-group-task">
83-
<a class="nav-group-task-link" href="Classes/WebSocket/WSResponse.html">– WSResponse</a>
84-
</li>
85-
<li class="nav-group-task">
86-
<a class="nav-group-task-link" href="Classes/WebSocket/HTTPMethod.html">– HTTPMethod</a>
87-
</li>
88-
</ul>
89-
</li>
90-
<li class="nav-group-name">
91-
<a class="nav-group-name-link" href="Global Variables.html">Global Variables</a>
92-
<ul class="nav-group-tasks">
93-
<li class="nav-group-task">
94-
<a class="nav-group-task-link" href="Global Variables.html#/s:v8SocketIO31WebsocketDidConnectNotificationSS">WebsocketDidConnectNotification</a>
95-
</li>
96-
<li class="nav-group-task">
97-
<a class="nav-group-task-link" href="Global Variables.html#/s:v8SocketIO34WebsocketDidDisconnectNotificationSS">WebsocketDidDisconnectNotification</a>
98-
</li>
99-
<li class="nav-group-task">
100-
<a class="nav-group-task-link" href="Global Variables.html#/s:v8SocketIO34WebsocketDisconnectionErrorKeyNameSS">WebsocketDisconnectionErrorKeyName</a>
101-
</li>
10267
</ul>
10368
</li>
10469
<li class="nav-group-name">
@@ -124,9 +89,6 @@
12489
<li class="nav-group-name">
12590
<a class="nav-group-name-link" href="Protocols.html">Protocols</a>
12691
<ul class="nav-group-tasks">
127-
<li class="nav-group-task">
128-
<a class="nav-group-task-link" href="Protocols/SSLTrustValidator.html">SSLTrustValidator</a>
129-
</li>
13092
<li class="nav-group-task">
13193
<a class="nav-group-task-link" href="Protocols/SocketData.html">SocketData</a>
13294
</li>
@@ -145,15 +107,6 @@
145107
<li class="nav-group-task">
146108
<a class="nav-group-task-link" href="Protocols/SocketLogger.html">SocketLogger</a>
147109
</li>
148-
<li class="nav-group-task">
149-
<a class="nav-group-task-link" href="Protocols/WebSocketAdvancedDelegate.html">WebSocketAdvancedDelegate</a>
150-
</li>
151-
<li class="nav-group-task">
152-
<a class="nav-group-task-link" href="Protocols/WebSocketDelegate.html">WebSocketDelegate</a>
153-
</li>
154-
<li class="nav-group-task">
155-
<a class="nav-group-task-link" href="Protocols/WebSocketPongDelegate.html">WebSocketPongDelegate</a>
156-
</li>
157110
</ul>
158111
</li>
159112
<li class="nav-group-name">
@@ -326,74 +279,6 @@ <h4>Declaration</h4>
326279
</li>
327280
</ul>
328281
</div>
329-
<div class="task-group">
330-
<ul class="item-container">
331-
<li class="item">
332-
<div>
333-
<code>
334-
<a name="/s:C8SocketIO9WebSocket"></a>
335-
<a name="//apple_ref/swift/Class/WebSocket" class="dashAnchor"></a>
336-
<a class="token" href="#/s:C8SocketIO9WebSocket">WebSocket</a>
337-
</code>
338-
</div>
339-
<div class="height-container">
340-
<div class="pointer-container"></div>
341-
<section class="section">
342-
<div class="pointer"></div>
343-
<div class="abstract">
344-
<p>Undocumented</p>
345-
346-
<a href="Classes/WebSocket.html" class="slightly-smaller">See more</a>
347-
</div>
348-
</section>
349-
</div>
350-
</li>
351-
</ul>
352-
</div>
353-
<div class="task-group">
354-
<ul class="item-container">
355-
<li class="item">
356-
<div>
357-
<code>
358-
<a name="/s:C8SocketIO7SSLCert"></a>
359-
<a name="//apple_ref/swift/Class/SSLCert" class="dashAnchor"></a>
360-
<a class="token" href="#/s:C8SocketIO7SSLCert">SSLCert</a>
361-
</code>
362-
</div>
363-
<div class="height-container">
364-
<div class="pointer-container"></div>
365-
<section class="section">
366-
<div class="pointer"></div>
367-
<div class="abstract">
368-
<p>Undocumented</p>
369-
370-
<a href="Classes/SSLCert.html" class="slightly-smaller">See more</a>
371-
</div>
372-
</section>
373-
</div>
374-
</li>
375-
<li class="item">
376-
<div>
377-
<code>
378-
<a name="/s:C8SocketIO11SSLSecurity"></a>
379-
<a name="//apple_ref/swift/Class/SSLSecurity" class="dashAnchor"></a>
380-
<a class="token" href="#/s:C8SocketIO11SSLSecurity">SSLSecurity</a>
381-
</code>
382-
</div>
383-
<div class="height-container">
384-
<div class="pointer-container"></div>
385-
<section class="section">
386-
<div class="pointer"></div>
387-
<div class="abstract">
388-
<p>Undocumented</p>
389-
390-
<a href="Classes/SSLSecurity.html" class="slightly-smaller">See more</a>
391-
</div>
392-
</section>
393-
</div>
394-
</li>
395-
</ul>
396-
</div>
397282
<div class="task-group">
398283
<ul class="item-container">
399284
<li class="item">
@@ -479,8 +364,8 @@ <h4>Declaration</h4>
479364
</article>
480365
</div>
481366
<section class="footer">
482-
<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-04)</p>
483-
<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>
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>
484369
</section>
485370
</body>
486371
</div>

‎docs/Classes/OnAckCallback.html‎

Lines changed: 4 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
<a class="header-link" href="../index.html">
2424
SocketIO Docs
2525
</a>
26-
(77% documented)
26+
(100% documented)
2727
</p>
2828

2929
<p class="header-col--secondary">
@@ -50,12 +50,6 @@
5050
<li class="nav-group-task">
5151
<a class="nav-group-task-link" href="../Classes/OnAckCallback.html">OnAckCallback</a>
5252
</li>
53-
<li class="nav-group-task">
54-
<a class="nav-group-task-link" href="../Classes/SSLCert.html">SSLCert</a>
55-
</li>
56-
<li class="nav-group-task">
57-
<a class="nav-group-task-link" href="../Classes/SSLSecurity.html">SSLSecurity</a>
58-
</li>
5953
<li class="nav-group-task">
6054
<a class="nav-group-task-link" href="../Classes/SocketAckEmitter.html">SocketAckEmitter</a>
6155
</li>
@@ -71,35 +65,6 @@
7165
<li class="nav-group-task">
7266
<a class="nav-group-task-link" href="../Classes/SocketIOClient.html">SocketIOClient</a>
7367
</li>
74-
<li class="nav-group-task">
75-
<a class="nav-group-task-link" href="../Classes/WebSocket.html">WebSocket</a>
76-
</li>
77-
<li class="nav-group-task">
78-
<a class="nav-group-task-link" href="../Classes/WebSocket/OpCode.html">– OpCode</a>
79-
</li>
80-
<li class="nav-group-task">
81-
<a class="nav-group-task-link" href="../Classes/WebSocket/CloseCode.html">– CloseCode</a>
82-
</li>
83-
<li class="nav-group-task">
84-
<a class="nav-group-task-link" href="../Classes/WebSocket/WSResponse.html">– WSResponse</a>
85-
</li>
86-
<li class="nav-group-task">
87-
<a class="nav-group-task-link" href="../Classes/WebSocket/HTTPMethod.html">– HTTPMethod</a>
88-
</li>
89-
</ul>
90-
</li>
91-
<li class="nav-group-name">
92-
<a class="nav-group-name-link" href="../Global Variables.html">Global Variables</a>
93-
<ul class="nav-group-tasks">
94-
<li class="nav-group-task">
95-
<a class="nav-group-task-link" href="../Global Variables.html#/s:v8SocketIO31WebsocketDidConnectNotificationSS">WebsocketDidConnectNotification</a>
96-
</li>
97-
<li class="nav-group-task">
98-
<a class="nav-group-task-link" href="../Global Variables.html#/s:v8SocketIO34WebsocketDidDisconnectNotificationSS">WebsocketDidDisconnectNotification</a>
99-
</li>
100-
<li class="nav-group-task">
101-
<a class="nav-group-task-link" href="../Global Variables.html#/s:v8SocketIO34WebsocketDisconnectionErrorKeyNameSS">WebsocketDisconnectionErrorKeyName</a>
102-
</li>
10368
</ul>
10469
</li>
10570
<li class="nav-group-name">
@@ -125,9 +90,6 @@
12590
<li class="nav-group-name">
12691
<a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
12792
<ul class="nav-group-tasks">
128-
<li class="nav-group-task">
129-
<a class="nav-group-task-link" href="../Protocols/SSLTrustValidator.html">SSLTrustValidator</a>
130-
</li>
13193
<li class="nav-group-task">
13294
<a class="nav-group-task-link" href="../Protocols/SocketData.html">SocketData</a>
13395
</li>
@@ -146,15 +108,6 @@
146108
<li class="nav-group-task">
147109
<a class="nav-group-task-link" href="../Protocols/SocketLogger.html">SocketLogger</a>
148110
</li>
149-
<li class="nav-group-task">
150-
<a class="nav-group-task-link" href="../Protocols/WebSocketAdvancedDelegate.html">WebSocketAdvancedDelegate</a>
151-
</li>
152-
<li class="nav-group-task">
153-
<a class="nav-group-task-link" href="../Protocols/WebSocketDelegate.html">WebSocketDelegate</a>
154-
</li>
155-
<li class="nav-group-task">
156-
<a class="nav-group-task-link" href="../Protocols/WebSocketPongDelegate.html">WebSocketPongDelegate</a>
157-
</li>
158111
</ul>
159112
</li>
160113
<li class="nav-group-name">
@@ -260,7 +213,7 @@ <h4>Parameters</h4>
260213
<td>
261214
<div>
262215
<p>The callback called when an ack is received, or when a timeout happens.
263-
To check for timeout, use <code>SocketAckStatus</code>&lsquo;s <code>noAck</code> case.</p>
216+
To check for timeout, use <code>SocketAckStatus</code>&rsquo;s <code>noAck</code> case.</p>
264217
</div>
265218
</td>
266219
</tr>
@@ -278,8 +231,8 @@ <h4>Parameters</h4>
278231
</article>
279232
</div>
280233
<section class="footer">
281-
<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-04)</p>
282-
<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>
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>
283236
</section>
284237
</body>
285238
</div>

0 commit comments

Comments
 (0)