Constructor in Diagnostic

Summary

Initializes a new instance of the Diagnostic class.

public Diagnostic(string fileName, string message, DiagnosticSeverity severity = DiagnosticSeverity.Error)

Parameters

Method in Diagnostic

Summary

public override int GetHashCode()

Constructor in Diagnostic

Summary

Initializes a new instance of the Diagnostic class.

public Diagnostic(string fileName, Range range, string message, DiagnosticSeverity severity = DiagnosticSeverity.Error)

Parameters

Constructor in Diagnostic

Summary

Initializes a new instance of the Diagnostic class.

public Diagnostic(string message, DiagnosticSeverity severity = DiagnosticSeverity.Error)

Parameters

Method in Diagnostic

Summary

public override bool Equals(object obj)

Parameters

Class in Yarn.Compiler

Inherits from System.Object

Summary

A diagnostic message that describes an error, warning or informational message that the user can take action on.

public sealed class Diagnostic

Remarks

Diagnostics are presented to the user as the result of compilation, through the CompilationResult class's Diagnostics property.

Constructors

Enums

Methods

Properties

Constructor in Diagnostic

Summary

Initializes a new instance of the Diagnostic class.

public Diagnostic(string fileName, ParserRuleContext context, string message, DiagnosticSeverity severity = DiagnosticSeverity.Error)

Parameters

Property in

Summary

Gets the zero-indexed character number in FileName at which the issue begins.

Method in

Summary

Property in

Summary

Gets or sets the description of the issue.

Property in

Summary

Gets or sets the source text of containing the issue.

Property in

Summary

Gets or sets the path, URI or file-name that the issue occurred in.

Property in

Summary

Gets the zero-indexed line number in FileName at which the issue begins.

Enumeration Member in DiagnosticSeverity

Summary

An informational diagnostic.

Info

Remarks

Infos represent possible issues or steps that the user may wish to fix, but are unlikely to cause problems.

Enumeration Member in DiagnosticSeverity

Summary

An warning.

Warning

Remarks

Warnings represent possible problems that the user should fix, but do not cause the compilation process to fail.

Property in Diagnostic

Summary

Gets or sets the severity of the issue.

public DiagnosticSeverity Severity { get; set; };

Property in Diagnostic

Summary

Gets or sets the range of the file indicated by FileName that the issue occurred in.

public Range Range { get; set; };

Enumeration Member in DiagnosticSeverity

Summary

An error.

Error

Remarks

If a Yarn source file contains errors, it cannot be compiled, and the compilation process will fail.

Enum in Diagnostic

Inherits from System.Enum

Summary

The severity of the issue.

public enum DiagnosticSeverity
{
    Error,
    Warning,
    Info
}

Members