Skip to content

Add missing docs for RegexRunner.Scan #72453

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
stephentoub merged 1 commit into from
Jul 19, 2022
Merged

Add missing docs for RegexRunner.Scan #72453

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions ...ibraries/System.Text.RegularExpressions/src/System/Text/RegularExpressions/RegexRunner.cs
View file
Open in desktop
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