From c2a71e7199a2c683c0966d7a26b7f659dfd4469a Mon Sep 17 00:00:00 2001 From: brutzman <brutzman@nps.edu> Date: Wed, 17 Jul 2024 20:27:15 -0700 Subject: [PATCH] javadoc improvements --- .../homework3/Cecil/ArrivalProcess.java | 9 +++++---- .../homework3/Hedgcorth/ArrivalProcess.java | 12 ++++++------ 2 files changed, 11 insertions(+), 10 deletions(-) diff --git a/assignments/src/MV3500Cohort2023MarchJune/homework3/Cecil/ArrivalProcess.java b/assignments/src/MV3500Cohort2023MarchJune/homework3/Cecil/ArrivalProcess.java index 97630234a6..7b3556ba3d 100644 --- a/assignments/src/MV3500Cohort2023MarchJune/homework3/Cecil/ArrivalProcess.java +++ b/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; diff --git a/assignments/src/MV3500Cohort2023MarchJune/homework3/Hedgcorth/ArrivalProcess.java b/assignments/src/MV3500Cohort2023MarchJune/homework3/Hedgcorth/ArrivalProcess.java index e4b55ab972..3db03c3437 100644 --- a/assignments/src/MV3500Cohort2023MarchJune/homework3/Hedgcorth/ArrivalProcess.java +++ b/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; -- GitLab