API Reference
Class
WordComparisonResult
Machine-readable comparison result produced by String).
Inheritance
- Object
- WordComparisonResult
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
Methods
public String ToMarkdown() #Returns:
StringRenders this comparison result as Markdown suitable for review notes and automation logs.
public String ToTextSummary() #Returns:
StringReturns a compact single-line summary suitable for CLI wrappers and CI annotations.
Inherited Methods
Properties
public String SourcePath { get; } #Source document path used for the comparison.
public String TargetPath { get; } #Target document path used for the comparison.
public IReadOnlyList<WordComparisonFinding> Findings { get; } #All detected findings in deterministic document order.
public Boolean HasChanges { get; } #Gets whether any differences were detected.