Skip to content

Commit

Permalink
fix typo in comments
Browse files Browse the repository at this point in the history
  • Loading branch information
kosyloa committed Jan 9, 2024
1 parent 059cdf4 commit cc59286
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 17 deletions.
14 changes: 7 additions & 7 deletions DXFeedFramework/Api/DXEndpoint.swift
Original file line number Diff line number Diff line change
Expand Up @@ -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()
}
Expand All @@ -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()
}
Expand All @@ -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()
}
Expand All @@ -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()
}
Expand Down Expand Up @@ -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()
}
Expand All @@ -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()
}
Expand Down
20 changes: 10 additions & 10 deletions DXFeedFramework/Schedule/DXSchedule.swift
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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)
Expand All @@ -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)
Expand All @@ -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()
}
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand Down

0 comments on commit cc59286

Please sign in to comment.