Skip to content
This repository was archived by the owner on Nov 20, 2018. It is now read-only.

Commit 543e0f4

Browse files
Code comment cleanup.
1 parent 332900b commit 543e0f4

File tree

3 files changed

+18
-6
lines changed

3 files changed

+18
-6
lines changed

src/Microsoft.Framework.WebEncoders/HtmlEncoder.cs

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ public unsafe sealed class HtmlEncoder : IHtmlEncoder
2828

2929
/// <summary>
3030
/// Instantiates an encoder using <see cref="UnicodeRanges.BasicLatin"/> as its allow list.
31+
/// Any character not in the <see cref="UnicodeRanges.BasicLatin"/> range will be escaped.
3132
/// </summary>
3233
public HtmlEncoder()
3334
: this(HtmlUnicodeEncoder.BasicLatin)
@@ -36,15 +37,18 @@ public HtmlEncoder()
3637

3738
/// <summary>
3839
/// Instantiates an encoder specifying which Unicode character ranges are allowed to
39-
/// pass through the encoder unescaped.
40+
/// pass through the encoder unescaped. Any character not in the set of ranges specified
41+
/// by <paramref name="allowedRanges"/> will be escaped.
4042
/// </summary>
4143
public HtmlEncoder(params UnicodeRange[] allowedRanges)
4244
: this(new HtmlUnicodeEncoder(new CodePointFilter(allowedRanges)))
4345
{
4446
}
4547

4648
/// <summary>
47-
/// Instantiates an encoder using a custom code point filter.
49+
/// Instantiates an encoder using a custom code point filter. Any character not in the
50+
/// set returned by <paramref name="filter"/>'s <see cref="ICodePointFilter.GetAllowedCodePoints"/>
51+
/// method will be escaped.
4852
/// </summary>
4953
public HtmlEncoder(ICodePointFilter filter)
5054
: this(new HtmlUnicodeEncoder(CodePointFilter.Wrap(filter)))

src/Microsoft.Framework.WebEncoders/JavaScriptStringEncoder.cs

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ public sealed class JavaScriptStringEncoder : IJavaScriptStringEncoder
2828

2929
/// <summary>
3030
/// Instantiates an encoder using <see cref="UnicodeRanges.BasicLatin"/> as its allow list.
31+
/// Any character not in the <see cref="UnicodeRanges.BasicLatin"/> range will be escaped.
3132
/// </summary>
3233
public JavaScriptStringEncoder()
3334
: this(JavaScriptStringUnicodeEncoder.BasicLatin)
@@ -36,15 +37,18 @@ public JavaScriptStringEncoder()
3637

3738
/// <summary>
3839
/// Instantiates an encoder specifying which Unicode character ranges are allowed to
39-
/// pass through the encoder unescaped.
40+
/// pass through the encoder unescaped. Any character not in the set of ranges specified
41+
/// by <paramref name="allowedRanges"/> will be escaped.
4042
/// </summary>
4143
public JavaScriptStringEncoder(params UnicodeRange[] allowedRanges)
4244
: this(new JavaScriptStringUnicodeEncoder(new CodePointFilter(allowedRanges)))
4345
{
4446
}
4547

4648
/// <summary>
47-
/// Instantiates an encoder using a custom code point filter.
49+
/// Instantiates an encoder using a custom code point filter. Any character not in the
50+
/// set returned by <paramref name="filter"/>'s <see cref="ICodePointFilter.GetAllowedCodePoints"/>
51+
/// method will be escaped.
4852
/// </summary>
4953
public JavaScriptStringEncoder(ICodePointFilter filter)
5054
: this(new JavaScriptStringUnicodeEncoder(CodePointFilter.Wrap(filter)))

src/Microsoft.Framework.WebEncoders/UrlEncoder.cs

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ public sealed class UrlEncoder : IUrlEncoder
2828

2929
/// <summary>
3030
/// Instantiates an encoder using <see cref="UnicodeRanges.BasicLatin"/> as its allow list.
31+
/// Any character not in the <see cref="UnicodeRanges.BasicLatin"/> range will be escaped.
3132
/// </summary>
3233
public UrlEncoder()
3334
: this(UrlUnicodeEncoder.BasicLatin)
@@ -36,15 +37,18 @@ public UrlEncoder()
3637

3738
/// <summary>
3839
/// Instantiates an encoder specifying which Unicode character ranges are allowed to
39-
/// pass through the encoder unescaped.
40+
/// pass through the encoder unescaped. Any character not in the set of ranges specified
41+
/// by <paramref name="allowedRanges"/> will be escaped.
4042
/// </summary>
4143
public UrlEncoder(params UnicodeRange[] allowedRanges)
4244
: this(new UrlUnicodeEncoder(new CodePointFilter(allowedRanges)))
4345
{
4446
}
4547

4648
/// <summary>
47-
/// Instantiates an encoder using a custom code point filter.
49+
/// Instantiates an encoder using a custom code point filter. Any character not in the
50+
/// set returned by <paramref name="filter"/>'s <see cref="ICodePointFilter.GetAllowedCodePoints"/>
51+
/// method will be escaped.
4852
/// </summary>
4953
public UrlEncoder(ICodePointFilter filter)
5054
: this(new UrlUnicodeEncoder(CodePointFilter.Wrap(filter)))

0 commit comments

Comments
 (0)