From c84535d13e672ac913de7fcff4c0a20841ff86ea Mon Sep 17 00:00:00 2001 From: David Hall Date: Wed, 4 Oct 2023 16:12:06 -0600 Subject: [PATCH] Cleaned up messed up XML comments --- PInvoke/Ws2_32/MSWSock.cs | 2 ++ PInvoke/Ws2_32/WinSock2.WSA.Enum.cs | 2 ++ PInvoke/Ws2_32/mstcpip.cs | 2 ++ PInvoke/Ws2_32/mswsockdef.cs | 2 ++ PInvoke/Ws2_32/ws2def.cs | 2 ++ 5 files changed, 10 insertions(+) diff --git a/PInvoke/Ws2_32/MSWSock.cs b/PInvoke/Ws2_32/MSWSock.cs index 77cc1b94..c6ca9a58 100644 --- a/PInvoke/Ws2_32/MSWSock.cs +++ b/PInvoke/Ws2_32/MSWSock.cs @@ -4,6 +4,7 @@ namespace Vanara.PInvoke; public static partial class Ws2_32 { +#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member public const int SO_CONNDATA = 0x7000; public const int SO_CONNDATALEN = 0x7004; /// @@ -35,6 +36,7 @@ public static partial class Ws2_32 public static readonly uint SIO_SOCKET_CLOSE_NOTIFY = _WSAIOW(IOC_VENDOR, 13); public static readonly uint SIO_UDP_CONNRESET = _WSAIOW(IOC_VENDOR, 12); public static readonly uint SIO_UDP_NETRESET = _WSAIOW(IOC_VENDOR, 15); +#pragma warning restore CS1591 // Missing XML comment for publicly visible type or member /// GUID value used by SIO_GET_EXTENSION_FUNCTION_POINTER to get the LPFN_WSARECVMSG (WSARecvMsg) extension function. public static readonly Guid WSAID_WSARECVMSG = new(0xf689d7c8,0x6f1f,0x436b,0x8a,0x53,0xe5,0x4f,0xe3,0x51,0xc3,0x22); diff --git a/PInvoke/Ws2_32/WinSock2.WSA.Enum.cs b/PInvoke/Ws2_32/WinSock2.WSA.Enum.cs index 1cc8eee1..283c22fd 100644 --- a/PInvoke/Ws2_32/WinSock2.WSA.Enum.cs +++ b/PInvoke/Ws2_32/WinSock2.WSA.Enum.cs @@ -381,6 +381,7 @@ public static partial class Ws2_32 WSA_FLAG_REGISTERED_IO = 0x100, } +#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member [PInvokeData("winsock2.h")] public enum WSACOMPLETIONTYPE { @@ -390,4 +391,5 @@ public static partial class Ws2_32 NSP_NOTIFY_PORT, NSP_NOTIFY_APC, } +#pragma warning restore CS1591 // Missing XML comment for publicly visible type or member } \ No newline at end of file diff --git a/PInvoke/Ws2_32/mstcpip.cs b/PInvoke/Ws2_32/mstcpip.cs index 95b7e465..8bd4e7ca 100644 --- a/PInvoke/Ws2_32/mstcpip.cs +++ b/PInvoke/Ws2_32/mstcpip.cs @@ -6,6 +6,7 @@ namespace Vanara.PInvoke; /// Functions, structures and constants from ws2_32.h. public static partial class Ws2_32 { +#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member public static readonly uint SIO_ABSORB_RTRALERT = _WSAIOW(IOC_VENDOR, 5); public static readonly uint SIO_ACQUIRE_PORT_RESERVATION = _WSAIOW(IOC_VENDOR, 100); public static readonly uint SIO_APPLY_TRANSPORT_SETTING = _WSAIOW(IOC_VENDOR, 19); @@ -44,6 +45,7 @@ public static partial class Ws2_32 public static readonly uint SIO_TCP_SET_ICW = _WSAIOW(IOC_VENDOR, 22); public static readonly uint SIO_TIMESTAMPING = _WSAIOW(IOC_VENDOR, 235); public static readonly uint SIO_UCAST_IF = _WSAIOW(IOC_VENDOR, 6); +#pragma warning restore CS1591 // Missing XML comment for publicly visible type or member /// /// The CONTROL_CHANNEL_TRIGGER_STATUS enumeration specifies the status from a query for the REAL_TIME_NOTIFICATION_CAPABILITY diff --git a/PInvoke/Ws2_32/mswsockdef.cs b/PInvoke/Ws2_32/mswsockdef.cs index 5baf3f88..6f726c7a 100644 --- a/PInvoke/Ws2_32/mswsockdef.cs +++ b/PInvoke/Ws2_32/mswsockdef.cs @@ -7,12 +7,14 @@ namespace Vanara.PInvoke; public static partial class Ws2_32 { +#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member public const int RIO_MAX_CQ_SIZE = 0x8000000; public static readonly RIO_CQ RIO_CORRUPT_CQ = (RIO_CQ)unchecked((int)0xFFFFFFFF); public static readonly RIO_BUFFERID RIO_INVALID_BUFFERID = (RIO_BUFFERID)unchecked((int)0xFFFFFFFF); public static readonly RIO_CQ RIO_INVALID_CQ = (RIO_CQ)0; public static readonly RIO_RQ RIO_INVALID_RQ = (RIO_RQ)0; public static readonly uint SIO_SET_COMPATIBILITY_MODE = _WSAIOW(IOC_VENDOR, 300); +#pragma warning restore CS1591 // Missing XML comment for publicly visible type or member /// A set of flags that modify the behavior of the RIOSendEx function. [PInvokeData("mswsockdef.h", MSDNShortId = "NC:mswsock.LPFN_RIORECEIVE")] diff --git a/PInvoke/Ws2_32/ws2def.cs b/PInvoke/Ws2_32/ws2def.cs index 2136306d..5276c001 100644 --- a/PInvoke/Ws2_32/ws2def.cs +++ b/PInvoke/Ws2_32/ws2def.cs @@ -6,6 +6,7 @@ namespace Vanara.PInvoke; public static partial class Ws2_32 { +#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member public const uint IOC_UNIX = 0x00000000; public const uint IOC_WS2 = 0x08000000; public const uint IOC_PROTOCOL = 0x10000000; @@ -38,6 +39,7 @@ public static partial class Ws2_32 public static readonly uint SIO_RESERVED_1 = _WSAIOW(IOC_WS2,26); public static readonly uint SIO_RESERVED_2 = _WSAIOW(IOC_WS2,33); public static readonly uint SIO_GET_MULTIPLE_EXTENSION_FUNCTION_POINTER = _WSAIORW(IOC_WS2, 36); +#pragma warning restore CS1591 // Missing XML comment for publicly visible type or member /// Flags that indicate options used in the GetAddrInfoW function. [PInvokeData("ws2def.h", MSDNShortId = "a4896eac-68ae-4a08-8647-36be65fe4478")]