Skip to content

Commit

Permalink
Updated even more documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
Uralstech committed Aug 8, 2024
1 parent 64f695e commit 8926c33
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 4 deletions.
2 changes: 1 addition & 1 deletion src/Runtime/Context.cs
Original file line number Diff line number Diff line change
Expand Up @@ -307,7 +307,7 @@ public GetStatus Get(Context? callingContext, string symbol, out Reference objec
/// <param name="newObject">The new <see cref="IEzrObject"/> to be assigned and the name of the symbol, in the format (<see cref="IEzrObject"/> Object, <see cref="string"/> Name).</param>
/// <param name="oldReference">The old reference to assign to.</param>
/// <param name="accessibilityModifiers">Accessibility modifiers of the operation, <see cref="AccessMod.None"/> by default.</param>
/// <returns>The <see cref="SetStatus"/>, representing the result of the operation.</returns>
/// <returns>The <see cref="SetStatus"/>, representing the result of the operation, and the reference to the set symbol.</returns>
public (SetStatus, Reference) Set(Context? callingContext, (IEzrObject Object, string Name) newObject, Reference oldReference, AccessMod accessibilityModifiers = AccessMod.None)
{
if (oldReference.IsEmpty)
Expand Down
3 changes: 3 additions & 0 deletions src/Syntax/Lexer.cs
Original file line number Diff line number Diff line change
Expand Up @@ -259,6 +259,9 @@ private void ReverseTo(int index)
return null;
}

/// <summary>
/// Skips a comment in the ezr² code.
/// </summary>
private void SkipComment()
{
do
Expand Down
2 changes: 0 additions & 2 deletions src/Syntax/Parser/ParseResult.cs
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@ public class ParseResult
/// Sets <see cref="Node"/> as the result of successful parsing.
/// </summary>
/// <param name="node">The <see cref="Runtime.Nodes.Node"/> result of the parsing.</param>
/// <returns>The same <see cref="ParseResult"/> object.</returns>
public void Success(Node node)
{
Node = node;
Expand All @@ -47,7 +46,6 @@ public void Success(Node node)
/// </remarks>
/// <param name="priority">The priority/fatality of the failure.</param>
/// <param name="error">The <see cref="SyntaxError"/> that occurred in parsing.</param>
/// <returns>The same <see cref="ParseResult"/> object.</returns>
public void Failure(int priority, SyntaxError error)
{
if (Error is null || _errorPriority < priority)
Expand Down
4 changes: 3 additions & 1 deletion src/Util/Utils.cs
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,9 @@ public static int IndexToFlag(int index)
/// <summary>
/// Creates formatted text which contains the text between <paramref name="startPosition"/> and <paramref name="endPosition"/>, underlined with tilde (~) symbols.
/// </summary>
/// <returns>The formatted text.</returns>
/// <param name="startPosition">The starting position of the underlining.</param>
/// <param name="endPosition">The ending position of the underlining.</param>
/// <returns>The formatted text and the actual starting line number of the error.</returns>
public static (int AdjustedLineNumber, string SourceWithUnderline) SourceWithUnderline(Position startPosition, Position endPosition)
{
string text = startPosition.Script;
Expand Down

0 comments on commit 8926c33

Please sign in to comment.