From a04f5ec262de028c843e38bf5864cd84953258b1 Mon Sep 17 00:00:00 2001
From: mo khan <mo@mokhan.ca>
Date: Sun, 11 Aug 2019 17:36:23 -0600
Subject: add documentation

---
 src/Q8/BadmintonScoring.java | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)

(limited to 'src/Q8/BadmintonScoring.java')

diff --git a/src/Q8/BadmintonScoring.java b/src/Q8/BadmintonScoring.java
index 56c8e40..d3c8b29 100644
--- a/src/Q8/BadmintonScoring.java
+++ b/src/Q8/BadmintonScoring.java
@@ -1,3 +1,11 @@
+/**
+ * Assignment 2, COMP268 Class: BadmintonScoring.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,22 +15,40 @@ public class BadmintonScoring {
   private static final int PLAYER1 = 0;
   private static final int PLAYER2 = 1;
 
+  /**
+   * Creates an instance of the BadmintonScoring object with a 2D array of
+   * scores.
+   *
+   * @param scores a 2D array of scores for each player.
+   */
   public BadmintonScoring(int[][] scores) {
     this.scores = scores;
   }
 
+  /**
+   * @return the longest point streak for player 1.
+   */
   public int getContinuousPointsPlayer1() {
     return this.longestStreakFor(PLAYER1);
   }
 
+  /**
+   * @return the longest point streak for player 2.
+   */
   public int getContinuousPointsPlayer2() {
     return this.longestStreakFor(PLAYER2);
   }
 
+  /**
+   * @return the final score for player 1.
+   */
   public int getPlayer1Points() {
     return this.finalScoreFor(PLAYER1);
   }
 
+  /**
+   * @return the final score for player 2.
+   */
   public int getPlayer2Points() {
     return this.finalScoreFor(PLAYER2);
   }
-- 
cgit v1.2.3