From a8ee018a1601ba06e8c36f452c374fee081b91cd Mon Sep 17 00:00:00 2001 From: Erik Date: Fri, 5 May 2017 23:14:48 -0400 Subject: [PATCH] Document SocketAnyEvent --- Source/SocketAnyEvent.swift | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/Source/SocketAnyEvent.swift b/Source/SocketAnyEvent.swift index 3647e96..f27bb1c 100644 --- a/Source/SocketAnyEvent.swift +++ b/Source/SocketAnyEvent.swift @@ -24,13 +24,21 @@ import Foundation +/// Represents some event that was received. public final class SocketAnyEvent : NSObject { + // MARK: Properties + + /// The event name. public let event: String + + /// The data items for this event. public let items: [Any]? + + /// The description of this event. override public var description: String { return "SocketAnyEvent: Event: \(event) items: \(String(describing: items))" } - + init(event: String, items: [Any]?) { self.event = event self.items = items