Skip to content

Commit dd210cb

Browse files
committed
Added summary to CssReader
1 parent 01d693e commit dd210cb

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

src/TurnerSoftware.CascadingStyles/CssReader.cs

+13-1
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,20 @@
11
using System;
2-
using System.Text;
32

43
namespace TurnerSoftware.CascadingStyles
54
{
5+
/// <summary>
6+
/// Provides CSS tokenization support, closely following the <a href="https://drafts.csswg.org/css-syntax/#tokenization">official CSS specification</a>.
7+
/// </summary>
8+
/// <remarks>
9+
/// <para>
10+
/// The tokenization is not entirely standards compliant due to these caveats:
11+
/// <br/>- Escape sequences are not unescaped - you must call <see cref="TokenizationHelper.UnescapeValue(CssToken)"/> to unescape a value.
12+
/// <br/>- Numbers provided in tokens are still <see cref="ReadOnlySpan{char}"/> - you must call <see cref="TokenizationHelper.GetNumber(CssToken)"/> to get the real value.
13+
/// </para>
14+
/// <para>
15+
/// These deviations from the standard allow the tokenizer to be allocation-free in its processing.
16+
/// </para>
17+
/// </remarks>
618
public ref struct CssReader
719
{
820
public const char EndOfFile = char.MaxValue;

0 commit comments

Comments
 (0)