From 779c45746b7cb7a5ea2b83e686d7e9e8e8e98817 Mon Sep 17 00:00:00 2001 From: Stanislav Ushakov Date: Mon, 17 Dec 2018 20:15:22 +0300 Subject: [PATCH] Fixed suppressed XML documentation errors (dotnet/corefx#34020) * Fixed XML documentation tags for CoreFx.Private.TestUtilities * Fixed XML documentation tags for System.Diagnostics.Process * Fixed XML documentation tags for System.ComponentModel.Composition * Fixed XML documentation tags for System.ComponentModel.Primitives * Fixed XML documentation tags for System.ComponentModel.TypeConverter * Fixed XML documentation tags for System.Data.Common * Fixed XML documentation tags for System.Data.SqlClient * Fixed XML documentation tags for System.Diagnostics.PerformanceCounter * Fixed XML documentation tags for System.Diagnostics.StackTrace * Fixed XML documentation for System.Diagnostics.TraceSource * Fixed XML documentation for System.IO.Compression.ZipFile * Fixed XML documentation for System.IO.Compression * Fixed XMl documentation reference according to review notes * Fixed XML documentation tags for System.IO.MemoryMappedFiles * Fixed XML documentation tags for System.IO.Pipes * Fixed XML documentation tag for OSX interop in System.Diagnostics.Process * Fixed XML documentation tags for CoreFx.Private.TestUtilities for Unix * Fixed XML documentation tags for System.Linq.Expressions * Fixed XML documentation for System.Linq.Parallel * Fixed XML documentationt ags for System.Linq * Fixed XML documentation tags for System.Management * Fixed XMl documentation tags for System.Net.Http (left CS1573) * Fixed XMl documentation tags for System.Net.Mail * Fixed XML documentation tags for System.Net.NameResolution * Fixed XML documentation tags for System.Net.Primitives - added T prefix for Socket as Primitives do not reference System.Net.Sockets * Fixed XML documentation tags for System.Net.Sockets * Fixed XML documentation tags for Unix interop files * Fixed XML documentation tags for System.Net.Http (Unix) * Fixed XML documentation tags for PlatformDetection.Unix.cs according to review notes * Fixed XML documentation tags for OSX interop * Ignore CS1574 for System.Linq as there is no ConcatIterator{TSource}.ToList for uap. * Fixed XML documentation tags for FreeBSD interop * Fixed XML documentation tags for System.Net.WebSockets * Fixed XMLm documentation tags for System.Transactions.Local * Fixed XML documentation for System.Security.Principal.Windows * Fixed XML documentation for System.Drawing.Common * Fixed XML documentation for System.Net.NetworkInformation * Fixed XML documentation tags for System.Private.XML (left CS1589) * Fixed XML documentation tags for System.Security.Cryptography * Fixed XML documentation for System.Runtime.WindowsRuntime * Fixed XML documentation tags for System.Security.Cryptography.Xml * Fixed XML documentation tags for System.Security.Cryptography.Primitives CS3016 was added by mistake as part of #32934 so I removed it. * Fixed XML documentation tags for System.Linq: added M to ToList method as it is not accessible by uap builds. * Fixed XML documentation tags for System.IO.FileSystem * Fixed XML documentation tags for System.Security.Cryptography.* * Fixed XML documentation for System.IO.Ports * Fixed XML documentation tags for System.Private.Reflection.Metadata.Ecma335 * Fixed XML documentation tags for System.Windows.Extensions * Fixed XMl documentation tags for System.Console * Fixed XML documentation for System.IO.FileSystem.DriveInfo * Fixed XML documentation tags for System.Runtime.Extensions * Fixed XML documentation tags for System.Drawing.Primitives. Left CS1589 as there is no 'doc\KnownColor.uex' file. * Fixed XMl documentation for System.Runtime.WindowsRuntime. Had to add M prefix to 'Windows.Foundation.IAsyncAction' as Windows.Foundation is not accessible at compilation time. * Fixed XML documentation tags for System.Private.Xml * Fixed XML documentation tags for System.Private.Reflection.Metadata.Ecma335 Had to add a prefixes to: 'T:System.Collections.Immutable' and 'M:Enumerable.ToArray{TSource}' as they are not available for uap at compilation time. * Fixed XML documentation tags for System.Net.WebSockets.WebSocketProtocol * Fixed XML documentation tags for System.Net.WebSockets.WebSocketProtocol * XML documentation tags fixes: changes after review. Signed-off-by: dotnet-bot --- src/System.Private.CoreLib/shared/System/IO/PathHelper.Windows.cs | 1 + src/System.Private.CoreLib/shared/System/IO/PathInternal.cs | 3 +++ 2 files changed, 4 insertions(+) diff --git a/src/System.Private.CoreLib/shared/System/IO/PathHelper.Windows.cs b/src/System.Private.CoreLib/shared/System/IO/PathHelper.Windows.cs index bada2f5..a30ead1 100644 --- a/src/System.Private.CoreLib/shared/System/IO/PathHelper.Windows.cs +++ b/src/System.Private.CoreLib/shared/System/IO/PathHelper.Windows.cs @@ -69,6 +69,7 @@ namespace System.IO /// Calls GetFullPathName on the given path. /// /// The path name. MUST be null terminated after the span. + /// Builder that will store the result. private static void GetFullPathName(ReadOnlySpan path, ref ValueStringBuilder builder) { // If the string starts with an extended prefix we would need to remove it from the path before we call GetFullPathName as diff --git a/src/System.Private.CoreLib/shared/System/IO/PathInternal.cs b/src/System.Private.CoreLib/shared/System/IO/PathInternal.cs index 1b08a26..c6e1de4 100644 --- a/src/System.Private.CoreLib/shared/System/IO/PathInternal.cs +++ b/src/System.Private.CoreLib/shared/System/IO/PathInternal.cs @@ -113,6 +113,7 @@ namespace System.IO /// /// Try to remove relative segments from the given path (without combining with a root). /// + /// Input path /// The length of the root of the given path internal static string RemoveRelativeSegments(string path, int rootLength) { @@ -131,7 +132,9 @@ namespace System.IO /// /// Try to remove relative segments from the given path (without combining with a root). /// + /// Input path /// The length of the root of the given path + /// String builder that will store the result /// "true" if the path was modified internal static bool RemoveRelativeSegments(ReadOnlySpan path, int rootLength, ref ValueStringBuilder sb) { -- 2.7.4