Skip to content

Commit

Permalink
Update documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
teo-tsirpanis committed Aug 6, 2023
1 parent b93d5df commit fdd7ba7
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 8 deletions.
12 changes: 6 additions & 6 deletions src/FarkleNeo/CharParser.cs
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@ namespace Farkle;
/// <typeparam name="T">The type of objects the parser produces in case of success.</typeparam>
/// <remarks>
/// <para>
/// This class extends <see cref="IParser{TChar, T}"/> with features like
/// swapping the parser's <see cref="Tokenizer{TChar}"/> and
/// <see cref="ISemanticProvider{TChar, T}"/>, getting the parser's
/// <see cref="Grammar"/> and representing parsers that will always fail
/// because of problems with the grammar.
/// This class is the replacement of the <c>RuntimeFarkle</c> class of Farkle 6.
/// It extends <see cref="IParser{TChar, T}"/> with features likeswapping the parser's
/// <see cref="Tokenizer{TChar}"/> and <see cref="ISemanticProvider{TChar, T}"/>,
/// getting the parser's <see cref="Grammar"/> and representing parsers that will
/// always fail because of problems with the grammar.
/// </para>
/// <para>
/// <see cref="CharParser{T}"/>s are immutable, stateless and thread-safe.
Expand Down Expand Up @@ -87,7 +87,7 @@ private protected virtual CharParser<TNew> WithSemanticProviderCore<TNew>(Func<I
/// The error can be retrieved by parsing an empty string.
/// </para>
/// <para>
/// If the problem is in the grammar's lecical analysis tables,
/// If the problem is in the grammar's lexical analysis tables,
/// the parser can be fixed by changing the tokenizer.
/// </para>
/// </remarks>
Expand Down
2 changes: 1 addition & 1 deletion src/FarkleNeo/Parser/ParserInputReader.cs
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ namespace Farkle.Parser;
/// <see cref="char"/> or <see cref="byte"/> (not supported by Farkle's built-in
/// parsers).</typeparam>
/// <remarks>
/// This type is the replacement of the <code>Farkle.IO.CharStream</code> code of Farkle 6.
/// This type is the replacement of the <c>Farkle.IO.CharStream</c> class of Farkle 6.
/// Contrary to that, this is a mutable <c>ref struct</c> that must be passed around by
/// reference and cannot be placed on the heap.
/// </remarks>
Expand Down
6 changes: 5 additions & 1 deletion src/FarkleNeo/Parser/Tokenizers/ChainedTokenizerBuilder.cs
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,11 @@ public ChainedTokenizerBuilder<TChar> Add(ChainedTokenizerBuilder<TChar> builder
/// given in <see cref="Create(Func{IGrammarProvider, Tokenizer{TChar}})"/>
/// and <see cref="Add(Func{IGrammarProvider, Tokenizer{TChar}})"/>.
/// This parameter is optional if no such delegates have been added.</param>
/// <param name="defaultTokenizer">The tokenizer to use in place of <see cref="CreateDefault"/> or <see cref="AddDefault"/>.</param>
/// <param name="defaultTokenizer">The tokenizer to use in place of
/// <see cref="CreateDefault"/> or <see cref="AddDefault"/>.</param>
/// <exception cref="InvalidOperationException"> <paramref name="grammar"/> is <see langword="null"/>
/// and the builder contains a grammar-dependent tokenizer, or <paramref name="defaultTokenizer"/>
/// is <see langwword="null"/> and the builder contains the default tokenizer.</exception>
public Tokenizer<TChar> Build(IGrammarProvider? grammar = null, Tokenizer<TChar>? defaultTokenizer = null)
{
var builder = ImmutableArray.CreateBuilder<Tokenizer<TChar>>(_items.Count);
Expand Down

0 comments on commit fdd7ba7

Please sign in to comment.