diff gnv-artifacts/src/main/java/de/intevation/gnv/timeseries/gap/DefaultTimeGap.java @ 810:991e13c3d504

Added Javadoc in timeseries package. gnv-artifacts/trunk@894 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author Ingo Weinzierl <ingo.weinzierl@intevation.de>
date Fri, 09 Apr 2010 10:22:38 +0000
parents c4156275c1e1
children 2423cefe7d39
line wrap: on
line diff
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/timeseries/gap/DefaultTimeGap.java	Fri Apr 09 07:27:38 2010 +0000
+++ b/gnv-artifacts/src/main/java/de/intevation/gnv/timeseries/gap/DefaultTimeGap.java	Fri Apr 09 10:22:38 2010 +0000
@@ -1,10 +1,11 @@
 package de.intevation.gnv.timeseries.gap;
 
 /**
+ * The default implementation of <code>TimeGap</code>.
+ * 
  * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a>
- *
  */
-public class DefaultTimeGap implements TimeGap{
+public class DefaultTimeGap implements TimeGap {
 
     /**
      * The UNIT of the TimeGap
@@ -27,9 +28,10 @@
 
     /**
      * Constructor
-     * @param unit
-     * @param key
-     * @param value
+     *
+     * @param unit Unit of this value.
+     * @param key The key of this time gap.
+     * @param value The value of this gap.
      */
     public DefaultTimeGap(String unit, int key, int value) {
         super();
@@ -38,25 +40,20 @@
         this.value = value;
     }
 
-    /**
-     * @see de.intevation.gnv.timeseries.gap.TimeGap#getUnit()
-     */
+
     public String getUnit() {
         return this.unit;
     }
 
-    /**
-     * @see de.intevation.gnv.timeseries.gap.TimeGap#getKey()
-     */
+
     public int getKey() {
         return this.key;
     }
 
-    /**
-     * @see de.intevation.gnv.timeseries.gap.TimeGap#getValue()
-     */
+
     public int getValue() {
         return this.value;
     }
 
 }
+// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :
\ No newline at end of file

http://dive4elements.wald.intevation.org