Update documentation comments, fix spelling

DimaRU · Jan 15, 2024 · 221ee79 · 221ee79
1 parent 1e7d612
commit 221ee79
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 7 deletions.
diff --git a/Sources/FastRTPSSwift/DDSTopic.swift b/Sources/FastRTPSSwift/DDSTopic.swift
@@ -6,16 +6,16 @@
 
 import Foundation
 
-/// Basic DDS topic requement. Must define topic name string as Raw value
+/// Common DDS reader/writer topic requirements. Must define topic name Raw value as string
 public protocol DDSTopic: RawRepresentable where RawValue == String {}
 
-/// Reader topic requements
+/// Reader topic requirements
 public protocol DDSReaderTopic: DDSTopic {
     /// Return profile which defines Reader parameters: durability and reliability QoS
     var readerProfile: RTPSReaderProfile { get }
 }
 
-/// Writer topic requements
+/// Writer topic requirements
 public protocol DDSWriterTopic: DDSTopic {
     /// Return profile which defines Writer parameters: durability, reliability and disablePositiveACKs QoS
     var writerProfile: RTPSWriterProfile { get }

diff --git a/Sources/FastRTPSSwift/DDSType.swift b/Sources/FastRTPSSwift/DDSType.swift
@@ -5,17 +5,17 @@
 
 import Foundation
 
-/// Basic desctiption for DDS data types
+/// DDS data types requirements
 public protocol DDSType: Codable {
     /// Defines DDS type name, 'DDS::String' for example
     static var ddsTypeName: String { get }
 }
 
-/// Describe keyed DDS data type
+/// Keyed DDS data type requirements
 public protocol DDSKeyed: DDSType {
     /// Data for topic key generation
     var key: Data { get }
 }
 
-/// Describe unkeyed DDS data type
+/// Unkeyed DDS data type requirements
 public protocol DDSUnkeyed: DDSType {}
diff --git a/Sources/FastRTPSSwift/FastRTPSSwift.swift b/Sources/FastRTPSSwift/FastRTPSSwift.swift
@@ -159,7 +159,7 @@ open class FastRTPSSwift {
     ///   - name: participant name
     ///   - domainID: DomainId to be used by the participant (0 by default)
     ///   - participantProfile: Defines configuration for created participant. See RTPSParticipantProfile struct
-    ///   - localAddress: bind only to localAddress
+    ///   - localAddress: bind only to localAddress, nil by default
     public func createParticipant(name: String,
                                   domainID: UInt32 = 0,
                                   participantProfile: RTPSParticipantProfile? = nil,