diff --git a/src/sort/GeneralCompare.java b/src/sort/GeneralCompare.java index 72b8e860ddb0ec1973996d88c3041d79a6348c3e..baa9ccde66882013a0f38f2f4b528999c633a84a 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); }