Code comment cleanup.

This commit is contained in:
Levi B 2015-03-10 18:06:59 -07:00
parent 332900b175
commit 543e0f4863
3 changed files with 18 additions and 6 deletions

View File

@ -28,6 +28,7 @@ namespace Microsoft.Framework.WebEncoders
/// <summary>
/// Instantiates an encoder using <see cref="UnicodeRanges.BasicLatin"/> as its allow list.
/// Any character not in the <see cref="UnicodeRanges.BasicLatin"/> range will be escaped.
/// </summary>
public HtmlEncoder()
: this(HtmlUnicodeEncoder.BasicLatin)
@ -36,7 +37,8 @@ namespace Microsoft.Framework.WebEncoders
/// <summary>
/// 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 <paramref name="allowedRanges"/> will be escaped.
/// </summary>
public HtmlEncoder(params UnicodeRange[] allowedRanges)
: this(new HtmlUnicodeEncoder(new CodePointFilter(allowedRanges)))
@ -44,7 +46,9 @@ namespace Microsoft.Framework.WebEncoders
}
/// <summary>
/// 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 <paramref name="filter"/>'s <see cref="ICodePointFilter.GetAllowedCodePoints"/>
/// method will be escaped.
/// </summary>
public HtmlEncoder(ICodePointFilter filter)
: this(new HtmlUnicodeEncoder(CodePointFilter.Wrap(filter)))

View File

@ -28,6 +28,7 @@ namespace Microsoft.Framework.WebEncoders
/// <summary>
/// Instantiates an encoder using <see cref="UnicodeRanges.BasicLatin"/> as its allow list.
/// Any character not in the <see cref="UnicodeRanges.BasicLatin"/> range will be escaped.
/// </summary>
public JavaScriptStringEncoder()
: this(JavaScriptStringUnicodeEncoder.BasicLatin)
@ -36,7 +37,8 @@ namespace Microsoft.Framework.WebEncoders
/// <summary>
/// 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 <paramref name="allowedRanges"/> will be escaped.
/// </summary>
public JavaScriptStringEncoder(params UnicodeRange[] allowedRanges)
: this(new JavaScriptStringUnicodeEncoder(new CodePointFilter(allowedRanges)))
@ -44,7 +46,9 @@ namespace Microsoft.Framework.WebEncoders
}
/// <summary>
/// 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 <paramref name="filter"/>'s <see cref="ICodePointFilter.GetAllowedCodePoints"/>
/// method will be escaped.
/// </summary>
public JavaScriptStringEncoder(ICodePointFilter filter)
: this(new JavaScriptStringUnicodeEncoder(CodePointFilter.Wrap(filter)))

View File

@ -28,6 +28,7 @@ namespace Microsoft.Framework.WebEncoders
/// <summary>
/// Instantiates an encoder using <see cref="UnicodeRanges.BasicLatin"/> as its allow list.
/// Any character not in the <see cref="UnicodeRanges.BasicLatin"/> range will be escaped.
/// </summary>
public UrlEncoder()
: this(UrlUnicodeEncoder.BasicLatin)
@ -36,7 +37,8 @@ namespace Microsoft.Framework.WebEncoders
/// <summary>
/// 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 <paramref name="allowedRanges"/> will be escaped.
/// </summary>
public UrlEncoder(params UnicodeRange[] allowedRanges)
: this(new UrlUnicodeEncoder(new CodePointFilter(allowedRanges)))
@ -44,7 +46,9 @@ namespace Microsoft.Framework.WebEncoders
}
/// <summary>
/// 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 <paramref name="filter"/>'s <see cref="ICodePointFilter.GetAllowedCodePoints"/>
/// method will be escaped.
/// </summary>
public UrlEncoder(ICodePointFilter filter)
: this(new UrlUnicodeEncoder(CodePointFilter.Wrap(filter)))