javadoc improvements

assignments/src/MV3500Cohort2023MarchJune/homework3/Cecil/ArrivalProcess.java

@@ -15,11 +15,12 @@ import simkit.random.RandomVariate;
 public class ArrivalProcess extends SimEntityBase {
     
     private RandomVariate interarrivalTimeGenerator;
+    /** the number of arrivals */
     protected int numberArrivals;
     
     /**
      * Constructor for the arrival process setting the interarrivalTimeGenerator.
-     * @param interarrivalTimeGenerator 
+     * @param interarrivalTimeGenerator the simkit interarrivalTimeGenerator
      */
     public ArrivalProcess(RandomVariate interarrivalTimeGenerator) {
         this.setInterarrivalTimeGenerator(interarrivalTimeGenerator);
@@ -32,7 +33,7 @@ public class ArrivalProcess extends SimEntityBase {
     
     /**
      * Getter for the InterarrivalTimeGenerator.
-     * @return 
+     * @return the simkit interarrivalTimeGenerator
      */
     public RandomVariate getInterarrivalTimeGenerator() {
         return interarrivalTimeGenerator;
@@ -40,7 +41,7 @@ public class ArrivalProcess extends SimEntityBase {
     
     /**
      * Setter for the interarrivalTimeGenerator.
-     * @param interarrivalTimeGenerator 
+     * @param interarrivalTimeGenerator the simkit interarrivalTimeGenerator
      */
     public void setInterarrivalTimeGenerator(RandomVariate interarrivalTimeGenerator) {
         this.interarrivalTimeGenerator = interarrivalTimeGenerator;
@@ -48,7 +49,7 @@ public class ArrivalProcess extends SimEntityBase {
     
     /**
      * Getter for the number of arrivals.
-     * @return 
+     * @return the number of arrivals
      */
     public int getNumberArrivals() {
         return this.numberArrivals;

assignments/src/MV3500Cohort2023MarchJune/homework3/Hedgcorth/ArrivalProcess.java

@@ -14,14 +14,14 @@ public class ArrivalProcess extends SimEntityBase {
     // parameter
     private RandomVariate interarrivalTimeGenerator;
     
-    // state variable
+    /** state variable */
     protected int numberArrivals;
 
     /**
      * The constructor method ArrivalProcess(RandomVariate) sets the
      * interarrivalTimeGenerator RandomVariate.
      *
-     * @param interarrivalTimeGenerator
+     * @param interarrivalTimeGenerator the simkit interarrivalTimeGenerator
      */
     public ArrivalProcess(RandomVariate interarrivalTimeGenerator) {
         setInterarrivalTimeGenerator(interarrivalTimeGenerator);
@@ -38,7 +38,7 @@ public class ArrivalProcess extends SimEntityBase {
      * The method getInterarrivalTimeGenerator() returns the
      * interarrivalTimeGenerator .
      *
-     * @return
+     * @return the simkit interarrivalTimeGenerator
      */
     public RandomVariate getInterarrivalTimeGenerator() {
         return interarrivalTimeGenerator;
@@ -46,9 +46,9 @@ public class ArrivalProcess extends SimEntityBase {
 
     /**
      * The method setInterarrivalTimeGenerator sets the
-     * interarrivalTimeGenerator.
+     * simkit interarrivalTimeGenerator.
      *
-     * @param interarrivalTimeGenerator
+     * @param interarrivalTimeGenerator the simkit interarrivalTimeGenerator needed
      */
     public void setInterarrivalTimeGenerator(RandomVariate interarrivalTimeGenerator) {
         this.interarrivalTimeGenerator = interarrivalTimeGenerator;
@@ -57,7 +57,7 @@ public class ArrivalProcess extends SimEntityBase {
     /**
      * The method getNumberArrivals returns the numberArrivals.
      *
-     * @return
+     * @return number of arrivals
      */
     public int getNumberArrivals() {
         return numberArrivals;