API Reference

Class

MarkdownRoundtripDiagnostic

Namespace OfficeIMO.Markdown
Assembly OfficeIMO.Markdown
Modifiers sealed

Diagnostic emitted when a roundtrip writer cannot preserve source bytes losslessly.

Inheritance

  • Object
  • MarkdownRoundtripDiagnostic

Usage

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by

Accepted by parameters

Constructors

public MarkdownRoundtripDiagnostic(String id, String message, Nullable<MarkdownSourceSpan> sourceSpan = null, IReadOnlyList<MarkdownSourceSpan> relatedSourceSpans = null, Nullable<MarkdownOriginalSourceSliceFailureReason> originalSourceFailureReason = null) #

Creates a roundtrip diagnostic.

Parameters

id System.String requiredposition: 0
message System.String requiredposition: 1
sourceSpan System.Nullable{OfficeIMO.Markdown.MarkdownSourceSpan} = null optionalposition: 2
relatedSourceSpans System.Collections.Generic.IReadOnlyList{OfficeIMO.Markdown.MarkdownSourceSpan} = null optionalposition: 3
originalSourceFailureReason System.Nullable{OfficeIMO.Markdown.MarkdownOriginalSourceSliceFailureReason} = null optionalposition: 4

Properties

public String Id { get; } #

Stable diagnostic identifier.

public String Message { get; } #

Human-readable diagnostic message.

public Nullable<MarkdownSourceSpan> SourceSpan { get; } #

Optional source span that caused or best explains the fallback.

public IReadOnlyList<MarkdownSourceSpan> RelatedSourceSpans { get; } #

Additional source spans related to the fallback, such as individual transform input blocks.

public Nullable<MarkdownOriginalSourceSliceFailureReason> OriginalSourceFailureReason { get; } #

Machine-readable reason an original source mapping failed, when the diagnostic represents that fallback.