HSEARCH-3103 Add some javadoc to SortMode

hibernate · Mar 19, 2020 · dfd5ff9 · dfd5ff9
1 parent 74bbfa2
commit dfd5ff9
Showing 1 changed file with 8 additions and 5 deletions.
diff --git a/engine/src/main/java/org/hibernate/search/engine/search/common/SortMode.java b/engine/src/main/java/org/hibernate/search/engine/search/common/SortMode.java
@@ -7,26 +7,29 @@
 package org.hibernate.search.engine.search.common;
 
 
+/**
+ * Defines how to pick the value to sort on for multi-valued fields.
+ */
 public enum SortMode {
 
 	/**
-	 * Multivalue the sum of all the values.
+	 * When a field has multiple values, compute the sum of all the values.
 	 */
 	SUM,
 	/**
-	 * Multivalue the lowest value.
+	 * When a field has multiple values, pick the lowest value.
 	 */
 	MIN,
 	/**
-	 * Multivalue the highest value.
+	 * When a field has multiple values, pick the highest value.
 	 */
 	MAX,
 	/**
-	 * Multivalue the average of all the values.
+	 * When a field has multiple values, compute the average of all the values.
 	 */
 	AVG,
 	/**
-	 * Multivalue the median of the values.
+	 * When a field has multiple values, compute the median of all the values.
 	 */
 	MEDIAN