Skip to content

Commit

Permalink
fix documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
kosyloa committed Mar 14, 2024
1 parent 57872d9 commit 7e6fd1e
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 7 deletions.
5 changes: 2 additions & 3 deletions DXFeedFramework/Api/DXEndpoint.swift
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ public typealias Role = DXEndpoint.Role
///
/// Porting a Java class com.dxfeed.api.DXEndpoint.
///
/// For more details see https://docs.dxfeed.com/dxfeed/api/com/dxfeed/api/DXEndpoint.html
/// There are ready-to-use singleton instances that are available with ``DXEndpoint/getInstance(_:)`` method as wel as
/// factory method ``DXEndpoint/create(_:)``, and a number of configuration methods.
///
Expand All @@ -27,6 +26,7 @@ public typealias Role = DXEndpoint.Role
/// let endpoint = try DXEndpoint.create().set(userName: "demo").set(password: "demo")
/// .connect("demo.dxfeed.com:7300").getFeed()
///
/// [For more details see](https://docs.dxfeed.com/dxfeed/api/com/dxfeed/api/DXEndpoint.html)
public class DXEndpoint {

/// A list of endpoint roles.
Expand Down Expand Up @@ -404,8 +404,7 @@ public class DXEndpoint {
/// Builder class for ``DXEndpoint`` that supports additional configuration properties.
///
/// Porting a Java class com.dxfeed.api.DXEndpoint.Builder.
/// For more details
/// see [Javadoc](https://docs.dxfeed.com/dxfeed/api/com/dxfeed/api/DXEndpoint.Builder.html)
/// For more details see [Javadoc](https://docs.dxfeed.com/dxfeed/api/com/dxfeed/api/DXEndpoint.Builder.html)
///
/// The ``build()`` method tries to load the default property file for the ``DXEndpoint/Role-swift.enum/feed``,
/// ``DXEndpoint/Role-swift.enum/onDemandFeed`` and ``DXEndpoint/Role-swift.enum/publisher`` role.
Expand Down
2 changes: 1 addition & 1 deletion DXFeedFramework/Api/DXFeed.swift
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import Foundation

/// Main entry class for dxFeed API.
///
/// [Read it first Javadoc](https://docs.dxfeed.com/dxfeed/api/com/dxfeed/api/DXFeed.html)
/// [For more details see](https://docs.dxfeed.com/dxfeed/api/com/dxfeed/api/DXFeed.html)
public class DXFeed {
/// Feed native wrapper.
private let native: NativeFeed
Expand Down
2 changes: 1 addition & 1 deletion DXFeedFramework/Api/DXFeedSubscription.swift
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import Foundation

/// Subscription for a set of symbols and event types.
///
/// [Read it first Javadoc](https://docs.dxfeed.com/dxfeed/api/com/dxfeed/api/DXFeedSubscription.html)
/// [For more details see](https://docs.dxfeed.com/dxfeed/api/com/dxfeed/api/DXFeedSubscription.html)
public class DXFeedSubscription {
/// Subscription native wrapper.
private let native: NativeSubscription
Expand Down
4 changes: 2 additions & 2 deletions DXFeedFramework/Api/DXPublisher.swift
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import Foundation

/// Provides API for publishing of events to local or remote ``DXFeed``
///
/// [Read it first Javadoc](https://docs.dxfeed.com/dxfeed/api/com/dxfeed/api/DXPublisher.html)
/// [For more details see](https://docs.dxfeed.com/dxfeed/api/com/dxfeed/api/DXPublisher.html)
public class DXPublisher {
/// Feed native wrapper.
private let native: NativePublisher
Expand All @@ -31,7 +31,7 @@ public class DXPublisher {
/// ``DXEndpoint/Role-swift.enum/publisher`` role and it is connected, the
/// published events will be delivered to the remote endpoints. Local ``DXEndpoint/getFeed()`` will
/// always receive published events.
/// [Read it first Javadoc](https://docs.dxfeed.com/dxfeed/api/com/dxfeed/api/DXPublisher.html#publishEvents-java.util.Collection-)
/// [For more details see](https://docs.dxfeed.com/dxfeed/api/com/dxfeed/api/DXPublisher.html#publishEvents-java.util.Collection-)
/// - Parameters:
/// - events: The collection of events to publish.
/// - Throws: GraalException. Rethrows exception from Java.
Expand Down

0 comments on commit 7e6fd1e

Please sign in to comment.