Skip to content

Commit 943e94e

Browse files
committed
Fix some documentation marks
1 parent 96ce620 commit 943e94e

File tree

7 files changed

+21
-3
lines changed

7 files changed

+21
-3
lines changed

Source/SocketIO/Ack/SocketAckManager.swift

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,8 @@ import Foundation
2727

2828
/// The status of an ack.
2929
public enum SocketAckStatus : String {
30+
// MARK: Cases
31+
3032
/// The ack timed out.
3133
case noAck = "NO ACK"
3234
}

Source/SocketIO/Client/SocketIOClientConfiguration.swift

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -129,6 +129,8 @@ public struct SocketIOClientConfiguration : ExpressibleByArrayLiteral, Collectio
129129

130130
/// Declares that a type can set configs from a `SocketIOClientConfiguration`.
131131
public protocol ConfigSettable {
132+
// MARK: Methods
133+
132134
/// Called when an `ConfigSettable` should set/update its configs from a given configuration.
133135
///
134136
/// - parameter config: The `SocketIOClientConfiguration` that should be used to set/update configs.

Source/SocketIO/Engine/SocketEnginePollable.swift

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ import Foundation
2626

2727
/// Protocol that is used to implement socket.io polling support
2828
public protocol SocketEnginePollable : SocketEngineSpec {
29-
/// MARK: Properties
29+
// MARK: Properties
3030

3131
/// `true` If engine's session has been invalidated.
3232
var invalidated: Bool { get }
@@ -51,6 +51,8 @@ public protocol SocketEnginePollable : SocketEngineSpec {
5151
/// **Do not touch this directly**
5252
var waitingForPost: Bool { get set }
5353

54+
// MARK: Methods
55+
5456
/// Call to send a long-polling request.
5557
///
5658
/// You shouldn't need to call this directly, the engine should automatically maintain a long-poll request.

Source/SocketIO/Engine/SocketEngineSpec.swift

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@ import Starscream
2828

2929
/// Specifies a SocketEngine.
3030
@objc public protocol SocketEngineSpec {
31+
// MARK: Properties
32+
3133
/// The client for this engine.
3234
var client: SocketEngineClient? { get set }
3335

@@ -85,13 +87,17 @@ import Starscream
8587
/// The WebSocket for this engine.
8688
var ws: WebSocket? { get }
8789

90+
// MARK: Initializers
91+
8892
/// Creates a new engine.
8993
///
9094
/// - parameter client: The client for this engine.
9195
/// - parameter url: The url for this engine.
9296
/// - parameter options: The options for this engine.
9397
init(client: SocketEngineClient, url: URL, options: [String: Any]?)
9498

99+
// MARK: Methods
100+
95101
/// Starts the connection to the server.
96102
func connect()
97103

Source/SocketIO/Engine/SocketEngineWebsocket.swift

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@ import Starscream
2828

2929
/// Protocol that is used to implement socket.io WebSocket support
3030
public protocol SocketEngineWebsocket : SocketEngineSpec, WebSocketDelegate {
31+
// MARK: Methods
32+
3133
/// Sends an engine.io message through the WebSocket transport.
3234
///
3335
/// You shouldn't call this directly, instead call the `write` method on `SocketEngine`.

Source/SocketIO/Parse/SocketParsable.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,6 @@ import Foundation
2424

2525
/// Defines that a type will be able to parse socket.io-protocol messages.
2626
public protocol SocketParsable : class {
27-
// MARK: Properties
28-
2927
// MARK: Methods
3028

3129
/// Called when the engine has received some binary data that should be attached to a packet.
@@ -60,6 +58,8 @@ public enum SocketParsableError : Error {
6058

6159
/// Says that a type will be able to buffer binary data before all data for an event has come in.
6260
public protocol SocketDataBufferable : class {
61+
// MARK: Properties
62+
6363
/// A list of packets that are waiting for binary data.
6464
///
6565
/// The way that socket.io works all data should be sent directly after each packet.

Source/SocketIO/Util/SSLSecurity.swift

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,17 @@ import Starscream
2727

2828
/// A wrapper around Starscream's SSLSecurity that provides a minimal Objective-C interface.
2929
open class SSLSecurity : NSObject {
30+
// MARK: Properties
31+
3032
/// The internal Starscream SSLSecurity.
3133
public let security: Starscream.SSLSecurity
3234

3335
init(security: Starscream.SSLSecurity) {
3436
self.security = security
3537
}
3638

39+
// MARK: Methods
40+
3741
/// Creates a new SSLSecurity that specifies whether to use publicKeys or certificates should be used for SSL
3842
/// pinning validation
3943
///

0 commit comments

Comments
 (0)