Add documentation.

[master-thesis.git] / Parasitemia / ParasitemiaCore / Heap.fs

diff --git a/Parasitemia/ParasitemiaCore/Heap.fs b/Parasitemia/ParasitemiaCore/Heap.fs
index c23cdbb..32887a2 100644 (file)
--- a/Parasitemia/ParasitemiaCore/Heap.fs
+++ b/Parasitemia/ParasitemiaCore/Heap.fs
@@ -14,8 +14,8 @@ type private Node<'k, 'v> =
     override this.ToString () = sprintf "%A -> %A" this.key this.value
 
 /// <summary>
-/// An heap min or max depending of the comparer.
-/// The goal is to have a set of data and be able to get the value associated with the min (or max) key.
+/// An heap min or max depending of the given key comparer.
+/// The goal is to have a set of data and be able to get the value associated with the min (or max) key value.
 /// </summary>
 type Heap<'k, 'v> (kComparer : IComparer<'k>) =
     let a = List<Node<'k, 'v>>()
@@ -98,5 +98,3 @@ type Heap<'k, 'v> (kComparer : IComparer<'k>) =
         max.key, max.value
 
     member this.Clear () = a.Clear()
-
-