mirror of
https://github.com/Stone-Red-Code/YesNt-Interpreter.git
synced 2026-09-04 00:56:31 +02:00
Replace British spellings with American in XML docs
This commit is contained in:
@@ -26,7 +26,7 @@ public class StatementAttribute : Attribute
|
|||||||
/// <summary>Gets which sides of the keyword must be padded with a space.</summary>
|
/// <summary>Gets which sides of the keyword must be padded with a space.</summary>
|
||||||
public SpaceAround SpaceAround { get; }
|
public SpaceAround SpaceAround { get; }
|
||||||
|
|
||||||
/// <summary>Gets or sets the syntax-highlight colour used by the code editor.</summary>
|
/// <summary>Gets or sets the syntax-highlight color used by the code editor.</summary>
|
||||||
public ConsoleColor Color { get; set; }
|
public ConsoleColor Color { get; set; }
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
@@ -61,12 +61,12 @@ public class StatementAttribute : Attribute
|
|||||||
public string Separator { get; set; }
|
public string Separator { get; set; }
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Initialises a new <see cref="StatementAttribute"/> with a syntax-highlight colour.
|
/// Initializes a new <see cref="StatementAttribute"/> with a syntax-highlight color.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
/// <param name="name">The keyword that identifies this statement.</param>
|
/// <param name="name">The keyword that identifies this statement.</param>
|
||||||
/// <param name="searchMode">Where in the line the keyword is matched.</param>
|
/// <param name="searchMode">Where in the line the keyword is matched.</param>
|
||||||
/// <param name="spaceAround">Which sides of the keyword require a surrounding space.</param>
|
/// <param name="spaceAround">Which sides of the keyword require a surrounding space.</param>
|
||||||
/// <param name="color">The colour used for syntax highlighting in the code editor.</param>
|
/// <param name="color">The color used for syntax highlighting in the code editor.</param>
|
||||||
public StatementAttribute(string name, SearchMode searchMode, SpaceAround spaceAround, ConsoleColor color)
|
public StatementAttribute(string name, SearchMode searchMode, SpaceAround spaceAround, ConsoleColor color)
|
||||||
{
|
{
|
||||||
Name = name;
|
Name = name;
|
||||||
@@ -76,7 +76,7 @@ public class StatementAttribute : Attribute
|
|||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Initialises a new <see cref="StatementAttribute"/> without a syntax-highlight colour.
|
/// Initializes a new <see cref="StatementAttribute"/> without a syntax-highlight color.
|
||||||
/// The statement will be excluded from syntax highlighting.
|
/// The statement will be excluded from syntax highlighting.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
/// <param name="name">The keyword that identifies this statement.</param>
|
/// <param name="name">The keyword that identifies this statement.</param>
|
||||||
|
|||||||
@@ -19,7 +19,7 @@ public class StatementInformation
|
|||||||
/// <summary>Gets which sides of the keyword must be padded with a space.</summary>
|
/// <summary>Gets which sides of the keyword must be padded with a space.</summary>
|
||||||
public SpaceAround SpaceAround { get; internal set; }
|
public SpaceAround SpaceAround { get; internal set; }
|
||||||
|
|
||||||
/// <summary>Gets the syntax-highlight colour for this statement.</summary>
|
/// <summary>Gets the syntax-highlight color for this statement.</summary>
|
||||||
public ConsoleColor Color { get; internal set; }
|
public ConsoleColor Color { get; internal set; }
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
|
|||||||
@@ -105,7 +105,7 @@ public class YesNtInterpreter
|
|||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Registers a custom statement without a syntax-highlight colour.
|
/// Registers a custom statement without a syntax-highlight color.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
/// <param name="name">The keyword that identifies this statement in source code.</param>
|
/// <param name="name">The keyword that identifies this statement in source code.</param>
|
||||||
/// <param name="searchMode">Where in the line the keyword is matched.</param>
|
/// <param name="searchMode">Where in the line the keyword is matched.</param>
|
||||||
@@ -117,12 +117,12 @@ public class YesNtInterpreter
|
|||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Registers a custom statement with a syntax-highlight colour.
|
/// Registers a custom statement with a syntax-highlight color.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
/// <param name="name">The keyword that identifies this statement in source code.</param>
|
/// <param name="name">The keyword that identifies this statement in source code.</param>
|
||||||
/// <param name="searchMode">Where in the line the keyword is matched.</param>
|
/// <param name="searchMode">Where in the line the keyword is matched.</param>
|
||||||
/// <param name="spaceAround">Which sides of the keyword require a surrounding space.</param>
|
/// <param name="spaceAround">Which sides of the keyword require a surrounding space.</param>
|
||||||
/// <param name="consoleColor">The colour used for syntax highlighting in the code editor.</param>
|
/// <param name="consoleColor">The color used for syntax highlighting in the code editor.</param>
|
||||||
/// <param name="handler">The delegate invoked when the statement matches.</param>
|
/// <param name="handler">The delegate invoked when the statement matches.</param>
|
||||||
public void AddStatement(string name, SearchMode searchMode, SpaceAround spaceAround, ConsoleColor consoleColor, Action<string> handler)
|
public void AddStatement(string name, SearchMode searchMode, SpaceAround spaceAround, ConsoleColor consoleColor, Action<string> handler)
|
||||||
{
|
{
|
||||||
@@ -147,7 +147,7 @@ public class YesNtInterpreter
|
|||||||
/// <summary>
|
/// <summary>
|
||||||
/// Disables all statements matching <paramref name="name"/> by replacing their handlers with
|
/// Disables all statements matching <paramref name="name"/> by replacing their handlers with
|
||||||
/// a no-op. The keyword still matches (so no "Invalid statement" error is raised), but the
|
/// a no-op. The keyword still matches (so no "Invalid statement" error is raised), but the
|
||||||
/// statement has no effect. Use <see cref="EnableStatement"/> to restore original behaviour.
|
/// statement has no effect. Use <see cref="EnableStatement"/> to restore original behavior.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
/// <param name="name">The keyword of the statement(s) to disable.</param>
|
/// <param name="name">The keyword of the statement(s) to disable.</param>
|
||||||
public void DisableStatement(string name)
|
public void DisableStatement(string name)
|
||||||
|
|||||||
@@ -15,7 +15,7 @@ internal static partial class Evaluator
|
|||||||
/// <param name="input">The condition expression, which may contain safe-string encoded values.</param>
|
/// <param name="input">The condition expression, which may contain safe-string encoded values.</param>
|
||||||
/// <returns>
|
/// <returns>
|
||||||
/// <see langword="true"/> or <see langword="false"/> if the condition could be evaluated;
|
/// <see langword="true"/> or <see langword="false"/> if the condition could be evaluated;
|
||||||
/// <see langword="null"/> if the expression is not a recognised condition form (treated as an error by callers).
|
/// <see langword="null"/> if the expression is not a recognized condition form (treated as an error by callers).
|
||||||
/// </returns>
|
/// </returns>
|
||||||
public static bool? EvaluateCondition(string input)
|
public static bool? EvaluateCondition(string input)
|
||||||
{
|
{
|
||||||
@@ -83,7 +83,7 @@ internal static partial class Evaluator
|
|||||||
/// Evaluates a numeric arithmetic expression string and returns the result as a string.
|
/// Evaluates a numeric arithmetic expression string and returns the result as a string.
|
||||||
/// Supports <c>+</c>, <c>-</c>, <c>*</c>, <c>/</c>, <c>%</c> (modulo), and <c>^</c> (power) operators
|
/// Supports <c>+</c>, <c>-</c>, <c>*</c>, <c>/</c>, <c>%</c> (modulo), and <c>^</c> (power) operators
|
||||||
/// with standard precedence (<c>^</c> highest, <c>+</c>/<c>-</c> lowest) and parentheses.
|
/// with standard precedence (<c>^</c> highest, <c>+</c>/<c>-</c> lowest) and parentheses.
|
||||||
/// Adjacent sign characters (<c>++</c>, <c>--</c>, <c>-+</c>, <c>+-</c>) are normalised before evaluation.
|
/// Adjacent sign characters (<c>++</c>, <c>--</c>, <c>-+</c>, <c>+-</c>) are normalized before evaluation.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
/// <param name="input">The arithmetic expression to evaluate.</param>
|
/// <param name="input">The arithmetic expression to evaluate.</param>
|
||||||
/// <returns>The result as a culture-invariant numeric string, or <c>"NaN"</c> if evaluation failed.</returns>
|
/// <returns>The result as a culture-invariant numeric string, or <c>"NaN"</c> if evaluation failed.</returns>
|
||||||
|
|||||||
Reference in New Issue
Block a user