Commit 04c941e

mokha <mokha@cisco.com>
2019-05-08 23:59:17
fix errors in the docs
1 parent d7eccde
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.
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) {