summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authormokha <mokha@cisco.com>2019-05-08 17:59:17 -0600
committermokha <mokha@cisco.com>2019-05-08 17:59:17 -0600
commit04c941e65015cdd96f2665fcb3daf6f27f55a6cd (patch)
tree83e3b147b33d372bce7a5ef57b147340f15d6bf4
parentd7eccde0f7fe5f046a224336d2b2a789e9b0b9f7 (diff)
fix errors in the docs
-rw-r--r--src/Q2/BonusOnSavings.java1
-rw-r--r--src/Q4/BanffMarathonRunner.java4
2 files changed, 3 insertions, 2 deletions
diff --git a/src/Q2/BonusOnSavings.java b/src/Q2/BonusOnSavings.java
index 1a0bb2e..4d80361 100644
--- a/src/Q2/BonusOnSavings.java
+++ b/src/Q2/BonusOnSavings.java
@@ -32,6 +32,7 @@ public class BonusOnSavings {
* Computes the bonus based on the target monthly commitment and the actual quarterly
* contributions.
*
+ * @param monthlyCommitment the target monthly commitment for each month.
* @param q1 the actual contribution for the first quarter.
* @param q2 the actual contribution for the second quarter.
* @param q3 the actual contribution for the third quarter.
diff --git a/src/Q4/BanffMarathonRunner.java b/src/Q4/BanffMarathonRunner.java
index e9c68cf..e1598fa 100644
--- a/src/Q4/BanffMarathonRunner.java
+++ b/src/Q4/BanffMarathonRunner.java
@@ -35,7 +35,7 @@ public class BanffMarathonRunner extends AddressBook {
* the marathon. Because java generics does not allow implementing a generic interface with
* different type parameters, this code assumes the AddressBook is an instance of a Runner.
*
- * @param AddressBook the other runner to compare against
+ * @param other the other runner to compare against
* @return a negative integer, zero, or a positive integer as the first argument is less than,
* equal to, or greater than the second.
*/
@@ -91,7 +91,7 @@ public class BanffMarathonRunner extends AddressBook {
/**
* Returns the runners that finished the marathon in above or equal to average time.
*
- * @param the list of runners
+ * @param runners the list of runners
* @return the list of runners that finished the marathon in above average time.
*/
public static String getAboveAverageRunners(BanffMarathonRunner[] runners) {