Permalink
Browse files

Add header comment to TimeAgo class

  • Loading branch information...
kevinsawicki committed Apr 1, 2011
1 parent 5a007b6 commit 3b2ec34b94a8f5aa4c5a38dabcdcc95a492336e3
Showing with 8 additions and 0 deletions.
  1. +8 −0 org.github.timeago/src/main/java/org/github/timeago/TimeAgo.java
@@ -25,6 +25,14 @@
import java.util.Date;
/**
+ *
+ * Time ago class that converts long millisecond and {@link Date} objects to
+ * time ago/from now {@link String} objects.
+ *
+ * This class uses the messages from {@link Messages} by default but those can
+ * be changed after creation through one of the setter methods for a specified
+ * time string.
+ *
* @author Kevin Sawicki (kevin@github.com)
*/
public class TimeAgo {

0 comments on commit 3b2ec34

Please sign in to comment.