Code comment cleanup.
This commit is contained in:
parent
332900b175
commit
543e0f4863
|
|
@ -28,6 +28,7 @@ namespace Microsoft.Framework.WebEncoders
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Instantiates an encoder using <see cref="UnicodeRanges.BasicLatin"/> as its allow list.
|
/// 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>
|
/// </summary>
|
||||||
public HtmlEncoder()
|
public HtmlEncoder()
|
||||||
: this(HtmlUnicodeEncoder.BasicLatin)
|
: this(HtmlUnicodeEncoder.BasicLatin)
|
||||||
|
|
@ -36,7 +37,8 @@ namespace Microsoft.Framework.WebEncoders
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Instantiates an encoder specifying which Unicode character ranges are allowed to
|
/// 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>
|
/// </summary>
|
||||||
public HtmlEncoder(params UnicodeRange[] allowedRanges)
|
public HtmlEncoder(params UnicodeRange[] allowedRanges)
|
||||||
: this(new HtmlUnicodeEncoder(new CodePointFilter(allowedRanges)))
|
: this(new HtmlUnicodeEncoder(new CodePointFilter(allowedRanges)))
|
||||||
|
|
@ -44,7 +46,9 @@ namespace Microsoft.Framework.WebEncoders
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
/// <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>
|
/// </summary>
|
||||||
public HtmlEncoder(ICodePointFilter filter)
|
public HtmlEncoder(ICodePointFilter filter)
|
||||||
: this(new HtmlUnicodeEncoder(CodePointFilter.Wrap(filter)))
|
: this(new HtmlUnicodeEncoder(CodePointFilter.Wrap(filter)))
|
||||||
|
|
|
||||||
|
|
@ -28,6 +28,7 @@ namespace Microsoft.Framework.WebEncoders
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Instantiates an encoder using <see cref="UnicodeRanges.BasicLatin"/> as its allow list.
|
/// 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>
|
/// </summary>
|
||||||
public JavaScriptStringEncoder()
|
public JavaScriptStringEncoder()
|
||||||
: this(JavaScriptStringUnicodeEncoder.BasicLatin)
|
: this(JavaScriptStringUnicodeEncoder.BasicLatin)
|
||||||
|
|
@ -36,7 +37,8 @@ namespace Microsoft.Framework.WebEncoders
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Instantiates an encoder specifying which Unicode character ranges are allowed to
|
/// 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>
|
/// </summary>
|
||||||
public JavaScriptStringEncoder(params UnicodeRange[] allowedRanges)
|
public JavaScriptStringEncoder(params UnicodeRange[] allowedRanges)
|
||||||
: this(new JavaScriptStringUnicodeEncoder(new CodePointFilter(allowedRanges)))
|
: this(new JavaScriptStringUnicodeEncoder(new CodePointFilter(allowedRanges)))
|
||||||
|
|
@ -44,7 +46,9 @@ namespace Microsoft.Framework.WebEncoders
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
/// <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>
|
/// </summary>
|
||||||
public JavaScriptStringEncoder(ICodePointFilter filter)
|
public JavaScriptStringEncoder(ICodePointFilter filter)
|
||||||
: this(new JavaScriptStringUnicodeEncoder(CodePointFilter.Wrap(filter)))
|
: this(new JavaScriptStringUnicodeEncoder(CodePointFilter.Wrap(filter)))
|
||||||
|
|
|
||||||
|
|
@ -28,6 +28,7 @@ namespace Microsoft.Framework.WebEncoders
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Instantiates an encoder using <see cref="UnicodeRanges.BasicLatin"/> as its allow list.
|
/// 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>
|
/// </summary>
|
||||||
public UrlEncoder()
|
public UrlEncoder()
|
||||||
: this(UrlUnicodeEncoder.BasicLatin)
|
: this(UrlUnicodeEncoder.BasicLatin)
|
||||||
|
|
@ -36,7 +37,8 @@ namespace Microsoft.Framework.WebEncoders
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Instantiates an encoder specifying which Unicode character ranges are allowed to
|
/// 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>
|
/// </summary>
|
||||||
public UrlEncoder(params UnicodeRange[] allowedRanges)
|
public UrlEncoder(params UnicodeRange[] allowedRanges)
|
||||||
: this(new UrlUnicodeEncoder(new CodePointFilter(allowedRanges)))
|
: this(new UrlUnicodeEncoder(new CodePointFilter(allowedRanges)))
|
||||||
|
|
@ -44,7 +46,9 @@ namespace Microsoft.Framework.WebEncoders
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
/// <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>
|
/// </summary>
|
||||||
public UrlEncoder(ICodePointFilter filter)
|
public UrlEncoder(ICodePointFilter filter)
|
||||||
: this(new UrlUnicodeEncoder(CodePointFilter.Wrap(filter)))
|
: this(new UrlUnicodeEncoder(CodePointFilter.Wrap(filter)))
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue