diff --git a/src/dotnet/src/Mil.Navy.Nrl.Norm/NormInstance.cs b/src/dotnet/src/Mil.Navy.Nrl.Norm/NormInstance.cs index d805219..f011d54 100644 --- a/src/dotnet/src/Mil.Navy.Nrl.Norm/NormInstance.cs +++ b/src/dotnet/src/Mil.Navy.Nrl.Norm/NormInstance.cs @@ -134,8 +134,7 @@ namespace Mil.Navy.Nrl.Norm /// This function retrieves the next available NORM protocol event from the protocol engine. /// /// - /// This is a default function which calls GetNextEvent(bool waitForEvent) override - /// with waitForEvent set as true. + /// This is an overload which calls GetNextEvent() with waitForEvent set as true. /// /// Returns an instance of NormEvent if NormGetNextEvent() returns true, returns null otherwise. public NormEvent? GetNextEvent() diff --git a/src/dotnet/src/Mil.Navy.Nrl.Norm/NormSession.cs b/src/dotnet/src/Mil.Navy.Nrl.Norm/NormSession.cs index de68d54..c2fc70a 100644 --- a/src/dotnet/src/Mil.Navy.Nrl.Norm/NormSession.cs +++ b/src/dotnet/src/Mil.Navy.Nrl.Norm/NormSession.cs @@ -105,8 +105,7 @@ namespace Mil.Navy.Nrl.Norm /// This function is used to force NORM to use a specific port number for UDP packets sent. /// /// - /// This is a default function which calls SetTxPort(int port, bool enableReuse, string? txBindAddress) override - /// with enableReuse set as false and txBindAddress set to null. + /// This is an overload which calls SetTxPort() with enableReuse set as false and txBindAddress set to null. /// /// The port parameter, specifies which port number to use. /// Thrown when NormSetTxPort() returns false, indicating the failure to set tx port. @@ -134,8 +133,7 @@ namespace Mil.Navy.Nrl.Norm /// This function limits the NormSession to perform NORM sender functions only. /// /// - /// This is a default function which calls etTxOnly(bool txOnly, bool connectToSessionAddress) override - /// with connectToSessionAddress set as false. + /// This is an overload which calls SetTxOnly() with connectToSessionAddress set as false. /// /// Boolean specifing whether to turn on or off the txOnly operation. public void SetTxOnly(bool txOnly) @@ -158,8 +156,7 @@ namespace Mil.Navy.Nrl.Norm /// This function allows the user to control the port reuse and binding behavior for the receive socket. /// /// - /// This is a default function which calls SetRxPortReuse(bool enable, string? rxBindAddress, string? senderAddress, int senderPort) - /// with rxBindAddress set to null, senderAddress set to null, and senderPort set to 0. + /// This is an overload that calls SetRxPortReuse() with rxBindAddress set to null, senderAddress set to null, and senderPort set to 0. /// /// When the enable parameter is set to true, reuse of the NormSession port number by multiple NORM instances or sessions is enabled. public void SetRxPortReuse(bool enable) @@ -181,8 +178,7 @@ namespace Mil.Navy.Nrl.Norm } /// - /// This is a default function which calls SetEcnSupport(bool ecnEnable, bool ignoreLoss, bool tolerateLoss) override - /// with tolerateLoss set as false. + /// This is an overload which calls SetEcnSupport() with tolerateLoss set as false. /// /// Enables NORM ECN (congestion control) support. /// With "ecnEnable", use ECN-only, ignoring packet loss. @@ -321,8 +317,7 @@ namespace Mil.Navy.Nrl.Norm /// but congestion control operation can be dynamically enabled/disabled during the course of sender operation. /// /// - /// This is the default function which calls SetCongestionControl(bool enable, bool adjustRate) override - /// with adjustRate set to true. + /// This is an overload which calls SetCongestionControl() with adjustRate set to true. /// /// Specifies whether to enable or disable the NORM sender congestion control operation. public void SetCongestionControl(bool enable) @@ -464,7 +459,7 @@ namespace Mil.Navy.Nrl.Norm /// "repair window" as needed for some applications. While relative paths with respect to the "current working directory" /// may be used, it is recommended that full paths be used when possible. /// The optional info and infoLength parameters are used to associate NORM_INFO content with the sent transport object. - /// Indicates the strart of the message. Anything before it will not be sent. + /// Indicates the start of the message. Anything before it will not be sent. /// Note: to send full message infoOffset should be set to 0. /// The optional info and infoLength parameters are used to associate NORM_INFO content with the sent transport object. /// A NormFile is returned which the application may use in other NORM API calls as needed. @@ -496,7 +491,7 @@ namespace Mil.Navy.Nrl.Norm /// This is an overload which will call DataEnqueue() with info set to null, infoOffset set to 0, and infoLength set to 0. /// /// The dataBuffer is a byte array containing the message to be transmitted. - /// Indicates the strart of the message. Anything before it will not be sent. + /// Indicates the start of the message. Anything before it will not be sent. /// Note: to send full message dataOffset should be set to 0. /// Size of the message. /// A NormData is returned which the application may use in other NORM API calls as needed. @@ -510,11 +505,11 @@ namespace Mil.Navy.Nrl.Norm /// This function enqueues a segment of application memory space for transmission. /// /// The dataBuffer is a byte array containing the message to be transmitted. - /// Indicates the strart of the message. Anything before it will not be sent. + /// Indicates the start of the message. Anything before it will not be sent. /// Note: to send full message dataOffset should be set to 0. /// Size of the message. /// The optional info and infoLength parameters are used to associate NORM_INFO content with the sent transport object. - /// Indicates the strart of the message. + /// Indicates the start of the message. /// The optional info and infoLength parameters are used to associate NORM_INFO content with the sent transport object. /// A NormData is returned which the application may use in other NORM API calls as needed. /// Thrown when NormDataEnqueue() returns NORM_OBJECT_INVALID, indicating the failure to enqueue data. @@ -572,7 +567,7 @@ namespace Mil.Navy.Nrl.Norm /// The bufferSize parameter controls the size of the stream's "repair window" /// which limits how far back the sender will "rewind" to satisfy receiver repair requests. /// Alloted memory space for transmitted information. - /// Indicates the strart of the message. Anything before it will not be sent. + /// Indicates the start of the message. Anything before it will not be sent. /// Note: to send full message infoOffset should be set to 0. /// Size of the message. /// A NormStream is returned which the application may use in other NORM API calls as needed. diff --git a/src/dotnet/src/Mil.Navy.Nrl.Norm/NormStream.cs b/src/dotnet/src/Mil.Navy.Nrl.Norm/NormStream.cs index 4b443dd..3732051 100644 --- a/src/dotnet/src/Mil.Navy.Nrl.Norm/NormStream.cs +++ b/src/dotnet/src/Mil.Navy.Nrl.Norm/NormStream.cs @@ -83,8 +83,7 @@ /// This function causes an immediate "flush" of the transmit stream. /// /// - /// This is a default function which calls Flush(bool eom, NormFlushMode flushMode) override - /// with eom set as false and flushMode set to NORM_FLUSH_PASSIVE + /// This is an overload which calls Flush() with eom set as false and flushMode set to NORM_FLUSH_PASSIVE /// public void Flush() { @@ -107,8 +106,7 @@ /// has been explicitly retained by a call to NormObjectRetain(). /// /// - /// This is a default function which calls Close(bool graceful) override - /// with graceful set as false. + /// This is an overload which calls Close() with graceful set as false. /// public void Close() {