Clarify documentation of Period.compareTo

The definition of "greater" was ambiguous (longer period? later start? later end?); this documentation improves it.
ical4j · Apr 16, 2016 · 9dec808 · 9dec808
1 parent e6e26e7
commit 9dec808
Showing 1 changed file with 1 addition and 0 deletions.
diff --git a/src/main/java/net/fortuna/ical4j/model/Period.java b/src/main/java/net/fortuna/ical4j/model/Period.java
@@ -313,6 +313,7 @@ public final String toString() {
 
     /**
      * Compares the specified period with this period.
+     * First, compare the start dates.  If they are the same, compare the end dates.
      * 
      * @param arg0 a period to compare with this one
      * @return a postive value if this period is greater, negative if the other is