From ec5372c0540f6f036a44a27be6bc6b65805bf2b9 Mon Sep 17 00:00:00 2001
From: Schankula Christopher <schankuc@mcmaster.ca>
Date: Sun, 4 Mar 2018 17:09:49 -0500
Subject: [PATCH] comments on GeneralCompare
---
src/sort/GeneralCompare.java | 6 ++++++
1 file changed, 6 insertions(+)
diff --git a/src/sort/GeneralCompare.java b/src/sort/GeneralCompare.java
index 72b8e86..baa9ccd 100644
--- a/src/sort/GeneralCompare.java
+++ b/src/sort/GeneralCompare.java
@@ -1,5 +1,11 @@
package sort;
public interface GeneralCompare<T> {
+ /**
+ * Compare two Comparable elements based on an arbitrary ordering definition.
+ * @param a1 The first value to be compared.
+ * @param a2 The second value to be compared
+ * @return Integer < 0 if a1 is less than a2, 0 if equal and > 0 if a1 is bigger than a2
+ */
public int compare(Comparable<T> a1, Comparable<T> a2);
}
--
GitLab