Updated documentation

Author: Thomas Hambach

CSharpDiff/Patch/IPatch.cs

@@ -0,0 +1,42 @@
+using CSharpDiff.Patch.Models;
+
+namespace CSharpDiff.Patch
+{
+    public interface IPatch
+    {
+        string[] contextLines(string[] lines);
+
+        /// <summary>
+        /// Create a text version of a unified diff patch.
+        /// </summary>
+        /// <param name="oldFileName"></param>
+        /// <param name="newFileName"></param>
+        /// <param name="newStr"></param>
+        /// <param name="oldStr"></param>
+        /// <param name="oldHeader"></param>
+        /// <param name="newHeader"></param>
+        /// <param name="options"></param>
+        /// <returns></returns>
+        string create(string oldFileName, string newFileName, string newStr, string oldStr, string oldHeader, string newHeader, PatchOptions options);
+
+        /// <summary>
+        /// Create object of PatchResult that can be consumed by `formatPatch` to create a unified diff.
+        /// </summary>
+        /// <param name="oldFileName"></param>
+        /// <param name="newFileName"></param>
+        /// <param name="newStr"></param>
+        /// <param name="oldStr"></param>
+        /// <param name="oldHeader"></param>
+        /// <param name="newHeader"></param>
+        /// <param name="options"></param>
+        /// <returns></returns>
+        PatchResult createPatchResult(string oldFileName, string newFileName, string newStr, string oldStr, string oldHeader, string newHeader, PatchOptions options);
+
+        /// <summary>
+        /// Format to unified diff patch using PatchResult
+        /// </summary>
+        /// <param name="diff"></param>
+        /// <returns></returns>
+        string formatPatch(PatchResult diff);
+    }
+}

CSharpDiff/Patch/Patch.cs

@@ -5,14 +5,20 @@
 
 namespace CSharpDiff.Patch
 {
-    public class Patch
+    public class Patch : IPatch
     {
         public string[] contextLines(string[] lines)
         {
             return lines.Select((entry) => { return ' ' + entry; }).ToArray();
         }
 
-        public PatchResult CreateStructuredPatch(string oldFileName, string newFileName, string newStr, string oldStr, string oldHeader, string newHeader, PatchOptions options)
+        public string create(string oldFileName, string newFileName, string newStr, string oldStr, string oldHeader, string newHeader, PatchOptions options)
+        {
+            var result = createPatchResult(oldFileName, newFileName, newStr, oldStr, oldHeader, newHeader, options);
+            return formatPatch(result);
+        }
+
+        public PatchResult createPatchResult(string oldFileName, string newFileName, string newStr, string oldStr, string oldHeader, string newHeader, PatchOptions options)
         {
             var df = new DiffLines();
             var diff = df.diff(oldStr, newStr);

README.md

@@ -17,9 +17,7 @@ var text1 = "";
 var text2 = "";
 
 var ps = new Patch();
-var ds = new Diff();
-var patch = ps.CreateStructuredPatch("filename1", "filename2", text1, text2, "", "", new PatchServiceOptions());
-var patch = ps.formatPatch(patch);
+string patch = ps.create("filename1", "filename2", text1, text2, "header1", "header2", new PatchServiceOptions());
 ```
 
 ### Works Well With