From f09b521e334fcdf6c279466724a2e6b8f4642cce Mon Sep 17 00:00:00 2001 From: James Ko Date: Mon, 4 Jul 2016 15:48:20 -0400 Subject: [PATCH] [UnicodeEncoding] Remove unncessary comments --- src/mscorlib/src/System/Text/ASCIIEncoding.cs | 2 +- .../src/System/Text/UnicodeEncoding.cs | 76 ++++--------------- 2 files changed, 16 insertions(+), 62 deletions(-) diff --git a/src/mscorlib/src/System/Text/ASCIIEncoding.cs b/src/mscorlib/src/System/Text/ASCIIEncoding.cs index 1b499a6e954e..bf94b81e4d48 100644 --- a/src/mscorlib/src/System/Text/ASCIIEncoding.cs +++ b/src/mscorlib/src/System/Text/ASCIIEncoding.cs @@ -154,7 +154,7 @@ public override String GetString(byte[] bytes, int byteIndex, int byteCount) return EncodingForwarder.GetString(this, bytes, byteIndex, byteCount); } - // End of overriden methods which use EncodingForwarder + // End of overridden methods which use EncodingForwarder // GetByteCount // Note: We start by assuming that the output will be the same as count. Having diff --git a/src/mscorlib/src/System/Text/UnicodeEncoding.cs b/src/mscorlib/src/System/Text/UnicodeEncoding.cs index a7558f537016..bab8fd24e343 100644 --- a/src/mscorlib/src/System/Text/UnicodeEncoding.cs +++ b/src/mscorlib/src/System/Text/UnicodeEncoding.cs @@ -77,20 +77,22 @@ internal override void SetDefaultFallbacks() } } - // - // The following methods are copied from EncodingNLS.cs. - // Unfortunately EncodingNLS.cs is internal and we're public, so we have to reimpliment them here. - // These should be kept in sync for the following classes: - // EncodingNLS, UTF7Encoding, UTF8Encoding, UTF32Encoding, ASCIIEncoding, UnicodeEncoding - // + // NOTE: Many methods in this class forward to EncodingForwarder for + // validating arguments/wrapping the unsafe methods in this class + // which do the actual work. That class contains + // shared logic for doing this which is used by + // ASCIIEncoding, EncodingNLS, UnicodeEncoding, UTF32Encoding, + // UTF7Encoding, and UTF8Encoding. + // The reason the code is separated out into a static class, rather + // than a base class which overrides all of these methods for us + // (which is what EncodingNLS is for internal Encodings) is because + // that's really more of an implementation detail so it's internal. + // At the same time, C# doesn't allow a public class subclassing an + // internal/private one, so we end up having to re-override these + // methods in all of the public Encodings + EncodingNLS. // Returns the number of bytes required to encode a range of characters in // a character array. - // - // All of our public Encodings that don't use EncodingNLS must have this (including EncodingNLS) - // So if you fix this, fix the others. Currently those include: - // EncodingNLS, UTF7Encoding, UTF8Encoding, UTF32Encoding, ASCIIEncoding, UnicodeEncoding - // parent method is safe [System.Security.SecuritySafeCritical] // auto-generated public override int GetByteCount(char[] chars, int index, int count) @@ -98,21 +100,12 @@ public override int GetByteCount(char[] chars, int index, int count) return EncodingForwarder.GetByteCount(this, chars, index, count); } - // All of our public Encodings that don't use EncodingNLS must have this (including EncodingNLS) - // So if you fix this, fix the others. Currently those include: - // EncodingNLS, UTF7Encoding, UTF8Encoding, UTF32Encoding, ASCIIEncoding, UnicodeEncoding - // parent method is safe - [System.Security.SecuritySafeCritical] // auto-generated public override int GetByteCount(String s) { return EncodingForwarder.GetByteCount(this, s); } - // All of our public Encodings that don't use EncodingNLS must have this (including EncodingNLS) - // So if you fix this, fix the others. Currently those include: - // EncodingNLS, UTF7Encoding, UTF8Encoding, UTF32Encoding, ASCIIEncoding, UnicodeEncoding - [System.Security.SecurityCritical] // auto-generated [CLSCompliant(false)] [System.Runtime.InteropServices.ComVisible(false)] @@ -121,11 +114,6 @@ public override unsafe int GetByteCount(char* chars, int count) return EncodingForwarder.GetByteCount(this, chars, count); } - // Parent method is safe. - // All of our public Encodings that don't use EncodingNLS must have this (including EncodingNLS) - // So if you fix this, fix the others. Currently those include: - // EncodingNLS, UTF7Encoding, UTF8Encoding, UTF32Encoding, ASCIIEncoding, UnicodeEncoding - [System.Security.SecuritySafeCritical] // auto-generated public override int GetBytes(String s, int charIndex, int charCount, byte[] bytes, int byteIndex) @@ -141,11 +129,6 @@ public override int GetBytes(String s, int charIndex, int charCount, // Alternatively, the GetMaxByteCount method can be used to // determine the maximum number of bytes that will be produced for a given // number of characters, regardless of the actual character values. - // - // All of our public Encodings that don't use EncodingNLS must have this (including EncodingNLS) - // So if you fix this, fix the others. Currently those include: - // EncodingNLS, UTF7Encoding, UTF8Encoding, UTF32Encoding, ASCIIEncoding, UnicodeEncoding - // parent method is safe [System.Security.SecuritySafeCritical] // auto-generated public override int GetBytes(char[] chars, int charIndex, int charCount, @@ -154,10 +137,6 @@ public override int GetBytes(char[] chars, int charIndex, int charCount, return EncodingForwarder.GetBytes(this, chars, charIndex, charCount, bytes, byteIndex); } - // All of our public Encodings that don't use EncodingNLS must have this (including EncodingNLS) - // So if you fix this, fix the others. Currently those include: - // EncodingNLS, UTF7Encoding, UTF8Encoding, UTF32Encoding, ASCIIEncoding, UnicodeEncoding - [System.Security.SecurityCritical] // auto-generated [CLSCompliant(false)] [System.Runtime.InteropServices.ComVisible(false)] @@ -168,11 +147,6 @@ public override unsafe int GetBytes(char* chars, int charCount, byte* bytes, int // Returns the number of characters produced by decoding a range of bytes // in a byte array. - // - // All of our public Encodings that don't use EncodingNLS must have this (including EncodingNLS) - // So if you fix this, fix the others. Currently those include: - // EncodingNLS, UTF7Encoding, UTF8Encoding, UTF32Encoding, ASCIIEncoding, UnicodeEncoding - // parent method is safe [System.Security.SecuritySafeCritical] // auto-generated public override int GetCharCount(byte[] bytes, int index, int count) @@ -180,10 +154,6 @@ public override int GetCharCount(byte[] bytes, int index, int count) return EncodingForwarder.GetCharCount(this, bytes, index, count); } - // All of our public Encodings that don't use EncodingNLS must have this (including EncodingNLS) - // So if you fix this, fix the others. Currently those include: - // EncodingNLS, UTF7Encoding, UTF8Encoding, UTF32Encoding, ASCIIEncoding, UnicodeEncoding - [System.Security.SecurityCritical] // auto-generated [CLSCompliant(false)] [System.Runtime.InteropServices.ComVisible(false)] @@ -192,11 +162,6 @@ public override unsafe int GetCharCount(byte* bytes, int count) return EncodingForwarder.GetCharCount(this, bytes, count); } - // All of our public Encodings that don't use EncodingNLS must have this (including EncodingNLS) - // So if you fix this, fix the others. Currently those include: - // EncodingNLS, UTF7Encoding, UTF8Encoding, UTF32Encoding, ASCIIEncoding, UnicodeEncoding - // parent method is safe - [System.Security.SecuritySafeCritical] // auto-generated public override int GetChars(byte[] bytes, int byteIndex, int byteCount, char[] chars, int charIndex) @@ -204,10 +169,6 @@ public override int GetChars(byte[] bytes, int byteIndex, int byteCount, return EncodingForwarder.GetChars(this, bytes, byteIndex, byteCount, chars, charIndex); } - // All of our public Encodings that don't use EncodingNLS must have this (including EncodingNLS) - // So if you fix this, fix the others. Currently those include: - // EncodingNLS, UTF7Encoding, UTF8Encoding, UTF32Encoding, ASCIIEncoding, UnicodeEncoding - [System.Security.SecurityCritical] // auto-generated [CLSCompliant(false)] [System.Runtime.InteropServices.ComVisible(false)] @@ -218,11 +179,6 @@ public unsafe override int GetChars(byte* bytes, int byteCount, char* chars, int // Returns a string containing the decoded representation of a range of // bytes in a byte array. - // - // All of our public Encodings that don't use EncodingNLS must have this (including EncodingNLS) - // So if you fix this, fix the others. Currently those include: - // EncodingNLS, UTF7Encoding, UTF8Encoding, UTF32Encoding, ASCIIEncoding, UnicodeEncoding - // parent method is safe [System.Security.SecuritySafeCritical] // auto-generated [System.Runtime.InteropServices.ComVisible(false)] @@ -230,10 +186,8 @@ public override String GetString(byte[] bytes, int index, int count) { return EncodingForwarder.GetString(this, bytes, index, count); } - - // - // End of standard methods copied from EncodingNLS.cs - // + + // End of overridden methods which use EncodingForwarder [System.Security.SecurityCritical] // auto-generated internal override unsafe int GetByteCount(char* chars, int count, EncoderNLS encoder)