Style and javadoc.

3 files changed, 25 insertions, 20 deletions

diff --git a/sources/core/time/VSLamportTime.java b/sources/core/time/VSLamportTime.java
index e78970f..25ad8af 100644
--- a/sources/core/time/VSLamportTime.java
+++ b/sources/core/time/VSLamportTime.java
@@ -4,14 +4,19 @@
  */
 package core.time;
 
-// TODO: Auto-generated Javadoc
 /**
- * This class defined how the lamport timestamps are represented.
+ * The Class VSLamportTime. This class defined how the lamport
+ * timestamps are represented.
+ *
+ * @author Paul C. Buetow
  */
 public class VSLamportTime implements VSTime {
+    /** The serial version uid */
     private static final long serialVersionUID = 1L;
 
-    /** Specified the global time of the lamport timestamp. It's used for correct painting in the simulator paint area. */
+    /** Specified the global time of the lamport timestamp. It's used for
+     * correct painting position in the simulator canvas paint area.
+     */
     private long globalTime;
 
     /** Specified the process' local lamport time. */
@@ -28,28 +33,24 @@ public class VSLamportTime implements VSTime {
         this.lamportTime = lamportTime;
     }
 
-    /**
-     * Getter method.
-     *
-     * @return The global time.
+    /* (non-Javadoc)
+     * @see core.time.VSTime#getGlobalTime()
      */
     public long getGlobalTime() {
         return globalTime;
     }
 
     /**
-     * Getter method.
+     * Gets the lamport time.
      *
-     * @return The process' local lamport time.
+     * @return The process' local lamport time
      */
     public long getLamportTime() {
         return lamportTime;
     }
 
-    /**
-     * String representation.
-     *
-     * @return The string representation of the lamport time.
+    /* (non-Javadoc)
+     * @see core.time.VSTime#toString()
      */
     public String toString() {
         return "(" + lamportTime + ")";
diff --git a/sources/core/time/VSTime.java b/sources/core/time/VSTime.java
index c68882b..c5a2805 100644
--- a/sources/core/time/VSTime.java
+++ b/sources/core/time/VSTime.java
@@ -4,22 +4,23 @@
  */
 package core.time;
 
-// TODO: Auto-generated Javadoc
 /**
  * This interface is a guidline for general time format classes.
+ *
+ * @author Paul C. Buetow
  */
 public interface VSTime {
     /**
-     * Getter method.
+     * Gets the global time.
      *
-     * @return The global time.
+     * @return The global time
      */
     public long getGlobalTime();
 
     /**
-     * String representation.
+     * Returns a string representation.
      *
-     * @return The representation of the implementing object as a string.
+     * @return The representation of the implementing object as a string
      */
     public String toString();
 }
diff --git a/sources/core/time/VSVectorTime.java b/sources/core/time/VSVectorTime.java
index 4b48477..5a52f96 100644
--- a/sources/core/time/VSVectorTime.java
+++ b/sources/core/time/VSVectorTime.java
@@ -6,11 +6,14 @@ package core.time;
 
 import java.util.ArrayList;
 
-// TODO: Auto-generated Javadoc
 /**
- * The Class VSVectorTime.
+ * The Class VSVectorTime. This class defined how the vector
+ * timestamps are represented.
+ *
+ * @author Paul C. Buetow
  */
 public class VSVectorTime extends ArrayList<Long> implements VSTime {
+    /** The serial version uid */
     private static final long serialVersionUID = 1L;
 
     /** The global time. */