Skip to content

Commit

Permalink
Add missing docs for RegexRunner.Scan (#72453)
Browse files Browse the repository at this point in the history
  • Loading branch information
stephentoub authored Jul 19, 2022
1 parent 073497a commit 912b04d
Showing 1 changed file with 7 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,13 @@ public abstract class RegexRunner

protected RegexRunner() { }

/// <summary>Used by a <see cref="Regex"/> object to scan the input <paramref name="text"/> looking for the next match.</summary>
/// <remarks>This API supports the product infrastructure and is not intended to be used directly from your code.</remarks>
/// <param name="text">The text to scan for a pattern match.</param>
/// <exception cref="NotSupportedException">
/// <see cref="ReadOnlySpan{T}"/>-based <see cref="Regex"/> methods are not supported from <see cref="Regex"/>-derived types
/// generated by Regex.CompileToAssembly.
/// </exception>
protected internal virtual void Scan(ReadOnlySpan<char> text)
{
// This base implementation is overridden by all of the built-in engines and by all source-generated
Expand Down

0 comments on commit 912b04d

Please sign in to comment.