Added missing docs

src/algorithms/capture.rs

@@ -9,27 +9,40 @@ use std::ops::Range;
 pub enum DiffOp {
     /// A segment is equal (see [`DiffHook::equal`])
     Equal {
+        /// The starting index in the old sequence.
         old_index: usize,
+        /// The starting index in the new sequence.
         new_index: usize,
+        /// The length of the segment.
         len: usize,
     },
     /// A segment was deleted (see [`DiffHook::delete`])
     Delete {
+        /// The starting index in the old sequence.
         old_index: usize,
+        /// The length of the old segment.
         old_len: usize,
+        /// The starting index in the new sequence.
         new_index: usize,
     },
     /// A segment was inserted (see [`DiffHook::insert`])
     Insert {
+        /// The starting index in the old sequence.
         old_index: usize,
+        /// The starting index in the new sequence.
         new_index: usize,
+        /// The length of the new segment.
         new_len: usize,
     },
     /// A segment was replaced (see [`DiffHook::replace`])
     Replace {
+        /// The starting index in the old sequence.
         old_index: usize,
+        /// The length of the old segment.
         old_len: usize,
+        /// The starting index in the new sequence.
         new_index: usize,
+        /// The length of the new segment.
         new_len: usize,
     },
 }
@@ -37,9 +50,13 @@ pub enum DiffOp {
 /// The tag of a diff operation.
 #[derive(Debug, PartialEq, Eq, Hash, Clone, Copy, Ord, PartialOrd)]
 pub enum DiffTag {
+    /// The diff op encodes an equal segment.
     Equal,
+    /// The diff op encodes a deleted segment.
     Delete,
+    /// The diff op encodes an inserted segment.
     Insert,
+    /// The diff op encodes a replaced segment.
     Replace,
 }
 

src/algorithms/hook.rs

@@ -1,6 +1,7 @@
 /// A trait for reacting to an edit script from the "old" version to
 /// the "new" version.
 pub trait DiffHook: Sized {
+    /// The error produced from the hook methods.
     type Error;
 
     /// Called when lines with indices `old_index` (in the old version) and

src/algorithms/mod.rs

@@ -34,7 +34,9 @@ pub mod patience;
 /// An enum representing a diffing algorithm.
 #[derive(Clone, Copy, Hash, PartialEq, Eq, PartialOrd, Ord, Debug)]
 pub enum Algorithm {
+    /// Picks the myers algorithm from [`myers`]
     Myers,
+    /// Picks the patience algorithm from [`patience`]
     Patience,
 }