From 7ec48dd64fc243da6b197b1d33c05e1f50b1a4a5 Mon Sep 17 00:00:00 2001 From: AKosylo Date: Fri, 13 Oct 2023 13:52:40 +0200 Subject: [PATCH] fix comments --- DXFeedFramework/Events/Market/Extra/OrderBase.swift | 5 ++++- DXFeedFramework/Events/Market/Extra/TradeBase.swift | 6 ++++-- DXFeedFramework/Events/Market/OptionSale.swift | 5 +++-- DXFeedFramework/Events/Market/Series.swift | 1 + 4 files changed, 12 insertions(+), 5 deletions(-) diff --git a/DXFeedFramework/Events/Market/Extra/OrderBase.swift b/DXFeedFramework/Events/Market/Extra/OrderBase.swift index ece1f5105..44bb2fc73 100644 --- a/DXFeedFramework/Events/Market/Extra/OrderBase.swift +++ b/DXFeedFramework/Events/Market/Extra/OrderBase.swift @@ -91,8 +91,11 @@ public class OrderBase: MarketEvent, IIndexedEvent, CustomStringConvertible { */ /// Gets or sets time and sequence of this order packaged into single long value + /// /// This method is intended for efficient order time priority comparison. - /// Do not set their property directly. + /// **Do not set their property directly.** + /// + /// Sets ``time`` and/or ``setSequence(_:)``. public internal(set) var timeSequence: Long = 0 /// Gets or sets microseconds and nanoseconds time part of this order. public var timeNanoPart: Int32 = 0 diff --git a/DXFeedFramework/Events/Market/Extra/TradeBase.swift b/DXFeedFramework/Events/Market/Extra/TradeBase.swift index 6afcb674e..690b63041 100644 --- a/DXFeedFramework/Events/Market/Extra/TradeBase.swift +++ b/DXFeedFramework/Events/Market/Extra/TradeBase.swift @@ -26,7 +26,9 @@ public class TradeBase: MarketEvent, ILastingEvent { */ /// Gets or sets time and sequence of last trade packaged into single long value. - /// Do not set this property directly. + /// + /// **Do not set this property directly.** + /// /// Sets ``time`` and/or ``setSequence(_:)``. public internal(set) var timeSequence: Long = 0 /// Gets or sets microseconds and nanoseconds time part of the last trade. @@ -49,7 +51,7 @@ public class TradeBase: MarketEvent, ILastingEvent { public var dayTurnover: Double = .nan /// Gets or sets implementation-specific flags. /// Do not use this method directly. - internal var flags: Int32 = 0 + var flags: Int32 = 0 public init(_ symbol: String) { self.eventSymbol = symbol diff --git a/DXFeedFramework/Events/Market/OptionSale.swift b/DXFeedFramework/Events/Market/OptionSale.swift index f8a46a3d9..0a04c6c3a 100644 --- a/DXFeedFramework/Events/Market/OptionSale.swift +++ b/DXFeedFramework/Events/Market/OptionSale.swift @@ -41,7 +41,8 @@ public class OptionSale: MarketEvent, IIndexedEvent { /// Gets or sets time and sequence of this series packaged into single long value. /// /// This method is intended for efficient series time priority comparison. - /// **Do not use this method directly** + /// **Do not use this property directly** + /// /// Change ``time`` and/or ``setSequence(_:)`` public internal(set) var timeSequence: Long = 0 /// Gets or sets microseconds and nanoseconds time part of event. @@ -63,7 +64,7 @@ public class OptionSale: MarketEvent, IIndexedEvent { /// Gets or sets implementation-specific flags. /// /// **Do not use this method directly.** - public var flags: Int32 = 0 + var flags: Int32 = 0 /// Gets or sets underlying price at the time of this option sale event. public var underlyingPrice: Double = .nan /// Gets or sets Black-Scholes implied volatility of the option at the time of this option sale event. diff --git a/DXFeedFramework/Events/Market/Series.swift b/DXFeedFramework/Events/Market/Series.swift index d18b9b6ff..d328e35ef 100644 --- a/DXFeedFramework/Events/Market/Series.swift +++ b/DXFeedFramework/Events/Market/Series.swift @@ -39,6 +39,7 @@ public class Series: MarketEvent, IIndexedEvent { /// /// This method is intended for efficient series time priority comparison. /// **Do not use this method directly** + /// /// Change ``time`` and/or ``setSequence(_:)`` public internal(set) var timeSequence: Long = 0 /// Gets or sets day id of expiration.