#36: Updated javadoc for List.group

mperry · mperry · commit 913fcf6eca46 · 2014-07-14T22:15:56.000+10:00
diff --git a/core/src/main/java/fj/data/List.java b/core/src/main/java/fj/data/List.java
@@ -403,7 +403,8 @@ public Boolean f(final A a) {
   }
 
   /**
-   * Groups elements according to the given equality implementation.
+   * Groups elements according to the given equality implementation by longest
+   * sequence of equal elements.
    *
    * @param e The equality implementation for the elements.
    * @return A list of grouped elements.

Original file line number	Diff line number	Diff line change
`@@ -403,7 +403,8 @@ public Boolean f(final A a) {`
`403`	`403`	`}`
`404`	`404`
`405`	`405`	`/**`
`406`		`- * Groups elements according to the given equality implementation.`
	`406`	`+ * Groups elements according to the given equality implementation by longest`
	`407`	`+ * sequence of equal elements.`
`407`	`408`	`*`
`408`	`409`	`* @param e The equality implementation for the elements.`
`409`	`410`	`* @return A list of grouped elements.`