diff --git a/src/Microsoft.Framework.WebEncoders/HtmlEncoder.cs b/src/Microsoft.Framework.WebEncoders/HtmlEncoder.cs index 6331189706..8f6c976dd1 100644 --- a/src/Microsoft.Framework.WebEncoders/HtmlEncoder.cs +++ b/src/Microsoft.Framework.WebEncoders/HtmlEncoder.cs @@ -28,6 +28,7 @@ namespace Microsoft.Framework.WebEncoders /// /// Instantiates an encoder using as its allow list. + /// Any character not in the range will be escaped. /// public HtmlEncoder() : this(HtmlUnicodeEncoder.BasicLatin) @@ -36,7 +37,8 @@ namespace Microsoft.Framework.WebEncoders /// /// Instantiates an encoder specifying which Unicode character ranges are allowed to - /// pass through the encoder unescaped. + /// pass through the encoder unescaped. Any character not in the set of ranges specified + /// by will be escaped. /// public HtmlEncoder(params UnicodeRange[] allowedRanges) : this(new HtmlUnicodeEncoder(new CodePointFilter(allowedRanges))) @@ -44,7 +46,9 @@ namespace Microsoft.Framework.WebEncoders } /// - /// Instantiates an encoder using a custom code point filter. + /// Instantiates an encoder using a custom code point filter. Any character not in the + /// set returned by 's + /// method will be escaped. /// public HtmlEncoder(ICodePointFilter filter) : this(new HtmlUnicodeEncoder(CodePointFilter.Wrap(filter))) diff --git a/src/Microsoft.Framework.WebEncoders/JavaScriptStringEncoder.cs b/src/Microsoft.Framework.WebEncoders/JavaScriptStringEncoder.cs index 26bc175b81..acc9241b63 100644 --- a/src/Microsoft.Framework.WebEncoders/JavaScriptStringEncoder.cs +++ b/src/Microsoft.Framework.WebEncoders/JavaScriptStringEncoder.cs @@ -28,6 +28,7 @@ namespace Microsoft.Framework.WebEncoders /// /// Instantiates an encoder using as its allow list. + /// Any character not in the range will be escaped. /// public JavaScriptStringEncoder() : this(JavaScriptStringUnicodeEncoder.BasicLatin) @@ -36,7 +37,8 @@ namespace Microsoft.Framework.WebEncoders /// /// Instantiates an encoder specifying which Unicode character ranges are allowed to - /// pass through the encoder unescaped. + /// pass through the encoder unescaped. Any character not in the set of ranges specified + /// by will be escaped. /// public JavaScriptStringEncoder(params UnicodeRange[] allowedRanges) : this(new JavaScriptStringUnicodeEncoder(new CodePointFilter(allowedRanges))) @@ -44,7 +46,9 @@ namespace Microsoft.Framework.WebEncoders } /// - /// Instantiates an encoder using a custom code point filter. + /// Instantiates an encoder using a custom code point filter. Any character not in the + /// set returned by 's + /// method will be escaped. /// public JavaScriptStringEncoder(ICodePointFilter filter) : this(new JavaScriptStringUnicodeEncoder(CodePointFilter.Wrap(filter))) diff --git a/src/Microsoft.Framework.WebEncoders/UrlEncoder.cs b/src/Microsoft.Framework.WebEncoders/UrlEncoder.cs index 3f487e2533..dbda74917d 100644 --- a/src/Microsoft.Framework.WebEncoders/UrlEncoder.cs +++ b/src/Microsoft.Framework.WebEncoders/UrlEncoder.cs @@ -28,6 +28,7 @@ namespace Microsoft.Framework.WebEncoders /// /// Instantiates an encoder using as its allow list. + /// Any character not in the range will be escaped. /// public UrlEncoder() : this(UrlUnicodeEncoder.BasicLatin) @@ -36,7 +37,8 @@ namespace Microsoft.Framework.WebEncoders /// /// Instantiates an encoder specifying which Unicode character ranges are allowed to - /// pass through the encoder unescaped. + /// pass through the encoder unescaped. Any character not in the set of ranges specified + /// by will be escaped. /// public UrlEncoder(params UnicodeRange[] allowedRanges) : this(new UrlUnicodeEncoder(new CodePointFilter(allowedRanges))) @@ -44,7 +46,9 @@ namespace Microsoft.Framework.WebEncoders } /// - /// Instantiates an encoder using a custom code point filter. + /// Instantiates an encoder using a custom code point filter. Any character not in the + /// set returned by 's + /// method will be escaped. /// public UrlEncoder(ICodePointFilter filter) : this(new UrlUnicodeEncoder(CodePointFilter.Wrap(filter)))