Skip to content

Commit

Permalink
Documentation fixes.
Browse files Browse the repository at this point in the history
  • Loading branch information
Drake53 authored and mmanela committed Jan 6, 2023
1 parent 99a00fb commit c78b928
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 14 deletions.
2 changes: 1 addition & 1 deletion DiffPlex/DiffBuilder/ISideBySideDiffBuilder.cs
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ namespace DiffPlex.DiffBuilder
public interface ISideBySideDiffBuilder
{
/// <summary>
/// Builds a diff model for displaying diffs in a side by side view
/// Builds a diff model for displaying diffs in a side by side view
/// </summary>
/// <param name="oldText">The old text.</param>
/// <param name="newText">The new text.</param>
Expand Down
8 changes: 4 additions & 4 deletions DiffPlex/DiffBuilder/InlineDiffBuilder.cs
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,8 @@ public DiffPaneModel BuildDiffModel(string oldText, string newText, bool ignoreW
/// </summary>
/// <param name="oldText">The old text to diff.</param>
/// <param name="newText">The new text.</param>
/// <param name="ignoreWhiteSpace">true if ignore the white space; othewise, false.</param>
/// <param name="ignoreCase">true if case-insensitive; otherwise, false.</param>
/// <param name="ignoreWhiteSpace"><see langword="true"/> if ignore the white space; otherwise, <see langword="false"/>.</param>
/// <param name="ignoreCase"><see langword="true"/> if case-insensitive; otherwise, <see langword="false"/>.</param>
/// <param name="chunker">The chunker.</param>
/// <returns>The diffs result.</returns>
public static DiffPaneModel Diff(string oldText, string newText, bool ignoreWhiteSpace = true, bool ignoreCase = false, IChunker chunker = null)
Expand All @@ -61,8 +61,8 @@ public static DiffPaneModel Diff(string oldText, string newText, bool ignoreWhit
/// <param name="differ">The differ instance.</param>
/// <param name="oldText">The old text to diff.</param>
/// <param name="newText">The new text.</param>
/// <param name="ignoreWhiteSpace">true if ignore the white space; othewise, false.</param>
/// <param name="ignoreCase">true if case-insensitive; otherwise, false.</param>
/// <param name="ignoreWhiteSpace"><see langword="true"/> if ignore the white space; otherwise, <see langword="false"/>.</param>
/// <param name="ignoreCase"><see langword="true"/> if case-insensitive; otherwise, <see langword="false"/>.</param>
/// <param name="chunker">The chunker.</param>
/// <returns>The diffs result.</returns>
public static DiffPaneModel Diff(IDiffer differ, string oldText, string newText, bool ignoreWhiteSpace = true, bool ignoreCase = false, IChunker chunker = null)
Expand Down
8 changes: 4 additions & 4 deletions DiffPlex/DiffBuilder/SideBySideDiffBuilder.cs
Original file line number Diff line number Diff line change
Expand Up @@ -60,8 +60,8 @@ public SideBySideDiffModel BuildDiffModel(string oldText, string newText, bool i
/// </summary>
/// <param name="oldText">The old text to diff.</param>
/// <param name="newText">The new text.</param>
/// <param name="ignoreWhiteSpace">true if ignore the white space; othewise, false.</param>
/// <param name="ignoreCase">true if case-insensitive; otherwise, false.</param>
/// <param name="ignoreWhiteSpace"><see langword="true"/> if ignore the white space; otherwise, <see langword="false"/>.</param>
/// <param name="ignoreCase"><see langword="true"/> if case-insensitive; otherwise, <see langword="false"/>.</param>
/// <returns>The diffs result.</returns>
public static SideBySideDiffModel Diff(string oldText, string newText, bool ignoreWhiteSpace = true, bool ignoreCase = false)
{
Expand All @@ -81,8 +81,8 @@ public static SideBySideDiffModel Diff(string oldText, string newText, bool igno
/// <param name="differ">The differ instance.</param>
/// <param name="oldText">The old text to diff.</param>
/// <param name="newText">The new text.</param>
/// <param name="ignoreWhiteSpace">true if ignore the white space; othewise, false.</param>
/// <param name="ignoreCase">true if case-insensitive; otherwise, false.</param>
/// <param name="ignoreWhiteSpace"><see langword="true"/> if ignore the white space; otherwise, <see langword="false"/>.</param>
/// <param name="ignoreCase"><see langword="true"/> if case-insensitive; otherwise, <see langword="false"/>.</param>
/// <param name="lineChunker">The line chunker.</param>
/// <param name="wordChunker">The word chunker.</param>
/// <returns>The diffs result.</returns>
Expand Down
4 changes: 2 additions & 2 deletions DiffPlex/IDiffer.cs
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,10 @@ public interface IDiffer
/// </summary>
/// <param name="oldText">The old text.</param>
/// <param name="newText">The new text.</param>
/// <param name="ignoreWhiteSpace">if set to <c>true</c> will ignore white space when determining if lines are the same.</param>
/// <param name="ignoreWhiteSpace">If set to <see langword="true"/> will ignore white space when determining if lines are the same.</param>
/// <param name="ignoreCase">Determine if the text comparision is case sensitive or not</param>
/// <param name="chunker">Component responsible for tokenizing the compared texts</param>
/// <returns>A DiffResult object which details the differences</returns>
/// <returns>A <see cref="DiffResult"/> object which details the differences</returns>
DiffResult CreateDiffs(string oldText, string newText, bool ignoreWhiteSpace, bool ignoreCase, IChunker chunker);
}
}
6 changes: 3 additions & 3 deletions DiffPlex/Model/DiffResult.cs
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,17 @@
namespace DiffPlex.Model
{
/// <summary>
/// The result of diffing two peices of text
/// The result of diffing two pieces of text
/// </summary>
public class DiffResult
{
/// <summary>
/// The chunked peices of the old text
/// The chunked pieces of the old text
/// </summary>
public string[] PiecesOld { get; }

/// <summary>
/// The chunked peices of the new text
/// The chunked pieces of the new text
/// </summary>
public string[] PiecesNew { get; }

Expand Down

0 comments on commit c78b928

Please sign in to comment.