From 8ad25033d5aa7145275491f14f10070cdfcc802c Mon Sep 17 00:00:00 2001 From: Michael Croes Date: Wed, 26 Jul 2023 23:38:32 +0200 Subject: [PATCH] chore: Fix xmldoc warnings --- S7.Net/COTP.cs | 2 ++ S7.Net/PLCHelpers.cs | 5 +++-- S7.Net/PlcAsynchronous.cs | 2 +- S7.Net/PlcSynchronous.cs | 1 - S7.Net/StreamExtensions.cs | 1 + S7.Net/TPKT.cs | 1 + S7.Net/Types/Class.cs | 8 +++++++- S7.Net/Types/DateTime.cs | 2 +- 8 files changed, 16 insertions(+), 6 deletions(-) diff --git a/S7.Net/COTP.cs b/S7.Net/COTP.cs index 3e5abbb..4f8b1cd 100644 --- a/S7.Net/COTP.cs +++ b/S7.Net/COTP.cs @@ -55,6 +55,7 @@ namespace S7.Net /// See: https://tools.ietf.org/html/rfc905 /// /// The socket to read from + /// A cancellation token that can be used to cancel the asynchronous operation. /// COTP DPDU instance public static async Task ReadAsync(Stream stream, CancellationToken cancellationToken) { @@ -89,6 +90,7 @@ namespace S7.Net /// See: https://tools.ietf.org/html/rfc905 /// /// The stream to read from + /// A cancellation token that can be used to cancel the asynchronous operation. /// Data in TSDU public static async Task ReadAsync(Stream stream, CancellationToken cancellationToken) { diff --git a/S7.Net/PLCHelpers.cs b/S7.Net/PLCHelpers.cs index c0fbd78..ef26e87 100644 --- a/S7.Net/PLCHelpers.cs +++ b/S7.Net/PLCHelpers.cs @@ -12,8 +12,8 @@ namespace S7.Net /// /// Creates the header to read bytes from the PLC /// - /// - /// + /// The stream to write to. + /// The number of items to read. private static void BuildHeaderPackage(System.IO.MemoryStream stream, int amount = 1) { //header size = 19 bytes @@ -32,6 +32,7 @@ namespace S7.Net /// Create the bytes-package to request data from the PLC. You have to specify the memory type (dataType), /// the address of the memory, the address of the byte and the bytes count. /// + /// The stream to write the read data request to. /// MemoryType (DB, Timer, Counter, etc.) /// Address of the memory to be read /// Start address of the byte diff --git a/S7.Net/PlcAsynchronous.cs b/S7.Net/PlcAsynchronous.cs index 36fef8c..77cd0c8 100644 --- a/S7.Net/PlcAsynchronous.cs +++ b/S7.Net/PlcAsynchronous.cs @@ -428,7 +428,6 @@ namespace S7.Net /// /// Writes a single variable from the PLC, takes in input strings like "DB1.DBX0.0", "DB20.DBD200", "MB20", "T45", etc. - /// If the write was not successful, check or . /// /// Input strings like "DB1.DBX0.0", "DB20.DBD200", "MB20", "T45", etc. /// Value to be written to the PLC @@ -507,6 +506,7 @@ namespace S7.Net /// Address of the memory area (if you want to read DB1, this is set to 1). This must be set also for other memory area types: counters, timers,etc. /// Start byte address. If you want to read DB1.DBW200, this is 200. /// Bytes to write. The lenght of this parameter can't be higher than 200. If you need more, use recursion. + /// A cancellation token that can be used to cancel the asynchronous operation. /// A task that represents the asynchronous write operation. private async Task WriteBytesWithASingleRequestAsync(DataType dataType, int db, int startByteAdr, ReadOnlyMemory value, CancellationToken cancellationToken) { diff --git a/S7.Net/PlcSynchronous.cs b/S7.Net/PlcSynchronous.cs index 4a3aaad..afd122a 100644 --- a/S7.Net/PlcSynchronous.cs +++ b/S7.Net/PlcSynchronous.cs @@ -289,7 +289,6 @@ namespace S7.Net /// /// Writes a single variable from the PLC, takes in input strings like "DB1.DBX0.0", "DB20.DBD200", "MB20", "T45", etc. - /// If the write was not successful, check or . /// /// Input strings like "DB1.DBX0.0", "DB20.DBD200", "MB20", "T45", etc. /// Value to be written to the PLC diff --git a/S7.Net/StreamExtensions.cs b/S7.Net/StreamExtensions.cs index 749b915..504e4dc 100644 --- a/S7.Net/StreamExtensions.cs +++ b/S7.Net/StreamExtensions.cs @@ -39,6 +39,7 @@ namespace S7.Net /// the buffer to read into /// the offset in the buffer to read into /// the amount of bytes to read into the buffer + /// A cancellation token that can be used to cancel the asynchronous operation. /// returns the amount of read bytes public static async Task ReadExactAsync(this Stream stream, byte[] buffer, int offset, int count, CancellationToken cancellationToken) { diff --git a/S7.Net/TPKT.cs b/S7.Net/TPKT.cs index a311dce..f24b4c0 100644 --- a/S7.Net/TPKT.cs +++ b/S7.Net/TPKT.cs @@ -29,6 +29,7 @@ namespace S7.Net /// Reads a TPKT from the socket Async /// /// The stream to read from + /// A cancellation token that can be used to cancel the asynchronous operation. /// Task TPKT Instace public static async Task ReadAsync(Stream stream, CancellationToken cancellationToken) { diff --git a/S7.Net/Types/Class.cs b/S7.Net/Types/Class.cs index 819b626..fa5eb06 100644 --- a/S7.Net/Types/Class.cs +++ b/S7.Net/Types/Class.cs @@ -76,6 +76,8 @@ namespace S7.Net.Types /// Gets the size of the class in bytes. /// /// An instance of the class + /// The offset of the current field. + /// if this property belongs to a class being serialized as member of the class requested for serialization; otherwise, . /// the number of bytes public static double GetClassSize(object instance, double numBytes = 0.0, bool isInnerProperty = false) { @@ -213,6 +215,8 @@ namespace S7.Net.Types /// /// The object to fill in the given array of bytes /// The array of bytes + /// The offset for the current field. + /// if this class is the type of a member of the class to be serialized; otherwise, . public static double FromBytes(object sourceClass, byte[] bytes, double numBytes = 0, bool isInnerClass = false) { if (bytes == null) @@ -320,7 +324,9 @@ namespace S7.Net.Types /// /// Creates a byte array depending on the struct type. /// - /// The struct object + /// The struct object. + /// The target byte array. + /// The offset for the current field. /// A byte array or null if fails. public static double ToBytes(object sourceClass, byte[] bytes, double numBytes = 0.0) { diff --git a/S7.Net/Types/DateTime.cs b/S7.Net/Types/DateTime.cs index 9cafa67..a685a21 100644 --- a/S7.Net/Types/DateTime.cs +++ b/S7.Net/Types/DateTime.cs @@ -141,7 +141,7 @@ namespace S7.Net.Types /// Converts an array of values to a byte array. /// /// The DateTime values to convert. - /// A byte array containing the S7 date time representations of . + /// A byte array containing the S7 date time representations of . /// Thrown when any value of /// is before /// or after .