librejack

commit 0dcb5a5fd3954118622fd612c776a29ca7562080
parent e519d65531b0d5f5def74bad3369b01e6149032a
Author: Michael Neuper <michael@michaelneuper.com>
Date:   Fri, 28 Apr 2023 14:36:58 +0200

Fix javadoc errors

Diffstat:
M
src/controller/Controller.java
 | 
2
+-
M
src/controller/LoginController.java
 | 
8
++++----
M
src/model/Statistics.java
 | 
3
+--
M
src/view/StatisticsGUI.java
 | 
6
++++++

4 files changed, 12 insertions(+), 7 deletions(-)
diff --git a/src/controller/Controller.java b/src/controller/Controller.java
@@ -85,7 +85,7 @@ public class Controller {
     /**
      * Sets the current player's balance.
      *
-     * @param balance
+     * @param balance player's balance
      */
     public void setBalance(double balance) {
         this.balance = balance;
diff --git a/src/controller/LoginController.java b/src/controller/LoginController.java
@@ -22,10 +22,10 @@ public class LoginController {
     /**
      * Checks whether all the entered fields are present and valid.
      *
-     * @param email
-     * @param mobileNumber
-     * @param date
-     * @param password
+     * @param email user's email
+     * @param mobileNumber South African number
+     * @param date date of birth
+     * @param password user's password
      * @return true if all fields are valid, false otherwise
      */
     public boolean areAllFieldsValid(String email, String mobileNumber, Date date, String password) {
diff --git a/src/model/Statistics.java b/src/model/Statistics.java
@@ -9,14 +9,13 @@ import com.opencsv.CSVWriter;
 import com.opencsv.exceptions.CsvValidationException;
 
 /**
- * <p>
  * The Statistics class represents a set of statistics for a blackjack game.
  * Statistics are stored in a CSV file with the following format:
  * <ul>
  * <li><b>Column 1:</b> number of wins</li>
  * <li><b>Column 2:</b> number of losses</li>
  * <li><b>Column 3:</b> number of pushes(ties)</li>
- * </ul></p>
+ * </ul>
  *
  * <p>
  * The file is named `statistics.csv` and is stored in the 'db/' directory.</p>
diff --git a/src/view/StatisticsGUI.java b/src/view/StatisticsGUI.java
@@ -18,6 +18,9 @@ public class StatisticsGUI extends javax.swing.JFrame {
 
     /**
      * Creates new form StatisticsGUI
+     *
+     * @throws java.io.IOException is there is a problem with the file reading
+     * process
      */
     public StatisticsGUI() throws IOException {
         this.stats = Statistics.load();
@@ -111,6 +114,8 @@ public class StatisticsGUI extends javax.swing.JFrame {
 
     /**
      * @param args the command line arguments
+     * @throws com.opencsv.exceptions.CsvValidationException if there is an
+     * error reading from the csv file
      */
     public static void main(String args[]) throws CsvValidationException {
         /* Set the Nimbus look and feel */
@@ -139,6 +144,7 @@ public class StatisticsGUI extends javax.swing.JFrame {
 
         /* Create and display the form */
         java.awt.EventQueue.invokeLater(new Runnable() {
+            @Override
             public void run() {
                 try {
                     new StatisticsGUI().setVisible(true);