--- a/gnv-artifacts/src/main/java/de/intevation/gnv/timeseries/gap/TimeGap.java	Fri Apr 09 07:27:38 2010 +0000
+++ b/gnv-artifacts/src/main/java/de/intevation/gnv/timeseries/gap/TimeGap.java	Fri Apr 09 10:22:38 2010 +0000
@@ -2,6 +2,13 @@
 
 import java.io.Serializable;
 
+/**
+ * A class representing a timegap. <code>TimeGap</code>s are used in timeseries
+ * charts to identify gaps taking account for the resolution of the x-axis
+ * range.
+ *
+ * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a>
+ */
 public interface TimeGap extends Serializable {
 
     public final static String TIME_UNIT_MINUTE = "m";
@@ -19,20 +26,24 @@
 
     /**
      * Returns the Lookup-Key for the TimeGap
-     * @return
+     *
+     * @return the timegap key.
      */
     int getKey();
 
     /**
      * Returns the Value of the TimeValue in the Unit which is also given.
-     * @return
+     *
+     * @return the timegap value.
      */
     int getValue();
 
     /**
      * Returns the Unit of the Timegap (e.g. Minutes, Hours, Days, Weeks, Months, Years)
-     * @return
+     *
+     * @return the timegap unit.
      */
     String getUnit();
 
 }
+// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :
\ No newline at end of file