add documentation

1 files changed, 20 insertions, 0 deletions

diff --git a/src/Q8/BadmintonScoringWithStroke.java b/src/Q8/BadmintonScoringWithStroke.java
index 64dbd7b..183ff05 100644
--- a/src/Q8/BadmintonScoringWithStroke.java
+++ b/src/Q8/BadmintonScoringWithStroke.java
@@ -1,3 +1,11 @@
+/**
+ * Assignment 2, COMP268 Class: BadmintonScoringWithStroke.java
+ *
+ * @description A class used to keep track of a Badminton game between two opponents.
+ * @author: mo khan Student ID: 3431709
+ * @date August 3, 2019
+ * @version 1.0
+ */
 package Q8;
 
 import java.util.*;
@@ -7,16 +15,28 @@ public class BadmintonScoringWithStroke extends BadmintonScoring {
   private static final int PLAYER1 = 0;
   private static final int PLAYER2 = 1;
 
+  /**
+   * Creates an instance of this class with an ArrayList of points for each
+   * round.
+   *
+   * @param points a list of points for each round
+   */
   public BadmintonScoringWithStroke(ArrayList<Point> points) {
     super(new int[0][0]);
     this.points = points;
     this.scores = to2DArray(points);
   }
 
+  /**
+   * @return the name of player 1's preferred stroke.
+   */
   public String getMostUsedStrokePlayer1() {
     return maxStrokeFor(Point.PLAYER1);
   }
 
+  /**
+   * @return the name of player 2's preferred stroke.
+   */
   public String getMostUsedStrokePlayer2() {
     return maxStrokeFor(Point.PLAYER2);
   }