Add docs for compareBy

passsy · Dec 2, 2018 · 25c03bc · 25c03bc
1 parent 47168f9
commit 25c03bc
Showing 1 changed file with 6 additions and 2 deletions.
diff --git a/lib/src/comparisons.dart b/lib/src/comparisons.dart
@@ -20,14 +20,18 @@ Comparator<T> reverse<T>(Comparator<T> comparator) {
   return compareTo;
 }
 
+/**
+ * Creates a comparator using the function to transform value to a [Comparable] instance for comparison.
+ */
 Comparator<T> compareBy<T>(Comparable Function(T) selector) {
   int compareTo(T a, T b) => selector(a).compareTo(selector(b));
-
   return compareTo;
 }
 
+/**
+ * Creates a descending comparator using the function to transform value to a [Comparable] instance for comparison.
+ */
 Comparator<T> compareByDescending<T>(Comparable Function(T) selector) {
   int compareTo(T a, T b) => selector(b).compareTo(selector(a));
-
   return compareTo;
 }