From cc59286a3bccaac01c9835af2d6686f1f4e72316 Mon Sep 17 00:00:00 2001 From: AKosylo Date: Tue, 9 Jan 2024 11:18:20 +0100 Subject: [PATCH] fix typo in comments --- DXFeedFramework/Api/DXEndpoint.swift | 14 +++++++------- DXFeedFramework/Schedule/DXSchedule.swift | 20 ++++++++++---------- 2 files changed, 17 insertions(+), 17 deletions(-) diff --git a/DXFeedFramework/Api/DXEndpoint.swift b/DXFeedFramework/Api/DXEndpoint.swift index e4a145edc..dd82043c7 100644 --- a/DXFeedFramework/Api/DXEndpoint.swift +++ b/DXFeedFramework/Api/DXEndpoint.swift @@ -276,7 +276,7 @@ public class DXEndpoint { /// ``connect(_:)`` method or was disconnected with ``disconnect()`` method. /// The method initiates a short-path way for reconnecting, so whether listeners will have a chance to see /// an intermediate state ``DXEndpointState/notConnected`` depends on the implementation. - /// - Throws: GraalException. Rethrows exception from Java.recore + /// - Throws: GraalException. Rethrows exception from Java. public func reconnect() throws { try self.endpointNative.reconnect() } @@ -286,7 +286,7 @@ public class DXEndpoint { /// The endpoint ``getState()`` immediately becomes ``DXEndpointState/notConnected`` otherwise. /// This method does not release all resources that are associated with this endpoint. /// Use ``close()`` or ``closeAndAwaitTermination()`` methods to release all resources. - /// - Throws: GraalException. Rethrows exception from Java.recore + /// - Throws: GraalException. Rethrows exception from Java. public func disconnect() throws { try self.endpointNative.disconnect() } @@ -296,7 +296,7 @@ public class DXEndpoint { /// The endpoint``getState()`` immediately becomes``DXEndpointState/notConnected`` otherwise. /// This method does not release all resources that are associated with this endpoint. /// Use ``close()`` or ``closeAndAwaitTermination()`` methods to release all resources. - /// - Throws: GraalException. Rethrows exception from Java.recore + /// - Throws: GraalException. Rethrows exception from Java. public func disconnectAndClear() throws { try self.endpointNative.disconnectAndClear() } @@ -305,7 +305,7 @@ public class DXEndpoint { /// All network connection are terminated as with ``disconnect()`` /// method and no further connections can be established. /// The endpoint ``getState()`` immediately becomes ``DXEndpointState/closed``. - /// - Throws: GraalException. Rethrows exception from Java.recore + /// - Throws: GraalException. Rethrows exception from Java. public func close() throws { try self.endpointNative.close() } @@ -349,7 +349,7 @@ public class DXEndpoint { /// This is important when writing data to file via "tape:..." connector to make sure that /// all published data was written before closing this endpoint. /// **This method is blocking.** - /// - Throws: GraalException. Rethrows exception from Java.recore + /// - Throws: GraalException. Rethrows exception from Java. public func awaitProcessed() throws { try endpointNative.awaitProcessed() } @@ -360,14 +360,14 @@ public class DXEndpoint { /// processed by the corresponding subscription listeners. Use ``closeAndAwaitTermination()`` after /// this method returns to make sure that all processing has completed. /// **This method is blocking.** - /// - Throws: GraalException. Rethrows exception from Java.recore + /// - Throws: GraalException. Rethrows exception from Java. public func awaitNotConnected() throws { try endpointNative.awaitNotConnected() } /// Gets the ``DXEndpointState`` of this endpoint. /// - Returns: ``DXEndpointState`` - /// - Throws: GraalException. Rethrows exception from Java.recore + /// - Throws: GraalException. Rethrows exception from Java. public func getState() throws -> DXEndpointState { return try endpointNative.getState() } diff --git a/DXFeedFramework/Schedule/DXSchedule.swift b/DXFeedFramework/Schedule/DXSchedule.swift index 49c06f18e..d12164911 100644 --- a/DXFeedFramework/Schedule/DXSchedule.swift +++ b/DXFeedFramework/Schedule/DXSchedule.swift @@ -23,7 +23,7 @@ public class DXSchedule { /// /// - Parameters: /// - scheduleDefinition: schedule definition of requested schedule - /// - Throws: GraalException. Rethrows exception from Java.recore + /// - Throws: GraalException. Rethrows exception from Java. public convenience init(scheduleDefinition: String) throws { let native = try NativeSchedule(scheduleDefinition: scheduleDefinition) self.init(native: native) @@ -33,7 +33,7 @@ public class DXSchedule { /// /// - Parameters: /// - instrumentProfile: instrument profile those schedule is requested - /// - Throws: GraalException. Rethrows exception from Java.recore + /// - Throws: GraalException. Rethrows exception from Java. public convenience init(instrumentProfile: InstrumentProfile) throws { let native = try NativeSchedule(instrumentProfile: instrumentProfile) self.init(native: native) @@ -44,7 +44,7 @@ public class DXSchedule { /// - Parameters: /// - instrumentProfile: instrument profile those schedule is requested /// - venue: trading venue those schedule is requested - /// - Throws: GraalException. Rethrows exception from Java.recore + /// - Throws: GraalException. Rethrows exception from Java. public convenience init(instrumentProfile: InstrumentProfile, venue: String) throws { let native = try NativeSchedule(instrumentProfile: instrumentProfile, venue: venue) self.init(native: native) @@ -53,28 +53,28 @@ public class DXSchedule { /// - Parameters: /// - profile: instrument profile those schedule is requested /// - Returns: trading venue those schedule is requested - /// - Throws: GraalException. Rethrows exception from Java.recore + /// - Throws: GraalException. Rethrows exception from Java. public static func getTradingVenues(profile: InstrumentProfile ) throws -> [String] { return try NativeSchedule.getTradingVenues(profile: profile) } /// Returns day that contains specified time. /// - /// - Throws: GraalException. Rethrows exception from Java.recore + /// - Throws: GraalException. Rethrows exception from Java. public func getName() throws -> String { return try native.getName() } /// Returns time zone name in which this schedule is defined. /// - /// - Throws: GraalException. Rethrows exception from Java.recore + /// - Throws: GraalException. Rethrows exception from Java. public func getTimeZone() throws -> String { return try native.getTimeZone() } /// Returns time zone id in which this schedule is defined. /// - /// - Throws: GraalException. Rethrows exception from Java.recore + /// - Throws: GraalException. Rethrows exception from Java. public func getTimeZoneId() throws -> String { return try native.getTimeZoneId() } @@ -85,7 +85,7 @@ public class DXSchedule { /// falls outside of valid date range from 0001-01-02 to 9999-12-30. /// - Parameters: /// - time: the time to search for - /// - Throws: GraalException. Rethrows exception from Java.recore + /// - Throws: GraalException. Rethrows exception from Java. public func getDayByTime(time: Long) throws -> ScheduleDay { let day = try native.getDayByTime(time: time) return day @@ -97,7 +97,7 @@ public class DXSchedule { /// falls outside of valid date range from 0001-01-02 to 9999-12-30. /// - Parameters: /// - day: identifier to search for - /// - Throws: GraalException. Rethrows exception from Java.recore + /// - Throws: GraalException. Rethrows exception from Java. public func getDayById(day: Int32) throws -> ScheduleDay { let day = try native.getDayById(dayId: day) return day @@ -114,7 +114,7 @@ public class DXSchedule { /// fall outside of valid date range from 0001-01-02 to 9999-12-30. /// - Parameters: /// - yearMonthDay: year, month and day numbers to search for - /// - Throws: ``GraalException``. Rethrows exception from Java.recore + /// - Throws: ``GraalException``. Rethrows exception from Java. public func getDayByYearMonthDay(yearMonthDay: Int32) throws -> ScheduleDay { let day = try native.getDayByYearMonthDay(yearMonthDay: yearMonthDay) return day