From 102251b0bb654a0a1f919fa716be694c1b55d97f Mon Sep 17 00:00:00 2001 From: Erik Little Date: Wed, 4 Oct 2017 17:34:57 -0400 Subject: [PATCH] update docs --- docs/Classes.html | 2 +- docs/Classes/OnAckCallback.html | 2 +- docs/Classes/SSLSecurity.html | 2 +- docs/Classes/SocketAckEmitter.html | 2 +- docs/Classes/SocketAnyEvent.html | 2 +- docs/Classes/SocketClientManager.html | 2 +- docs/Classes/SocketEngine.html | 2 +- docs/Classes/SocketIOClient.html | 4 ++-- docs/Enums.html | 2 +- docs/Enums/SocketAckStatus.html | 2 +- docs/Enums/SocketClientEvent.html | 2 +- docs/Enums/SocketEnginePacketType.html | 2 +- docs/Enums/SocketIOClientOption.html | 2 +- docs/Enums/SocketIOClientStatus.html | 2 +- docs/Enums/SocketParsableError.html | 2 +- docs/Guides.html | 2 +- docs/Protocols.html | 2 +- docs/Protocols/SocketData.html | 2 +- docs/Protocols/SocketEngineClient.html | 2 +- docs/Protocols/SocketEnginePollable.html | 2 +- docs/Protocols/SocketEngineSpec.html | 2 +- docs/Protocols/SocketEngineWebsocket.html | 2 +- docs/Protocols/SocketIOClientSpec.html | 2 +- docs/Protocols/SocketLogger.html | 2 +- docs/Protocols/SocketParsable.html | 2 +- docs/Structs.html | 2 +- docs/Structs/SocketEventHandler.html | 2 +- docs/Structs/SocketIOClientConfiguration.html | 2 +- docs/Structs/SocketPacket.html | 2 +- docs/Structs/SocketPacket/PacketType.html | 2 +- docs/Typealiases.html | 2 +- docs/faq.html | 2 +- docs/index.html | 16 +++++++++++----- 33 files changed, 44 insertions(+), 38 deletions(-) diff --git a/docs/Classes.html b/docs/Classes.html index 936581b9..94c7da04 100644 --- a/docs/Classes.html +++ b/docs/Classes.html @@ -425,7 +425,7 @@

Declaration

-

© 2017 Erik. All rights reserved. (Last updated: 2017-10-01)

+

© 2017 Erik. All rights reserved. (Last updated: 2017-10-04)

Generated by jazzy ♪♫ v0.8.4, a Realm project.

diff --git a/docs/Classes/OnAckCallback.html b/docs/Classes/OnAckCallback.html index 98fc5fb4..a19ad22d 100644 --- a/docs/Classes/OnAckCallback.html +++ b/docs/Classes/OnAckCallback.html @@ -260,7 +260,7 @@

Parameters

-

© 2017 Erik. All rights reserved. (Last updated: 2017-10-01)

+

© 2017 Erik. All rights reserved. (Last updated: 2017-10-04)

Generated by jazzy ♪♫ v0.8.4, a Realm project.

diff --git a/docs/Classes/SSLSecurity.html b/docs/Classes/SSLSecurity.html index c5ee058b..6b100659 100644 --- a/docs/Classes/SSLSecurity.html +++ b/docs/Classes/SSLSecurity.html @@ -388,7 +388,7 @@

Return Value

-

© 2017 Erik. All rights reserved. (Last updated: 2017-10-01)

+

© 2017 Erik. All rights reserved. (Last updated: 2017-10-04)

Generated by jazzy ♪♫ v0.8.4, a Realm project.

diff --git a/docs/Classes/SocketAckEmitter.html b/docs/Classes/SocketAckEmitter.html index 982b1943..b1ff8ba2 100644 --- a/docs/Classes/SocketAckEmitter.html +++ b/docs/Classes/SocketAckEmitter.html @@ -399,7 +399,7 @@

Parameters

-

© 2017 Erik. All rights reserved. (Last updated: 2017-10-01)

+

© 2017 Erik. All rights reserved. (Last updated: 2017-10-04)

Generated by jazzy ♪♫ v0.8.4, a Realm project.

diff --git a/docs/Classes/SocketAnyEvent.html b/docs/Classes/SocketAnyEvent.html index b3e26a1f..e1827578 100644 --- a/docs/Classes/SocketAnyEvent.html +++ b/docs/Classes/SocketAnyEvent.html @@ -276,7 +276,7 @@

Declaration

-

© 2017 Erik. All rights reserved. (Last updated: 2017-10-01)

+

© 2017 Erik. All rights reserved. (Last updated: 2017-10-04)

Generated by jazzy ♪♫ v0.8.4, a Realm project.

diff --git a/docs/Classes/SocketClientManager.html b/docs/Classes/SocketClientManager.html index 008a1b46..27555da6 100644 --- a/docs/Classes/SocketClientManager.html +++ b/docs/Classes/SocketClientManager.html @@ -464,7 +464,7 @@

Declaration

-

© 2017 Erik. All rights reserved. (Last updated: 2017-10-01)

+

© 2017 Erik. All rights reserved. (Last updated: 2017-10-04)

Generated by jazzy ♪♫ v0.8.4, a Realm project.

diff --git a/docs/Classes/SocketEngine.html b/docs/Classes/SocketEngine.html index 3be1660d..ecd8d2c4 100644 --- a/docs/Classes/SocketEngine.html +++ b/docs/Classes/SocketEngine.html @@ -1454,7 +1454,7 @@

Declaration

-

© 2017 Erik. All rights reserved. (Last updated: 2017-10-01)

+

© 2017 Erik. All rights reserved. (Last updated: 2017-10-04)

Generated by jazzy ♪♫ v0.8.4, a Realm project.

diff --git a/docs/Classes/SocketIOClient.html b/docs/Classes/SocketIOClient.html index a4cefb71..1f365d29 100644 --- a/docs/Classes/SocketIOClient.html +++ b/docs/Classes/SocketIOClient.html @@ -494,7 +494,7 @@

Declaration

Declaration

Swift

- 
public private(set) var engine: SocketEngineSpec?
+ 
public internal(set) var engine: SocketEngineSpec?
@@ -2241,7 +2241,7 @@

Declaration

-

© 2017 Erik. All rights reserved. (Last updated: 2017-10-01)

+

© 2017 Erik. All rights reserved. (Last updated: 2017-10-04)

Generated by jazzy ♪♫ v0.8.4, a Realm project.

diff --git a/docs/Enums.html b/docs/Enums.html index 7161afd9..29bdf5b5 100644 --- a/docs/Enums.html +++ b/docs/Enums.html @@ -369,7 +369,7 @@

Declaration

-

© 2017 Erik. All rights reserved. (Last updated: 2017-10-01)

+

© 2017 Erik. All rights reserved. (Last updated: 2017-10-04)

Generated by jazzy ♪♫ v0.8.4, a Realm project.

diff --git a/docs/Enums/SocketAckStatus.html b/docs/Enums/SocketAckStatus.html index ab915bb2..844667b6 100644 --- a/docs/Enums/SocketAckStatus.html +++ b/docs/Enums/SocketAckStatus.html @@ -215,7 +215,7 @@

Declaration

-

© 2017 Erik. All rights reserved. (Last updated: 2017-10-01)

+

© 2017 Erik. All rights reserved. (Last updated: 2017-10-04)

Generated by jazzy ♪♫ v0.8.4, a Realm project.

diff --git a/docs/Enums/SocketClientEvent.html b/docs/Enums/SocketClientEvent.html index 0ce4c8be..de050496 100644 --- a/docs/Enums/SocketClientEvent.html +++ b/docs/Enums/SocketClientEvent.html @@ -376,7 +376,7 @@

Declaration

-

© 2017 Erik. All rights reserved. (Last updated: 2017-10-01)

+

© 2017 Erik. All rights reserved. (Last updated: 2017-10-04)

Generated by jazzy ♪♫ v0.8.4, a Realm project.

diff --git a/docs/Enums/SocketEnginePacketType.html b/docs/Enums/SocketEnginePacketType.html index 3accdf91..3c2d002d 100644 --- a/docs/Enums/SocketEnginePacketType.html +++ b/docs/Enums/SocketEnginePacketType.html @@ -401,7 +401,7 @@

Declaration

-

© 2017 Erik. All rights reserved. (Last updated: 2017-10-01)

+

© 2017 Erik. All rights reserved. (Last updated: 2017-10-04)

Generated by jazzy ♪♫ v0.8.4, a Realm project.

diff --git a/docs/Enums/SocketIOClientOption.html b/docs/Enums/SocketIOClientOption.html index 75183899..74ef801b 100644 --- a/docs/Enums/SocketIOClientOption.html +++ b/docs/Enums/SocketIOClientOption.html @@ -951,7 +951,7 @@

Return Value

-

© 2017 Erik. All rights reserved. (Last updated: 2017-10-01)

+

© 2017 Erik. All rights reserved. (Last updated: 2017-10-04)

Generated by jazzy ♪♫ v0.8.4, a Realm project.

diff --git a/docs/Enums/SocketIOClientStatus.html b/docs/Enums/SocketIOClientStatus.html index e006d877..e1ed9dbf 100644 --- a/docs/Enums/SocketIOClientStatus.html +++ b/docs/Enums/SocketIOClientStatus.html @@ -308,7 +308,7 @@

Declaration

-

© 2017 Erik. All rights reserved. (Last updated: 2017-10-01)

+

© 2017 Erik. All rights reserved. (Last updated: 2017-10-04)

Generated by jazzy ♪♫ v0.8.4, a Realm project.

diff --git a/docs/Enums/SocketParsableError.html b/docs/Enums/SocketParsableError.html index 07fb4504..94ec07ea 100644 --- a/docs/Enums/SocketParsableError.html +++ b/docs/Enums/SocketParsableError.html @@ -277,7 +277,7 @@

Declaration

-

© 2017 Erik. All rights reserved. (Last updated: 2017-10-01)

+

© 2017 Erik. All rights reserved. (Last updated: 2017-10-04)

Generated by jazzy ♪♫ v0.8.4, a Realm project.

diff --git a/docs/Guides.html b/docs/Guides.html index d12514b3..61252004 100644 --- a/docs/Guides.html +++ b/docs/Guides.html @@ -177,7 +177,7 @@

Guides

-

© 2017 Erik. All rights reserved. (Last updated: 2017-10-01)

+

© 2017 Erik. All rights reserved. (Last updated: 2017-10-04)

Generated by jazzy ♪♫ v0.8.4, a Realm project.

diff --git a/docs/Protocols.html b/docs/Protocols.html index 5a239dbd..f8384bb2 100644 --- a/docs/Protocols.html +++ b/docs/Protocols.html @@ -446,7 +446,7 @@

Declaration

-

© 2017 Erik. All rights reserved. (Last updated: 2017-10-01)

+

© 2017 Erik. All rights reserved. (Last updated: 2017-10-04)

Generated by jazzy ♪♫ v0.8.4, a Realm project.

diff --git a/docs/Protocols/SocketData.html b/docs/Protocols/SocketData.html index d57ec000..b8282b2d 100644 --- a/docs/Protocols/SocketData.html +++ b/docs/Protocols/SocketData.html @@ -243,7 +243,7 @@

Declaration

-

© 2017 Erik. All rights reserved. (Last updated: 2017-10-01)

+

© 2017 Erik. All rights reserved. (Last updated: 2017-10-04)

Generated by jazzy ♪♫ v0.8.4, a Realm project.

diff --git a/docs/Protocols/SocketEngineClient.html b/docs/Protocols/SocketEngineClient.html index 2cd2ceaa..0d8f8e0f 100644 --- a/docs/Protocols/SocketEngineClient.html +++ b/docs/Protocols/SocketEngineClient.html @@ -425,7 +425,7 @@

Parameters

-

© 2017 Erik. All rights reserved. (Last updated: 2017-10-01)

+

© 2017 Erik. All rights reserved. (Last updated: 2017-10-04)

Generated by jazzy ♪♫ v0.8.4, a Realm project.

diff --git a/docs/Protocols/SocketEnginePollable.html b/docs/Protocols/SocketEnginePollable.html index 02cc5881..1d6f7791 100644 --- a/docs/Protocols/SocketEnginePollable.html +++ b/docs/Protocols/SocketEnginePollable.html @@ -488,7 +488,7 @@

Declaration

-

© 2017 Erik. All rights reserved. (Last updated: 2017-10-01)

+

© 2017 Erik. All rights reserved. (Last updated: 2017-10-04)

Generated by jazzy ♪♫ v0.8.4, a Realm project.

diff --git a/docs/Protocols/SocketEngineSpec.html b/docs/Protocols/SocketEngineSpec.html index f060eba6..468fbf21 100644 --- a/docs/Protocols/SocketEngineSpec.html +++ b/docs/Protocols/SocketEngineSpec.html @@ -1079,7 +1079,7 @@

Parameters

-

© 2017 Erik. All rights reserved. (Last updated: 2017-10-01)

+

© 2017 Erik. All rights reserved. (Last updated: 2017-10-04)

Generated by jazzy ♪♫ v0.8.4, a Realm project.

diff --git a/docs/Protocols/SocketEngineWebsocket.html b/docs/Protocols/SocketEngineWebsocket.html index df74cef3..ab2c9c6a 100644 --- a/docs/Protocols/SocketEngineWebsocket.html +++ b/docs/Protocols/SocketEngineWebsocket.html @@ -341,7 +341,7 @@

Declaration

-

© 2017 Erik. All rights reserved. (Last updated: 2017-10-01)

+

© 2017 Erik. All rights reserved. (Last updated: 2017-10-04)

Generated by jazzy ♪♫ v0.8.4, a Realm project.

diff --git a/docs/Protocols/SocketIOClientSpec.html b/docs/Protocols/SocketIOClientSpec.html index 042998cd..b6db0dc1 100644 --- a/docs/Protocols/SocketIOClientSpec.html +++ b/docs/Protocols/SocketIOClientSpec.html @@ -1600,7 +1600,7 @@

Declaration

-

© 2017 Erik. All rights reserved. (Last updated: 2017-10-01)

+

© 2017 Erik. All rights reserved. (Last updated: 2017-10-04)

Generated by jazzy ♪♫ v0.8.4, a Realm project.

diff --git a/docs/Protocols/SocketLogger.html b/docs/Protocols/SocketLogger.html index e5a8f959..bd274fa4 100644 --- a/docs/Protocols/SocketLogger.html +++ b/docs/Protocols/SocketLogger.html @@ -389,7 +389,7 @@

Parameters

-

© 2017 Erik. All rights reserved. (Last updated: 2017-10-01)

+

© 2017 Erik. All rights reserved. (Last updated: 2017-10-04)

Generated by jazzy ♪♫ v0.8.4, a Realm project.

diff --git a/docs/Protocols/SocketParsable.html b/docs/Protocols/SocketParsable.html index 7dd23ebb..8b9b4c66 100644 --- a/docs/Protocols/SocketParsable.html +++ b/docs/Protocols/SocketParsable.html @@ -354,7 +354,7 @@

Parameters

-

© 2017 Erik. All rights reserved. (Last updated: 2017-10-01)

+

© 2017 Erik. All rights reserved. (Last updated: 2017-10-04)

Generated by jazzy ♪♫ v0.8.4, a Realm project.

diff --git a/docs/Structs.html b/docs/Structs.html index 0700026b..4b38947a 100644 --- a/docs/Structs.html +++ b/docs/Structs.html @@ -273,7 +273,7 @@

Declaration

-

© 2017 Erik. All rights reserved. (Last updated: 2017-10-01)

+

© 2017 Erik. All rights reserved. (Last updated: 2017-10-04)

Generated by jazzy ♪♫ v0.8.4, a Realm project.

diff --git a/docs/Structs/SocketEventHandler.html b/docs/Structs/SocketEventHandler.html index 9fabb488..ed24c660 100644 --- a/docs/Structs/SocketEventHandler.html +++ b/docs/Structs/SocketEventHandler.html @@ -357,7 +357,7 @@

Parameters

-

© 2017 Erik. All rights reserved. (Last updated: 2017-10-01)

+

© 2017 Erik. All rights reserved. (Last updated: 2017-10-04)

Generated by jazzy ♪♫ v0.8.4, a Realm project.

diff --git a/docs/Structs/SocketIOClientConfiguration.html b/docs/Structs/SocketIOClientConfiguration.html index 2f300c8a..0f2ecc37 100644 --- a/docs/Structs/SocketIOClientConfiguration.html +++ b/docs/Structs/SocketIOClientConfiguration.html @@ -636,7 +636,7 @@

Parameters

-

© 2017 Erik. All rights reserved. (Last updated: 2017-10-01)

+

© 2017 Erik. All rights reserved. (Last updated: 2017-10-04)

Generated by jazzy ♪♫ v0.8.4, a Realm project.

diff --git a/docs/Structs/SocketPacket.html b/docs/Structs/SocketPacket.html index 985f67ed..4c7ec793 100644 --- a/docs/Structs/SocketPacket.html +++ b/docs/Structs/SocketPacket.html @@ -480,7 +480,7 @@

Declaration

-

© 2017 Erik. All rights reserved. (Last updated: 2017-10-01)

+

© 2017 Erik. All rights reserved. (Last updated: 2017-10-04)

Generated by jazzy ♪♫ v0.8.4, a Realm project.

diff --git a/docs/Structs/SocketPacket/PacketType.html b/docs/Structs/SocketPacket/PacketType.html index 57dac111..db72f290 100644 --- a/docs/Structs/SocketPacket/PacketType.html +++ b/docs/Structs/SocketPacket/PacketType.html @@ -401,7 +401,7 @@

Declaration

-

© 2017 Erik. All rights reserved. (Last updated: 2017-10-01)

+

© 2017 Erik. All rights reserved. (Last updated: 2017-10-04)

Generated by jazzy ♪♫ v0.8.4, a Realm project.

diff --git a/docs/Typealiases.html b/docs/Typealiases.html index eb7618d9..3599ac00 100644 --- a/docs/Typealiases.html +++ b/docs/Typealiases.html @@ -235,7 +235,7 @@

Declaration

-

© 2017 Erik. All rights reserved. (Last updated: 2017-10-01)

+

© 2017 Erik. All rights reserved. (Last updated: 2017-10-04)

Generated by jazzy ♪♫ v0.8.4, a Realm project.

diff --git a/docs/faq.html b/docs/faq.html index ec3622cd..731f0e46 100644 --- a/docs/faq.html +++ b/docs/faq.html @@ -219,7 +219,7 @@

Why isn&rsqu
-

© 2017 Erik. All rights reserved. (Last updated: 2017-10-01)

+

© 2017 Erik. All rights reserved. (Last updated: 2017-10-04)

Generated by jazzy ♪♫ v0.8.4, a Realm project.

diff --git a/docs/index.html b/docs/index.html index e7e3ccf9..bac0084c 100644 --- a/docs/index.html +++ b/docs/index.html @@ -238,9 +238,15 @@

Swift Package Manager

import PackageDescription let package = Package( - name: "YourSocketIOProject", + name: "socket.io-test", + products: [ + .executable(name: "socket.io-test", targets: ["YourTargetName"]) + ], dependencies: [ - .package(url: "https://github.com/socketio/socket.io-client-swift", .upToNextMajor(from: "12.0.0")) + .package(url: "https://github.com/socketio/socket.io-client-swift", .upToNextMajor(from: "12.1.0")) + ], + targets: [ + .target(name: "YourTargetName", dependencies: ["SocketIO"], path: "./Path/To/Your/Sources") ] ) @@ -249,7 +255,7 @@

Swift Package Manager

Carthage

Add this line to your Cartfile:

-
github "socketio/socket.io-client-swift" ~> 12.1.0 # Or latest version
+
github "socketio/socket.io-client-swift" ~> 12.1.1 # Or latest version
 

 
 
Run carthage update --platform ios,macosx.

@@ -261,7 +267,7 @@ 
CocoaPods 1.0.0 or later

 
use_frameworks!
 
 target 'YourApp' do
-    pod 'Socket.IO-Client-Swift', '~> 12.1.0' # Or latest version
+    pod 'Socket.IO-Client-Swift', '~> 12.1.1' # Or latest version
 end
 

 
@@ -301,7 +307,7 @@ 
License

       
     
     

-      
© 2017 Erik. All rights reserved. (Last updated: 2017-10-01)

+      
© 2017 Erik. All rights reserved. (Last updated: 2017-10-04)

       
Generated by jazzy ♪♫ v0.8.4, a Realm project.