javadoc comments

src/test/java/com/r0r5chach/CompetitorListTest.java

@@ -6,9 +6,18 @@ import org.junit.jupiter.api.Test;
 import java.io.File;
 import java.io.FileReader;
 import java.io.IOException;
-
+/**
+ * Class that defines the test for com.r0r5chach.CompetitorList
+ * @author r0r5chach
+ */
 public class CompetitorListTest {
+    /**
+     * Attribute that stores the path to the test resources directory
+     */
     private String testPath = "src/test/resources";
+    /**
+     * Tests CompetitorList.createReportFile(String)
+     */
     @Test
     public void competitorListCreateReportFileTest() {
         char[] output = new char[10];
@@ -23,23 +32,31 @@ public class CompetitorListTest {
         }
         assertEquals("Competitor", String.valueOf(output));
     }
-
+    /**
+     * Tests CompetitorList.createErrorLog(Exception, String)
+     */
     @Test
     public void CompetitorListCreateErrorLogTest() {
         String output = CompetitorList.createErrorLog(new IOException(), testPath+"/log.txt");
         assertEquals("java.io.IOException", output);
     }
-
+    /**
+     * Tests CompetitorList.readCompetitors()
+     */
     @Test
     public void competitorListReadCompetitorsTest() {
         //Already tested in competitorListCreateReportFileTest()
     }
-
+    /**
+     * Tests CompetitorList.getCompetitors()
+     */
     @Test
     public void competitorListGetCompetitorsTest() {
         //Already tested in competitorListCreateReportFileTest()
     }
-
+    /**
+     * Tests CompetitorList.CompetitorList()
+     */
     @Test
     public void competitorListTest() {
         //Already tested in competitorListCreateReportFileTest()

src/test/java/com/r0r5chach/CompetitorRowTest.java

@@ -1,7 +1,6 @@
 package com.r0r5chach;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
-
 import org.junit.jupiter.api.Test;
 
 import com.r0r5chach.competitor.Name;
@@ -9,9 +8,14 @@ import com.r0r5chach.competitor.Rank;
 import com.r0r5chach.competitor.valorant.ValorantAgent;
 import com.r0r5chach.competitor.r6.R6Attacker;
 import com.r0r5chach.competitor.r6.R6Defender;
-
+/**
+ * Class that defines the test for com.r0r5chach.CompetitorRow
+ * @author r0r5chach
+ */
 public class CompetitorRowTest {
-    
+    /**
+     * Tests CompetitorRow.CompetitorRow(int, Name, Rank, int[])
+     */
     @Test
     public void competitorRowCompetitorTest() {
         CompetitorRow cR = new CompetitorRow(101, new Name("Joshua Perry"), Rank.GOLD, new int[]{5,5,5,5,5,5});
@@ -20,46 +24,70 @@ public class CompetitorRowTest {
         assertEquals(Rank.GOLD, cR.getPlayerLevel());
         assertEquals("5, 5, 5, 5, 5, 5", cR.getScores());
     }
-
+    /**
+     * Tests CompetitorRow.CompetitorRow(int, Name, Rank, int[], ValorantAgent)
+     */
     @Test
     public void competitorRowValorantPlayerTest() {
         CompetitorRow cR = new CompetitorRow(101, new Name("Joshua Perry"), Rank.GOLD, new int[]{5,5,5,5,5,5}, ValorantAgent.ASTRA);
         assertEquals(ValorantAgent.ASTRA.getAgent(), cR.getFavoriteAgent());
     }
-
+    /**
+     * Tests CompetitorRow.CompetitorRow(int, Name, Rank, int[], R6Attacker, R6Defender)
+     */
     @Test
     public void competitorRowR6PlayerTest() {
         CompetitorRow cR = new CompetitorRow(101, new Name("Joshua Perry"), Rank.GOLD, new int[]{5,5,5,5,5,5}, R6Attacker.GLAZ, R6Defender.CASTLE);
         assertEquals(R6Attacker.GLAZ.getAttacker(), cR.getFavoriteAttacker());
         assertEquals(R6Defender.CASTLE.getDefender(), cR.getFavoriteDefender());
     }
-
+    /**
+     * Tests CompetitorRow.getPlayerNumber()
+     */
     @Test
     public void competitorRowGetPlayerNumberTest() {
         //Already tested in competitorRowCompetitorTest()
     }
+    /**
+     * Tests CompetitorRow.getPlayerName()
+     */
     @Test
     public void competitorRowGetPlayerNameTest() {
         //Already tested in competitorRowCompetitorTest()
     }
+    /**
+     * Tests CompetitorRow.getPlayerLevel()
+     */
     @Test
     public void competitorRowGetPlayerLevelTest() {
         //Already tested in competitorRowCompetitorTest()
     }
+    /**
+     * Tests CompetitorRow.getScores()
+     */
     @Test
     public void competitorRowGetScoresTest() {
         //Already tested in competitorRowCompetitorTest()
     }
+    /**
+     * Tests CompetitorRow.getFavoriteAgent()
+     */
     @Test
     public void competitorRowGetFavoriteAgentTest() {
         //Already tested in competitorRowValorantPlayerTest()
     }
+    /**
+     * Tests CompetitorRow.getFavoriteAttacker()
+     */
     @Test
     public void competitorRowGetFavoriteAttackerTest() {
         //Already tested in competitorRowR6PlayerTest()
     }
+    /**
+     * Tests CompetitorRow.getFavoriteDefender()
+     */
     @Test
     public void competitorRowGetFavoriteDefenderTest() {
         //Already tested in competitorRowR6PlayerTest()
     }    
-}
+}

src/test/java/com/r0r5chach/CompetitorTest.java

@@ -1,5 +1,8 @@
 package com.r0r5chach;
-
+/**
+ * Class that defines the test for com.r0r5chach.competitor.Competitor
+ * @author r0r5chach
+ */
 public class CompetitorTest {
     //Already Tested in com.r0r5chach.ValorantPlayerTest.java
 }

src/test/java/com/r0r5chach/ControllerTest.java

@@ -1,15 +1,19 @@
 package com.r0r5chach;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
+import org.junit.jupiter.api.Test;
 
 import java.io.File;
 
-import org.junit.jupiter.api.Test;
-
 import com.r0r5chach.controllers.Controller;
-
+/**
+ * Class that defines the test for com.r0r5chach.controllers.Controller
+ * @author r0r5chach
+ */
 public class ControllerTest {
-    
+    /**
+     * Tests Controller.setCompetitors(CompetitorList)
+     */
     @Test
     public void controllerSetCompetitorsTest() {
         Controller c = new Controller();
@@ -24,7 +28,9 @@ public class ControllerTest {
         c.setCompetitors(cL);
         assertEquals(101, c.getCompetitors().getCompetitors().get(0).getPlayerNumber());
     }
-
+    /**
+     * Tests Controller.getCompetitors()
+     */
     @Test
     public void controllerGetCompetitorsTest() {
         //Already tested in controllerSetCompetitorsTest()

src/test/java/com/r0r5chach/FiltersControllerTest.java

@@ -1,13 +1,17 @@
 package com.r0r5chach;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
-
 import org.junit.jupiter.api.Test;
 
 import com.r0r5chach.controllers.FiltersController;
-
+/**
+ * Class that defines the test for com.r0r5chach.controllers.FiltersController
+ * @author r0r5chach
+ */
 public class FiltersControllerTest {
-
+    /**
+     * Tests FiltersController.getFilters()
+     */
     @Test
     public void filtersControllerGetFiltersTest() {
         assertEquals(null, FiltersController.getFilters());

src/test/java/com/r0r5chach/NameTest.java

@@ -1,28 +1,37 @@
 package com.r0r5chach;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
 import org.junit.jupiter.api.Test;
 
 import com.r0r5chach.competitor.Name;
-
-import static org.junit.jupiter.api.Assertions.assertEquals;
-
+/**
+ * Class that defines the test for com.r0r5chach.competitor.Name
+ * @author r0r5chach
+ */
 public class NameTest {
-
+    /**
+     * Tests Name.Name(String, String)
+     */
     @Test
-    public void nameTestFNameLName() {
+    public void nameFNameLNameTest() {
         Name n = new Name("Joshua", "Perry");
         assertEquals("Joshua", n.getFirstName());
         assertEquals("", n.getMiddleName());
         assertEquals("Perry", n.getLastName());
     }
-
+    /**
+     * Tests Name.Name(String, String, String)
+     */
     @Test
-    public void nameTestFNameMNameLName() {
+    public void nameFNameMNameLNameTest() {
         Name n = new Name("Joshua", "Luke", "Perry");
         assertEquals("Joshua", n.getFirstName());
         assertEquals("Luke", n.getMiddleName());
         assertEquals("Perry", n.getLastName());
     }
-
+    /**
+     * Tests Name.Name(String)
+     */
     @Test
     public void nameFullNameTest() {
         Name n = new Name("Joshua Luke Perry");
@@ -35,7 +44,9 @@ public class NameTest {
         assertEquals("", n.getMiddleName());
         assertEquals("Perry", n.getLastName());
     }
-
+    /**
+     * Tests Name.setFirstName(String)
+     */
     @Test
     public void nameSetFirstNameTest() {
         Name n = new Name("Joshua Luke Perry");
@@ -43,7 +54,9 @@ public class NameTest {
         n.setFirstName("Bradley");
         assertEquals("Bradley", n.getFirstName());
     }
-
+    /**
+     * Tests Name.setLastName(String)
+     */
     @Test
     public void nameSetLastNameTest() {
         Name n = new Name("Joshua Luke Perry");
@@ -51,19 +64,25 @@ public class NameTest {
         n.setLastName("Gordon-Taylor");
         assertEquals("Gordon-Taylor", n.getLastName());
     }
-
+    /**
+     * Tests Name.getFistAndLastName()
+     */
     @Test
     public void nameGetFirstAndLastNameTest() {
         Name n = new Name("Joshua Luke Perry");
         assertEquals("Joshua Perry", n.getFirstAndLastName());
     }
-
+    /**
+     * Tests Name.getLastCommaFirst()
+     */
     @Test
     public void nameGetLastCommaFirstTest() {
         Name n = new Name("Joshua Luke Perry");
         assertEquals("Perry, Joshua", n.getLastCommaFirst());
     }
-
+    /**
+     * Tests Name.getFullName()
+     */
     @Test
     public void nameGetFullNameTest() {
         Name n = new Name("Joshua Luke Perry");
@@ -71,7 +90,9 @@ public class NameTest {
         n.setMiddleName("");
         assertEquals("Joshua Perry", n.getFullName());
     }
-
+    /**
+     * Tests Name.getInitials()
+     */
     @Test
     public void nameGetInitialsTest() {
         Name n = new Name("Joshua Luke Perry");
@@ -79,25 +100,32 @@ public class NameTest {
         n.setMiddleName("");
         assertEquals("JP", n.getInitials());
     }
-
-
+    /**
+     * Tests Name.getFirstName()
+     */
     @Test
     public void nameGetFirstNameTest() {
         //Already tested in nameFNameLNameTest()
     }
-
+    /**
+     * Tests Name.getMiddleName()
+     */
     @Test
     public void nameGetMiddleNameTest() {
         //Already tested in nameFNameMNameLNameTest()
     }
-
+    /**
+     * Tests Name.getLastName()
+     */
     @Test
     public void nameGetLastNameTest() {
         //Already tested in nameFullNameTest()
     }
-
+    /**
+     * Tests Name.setMiddleName(String)
+     */
     @Test
     public void nameSetMiddleNameTest() {
         //Already tested in nameGetFullNameTest()
     }
-}
+}

src/test/java/com/r0r5chach/R6AttackerTest.java

@@ -4,12 +4,17 @@ import static org.junit.jupiter.api.Assertions.assertEquals;
 import org.junit.jupiter.api.Test;
 
 import com.r0r5chach.competitor.r6.R6Attacker;
-
-
+/**
+ * Class that defines the test for com.r0r5chach.competitor.r6.R6Attacker
+ * @author r0r5chach
+ */
 public class R6AttackerTest {
+    /**
+     * Tests R6Attacker.getAttacker()
+     */
     @Test
     public void r6AttackerGetAttackerTest() {
         R6Attacker a = R6Attacker.GLAZ;
         assertEquals("Glaz", a.getAttacker());
     }
-}
+}

src/test/java/com/r0r5chach/R6DefenderTest.java

@@ -1,16 +1,20 @@
 package com.r0r5chach;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
-
 import org.junit.jupiter.api.Test;
 
 import com.r0r5chach.competitor.r6.R6Defender;
-
+/**
+ * Class that defines the test for com.r0r5chach.competitor.r6.R6Defender
+ * @author r0r5chach
+ */
 public class R6DefenderTest {
-    
+    /**
+     * Tests R6Defender.getDefender()
+     */
     @Test
-    public void r6AttackerGetAttackerTest() {
+    public void r6AttackerGetDefenderTest() {
         R6Defender d = R6Defender.CASTLE;
         assertEquals("Castle", d.getDefender());
     }
-}
+}

src/test/java/com/r0r5chach/R6PlayerTest.java

@@ -1,7 +1,6 @@
 package com.r0r5chach;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
-
 import org.junit.jupiter.api.Test;
 
 import com.r0r5chach.competitor.Name;
@@ -9,9 +8,14 @@ import com.r0r5chach.competitor.Rank;
 import com.r0r5chach.competitor.r6.R6Attacker;
 import com.r0r5chach.competitor.r6.R6Defender;
 import com.r0r5chach.competitor.r6.R6Player;
-
+/**
+ * Class that defines the test for com.r0r5chach.competitor.r6.R6Player
+ * @author r0r5chach
+ */
 public class R6PlayerTest {
-
+    /**
+     * Tests R6Player.getFullDetails()
+     */
     @Test
     public void r6PlayerGetFullDetailsTest() {
         R6Player r6P = new R6Player(1, new Name("Joshua Perry"), Rank.BRONZE, R6Attacker.ACE, R6Defender.ALIBI, new int[]{5,5,5,5,5,5});
@@ -28,30 +32,39 @@ public class R6PlayerTest {
             Favorite Attacker: Amaru
             Favorite Defender: Aruni""", r6P.getFullDetails());
     }
-    
+    /**
+     * Tests R6Player.setFavoriteAttacker(R6Attacker)
+     */
     @Test
     public void r6PlayerSetFavoriteAttacker() {
         //Already tested in r6PlayerGetFullDetailsTest()        
     }
-
+    /**
+     * Tests R6Player.setFavoriteDefender(R6Defender)
+     */
     @Test
     public void r6PlayerSetFavoriteDefender() {
         //Already tested in r6PlayerGetFullDetailsTest()        
     }
-
+    /**
+     * Tests R6Player.getFavoriteAttacker()
+     */
     @Test
     public void r6PlayerGetFavoriteAttacker() {
         //Already tested in r6PlayerGetFullDetailsTest()
     }
-
+    /**
+     * Tests R6Player.getFavoriteAttacker()
+     */
     @Test
     public void r6PlayerGetFavoriteDefender() {
         //Already tested in r6PlayerGetFullDetailsTest()        
     }
-    
-
+    /**
+     * Tests R6Player.R6Player(int, Name, Rank, R6Attacker, R6Defender, int[])
+     */
     @Test
     public void r6PlayerTest() {
         //Already tested in r6PlayerGetFullDetailsTest()        
     }
-}
+}

src/test/java/com/r0r5chach/RankTest.java

@@ -4,12 +4,17 @@ import static org.junit.jupiter.api.Assertions.assertEquals;
 import org.junit.jupiter.api.Test;
 
 import com.r0r5chach.competitor.Rank;
-
-
+/**
+ * Class that defines the test for com.r0r5chach.competitor.Rank
+ * @author r0r5chach
+ */
 public class RankTest {
+    /**
+     * Tests Rank.getRank()
+     */
     @Test
     public void valorantRankGetRankTest() {
         Rank vR = Rank.BRONZE;
         assertEquals("Bronze", vR.getRank());
     }
-}
+}

src/test/java/com/r0r5chach/ValorantAgentTest.java

@@ -1,13 +1,20 @@
 package com.r0r5chach;
+
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import org.junit.jupiter.api.Test;
 
 import com.r0r5chach.competitor.valorant.ValorantAgent;
-
+/**
+ * Class that defines the test for com.r0r5chach.competitor.valorant.ValorantAgent
+ * @author r0r5chach
+ */
 public class ValorantAgentTest {
+    /**
+     * Tests ValorantAgent.getAgent()
+     */
     @Test
     public void valorantAgentGetAgentTest() {
         ValorantAgent vA = ValorantAgent.HARBOR;
         assertEquals("Harbor", vA.getAgent());
     }
-}
+}

src/test/java/com/r0r5chach/ValorantPlayerTest.java

@@ -1,4 +1,5 @@
 package com.r0r5chach;
+
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import org.junit.jupiter.api.Test;
 
@@ -6,7 +7,14 @@ import com.r0r5chach.competitor.Name;
 import com.r0r5chach.competitor.Rank;
 import com.r0r5chach.competitor.valorant.ValorantAgent;
 import com.r0r5chach.competitor.valorant.ValorantPlayer;
+/**
+ * Class that defines the test for com.r0r5chach.competitor.valorant.ValorantPlayer
+ * @author r0r5chach
+ */
 public class ValorantPlayerTest {
+    /**
+     * Tests ValorantPlayer.ValorantPlayer(int, Name, Rank, ValorantAgent, int[])
+     */
     @Test
     public void valorantPlayerTest() {
         int[] scores = {5,5,5,5,5,5};
@@ -17,7 +25,9 @@ public class ValorantPlayerTest {
         assertEquals("Fade", vP.getFavoriteAgent().getAgent());
         assertEquals(5, vP.getOverallScore());
     }
-
+    /**
+     * Tests ValorantPlayer.setPlayerNumber(int)
+     */
     @Test
     public void valorantPlayerTestSetPlayerNumber() {
         int[] scores = {5,5,5,5,5,5};
@@ -26,7 +36,9 @@ public class ValorantPlayerTest {
         vP.setPlayerNumber(5);
         assertEquals(5, vP.getPlayerNumber());
     }
-
+    /**
+     * Tests ValorantPlayer.setPlayerName(Name)
+     */
     @Test
     public void valorantPlayerTestSetPlayerName() {
         int[] scores = {5,5,5,5,5,5};
@@ -35,7 +47,9 @@ public class ValorantPlayerTest {
         vP.setPlayerName(new Name("Bradley Gordon-Taylor"));
         assertEquals("Bradley Gordon-Taylor", vP.getPlayerName().getFullName());
     }
-
+    /**
+     * Tests ValorantPlayer.setPlayerLevel(Rank)
+     */
     @Test
     public void valorantPlayerTestSetPlayerLevel() {
         int[] scores = {5,5,5,5,5,5};
@@ -44,7 +58,9 @@ public class ValorantPlayerTest {
         vP.setPlayerLevel(Rank.BRONZE);
         assertEquals("Bronze", vP.getPlayerLevel().getRank());
     }
-
+    /**
+     * Tests ValorantPlayer.setFavoriteAgent(ValorantAgent)
+     */
     @Test
     public void valorantPlayerTestSetFavoriteAgent() {
         int[] scores = {5,5,5,5,5,5};
@@ -53,7 +69,9 @@ public class ValorantPlayerTest {
         vP.setFavoriteAgent(ValorantAgent.VIPER);
         assertEquals("Viper", vP.getFavoriteAgent().getAgent());
     }
-
+    /**
+     * Tests ValorantPlayer.setScores(int[])
+     */
     @Test
     public void valorantPlayerTestSetScores() {
         int[] scores = {5,5,5,5,5,5};
@@ -62,14 +80,18 @@ public class ValorantPlayerTest {
         vP.setScores(new int[]{0, 0, 0, 0, 0, 0});
         assertEquals(0, vP.getOverallScore());
     }
-
+    /**
+     * Tests ValorantPlayer.getOverallScore()
+     */
     @Test
     public void valorantPlayerTestGetOverallScore() {
         int[] scores = {5,5,5,5,5,5};
         ValorantPlayer vP = new ValorantPlayer(2,new Name("Joshua Luke Perry"), Rank.GOLD, ValorantAgent.FADE, scores);
         assertEquals(5, vP.getOverallScore());
     }
-
+    /**
+     * Tests ValorantPlayer.getFullDetails()
+     */
     @Test
     public void valorantPlayerTestGetFullDetails() {
         int[] scores = {5,5,5,5,5,5};
@@ -83,7 +105,9 @@ public class ValorantPlayerTest {
                 Overall Score: 5.0
                 Favorite Agent: Fade""", vP.getFullDetails());
     }
-
+    /**
+     * Tests ValorantPlayer.getShortDetails()
+     */
     @Test
     public void valorantPlayerTestGetShortDetails() {
         int[] scores = {5,5,5,5,5,5};
@@ -91,25 +115,32 @@ public class ValorantPlayerTest {
 
         assertEquals("CN 2 (JLP) has overall score 5.0", vP.getShortDetails());
     }
-
-
+    /**
+     * Tests ValorantPlayer.getPlayerNumber()
+     */
     @Test
     public void valorantPlayerTestGetPlayerNumber() {
         //Already tested in valorantPlayerTest()
     }
-
+    /**
+     * Tests ValorantPlayer.getPlayerName()
+     */
     @Test
     public void valorantPlayerTestGetPlayerName() {
         //Already tested in valorantPlayerTest()
     }
-
+    /**
+     * Tests ValorantPlayer.getPlayerLevel()
+     */
     @Test
     public void valorantPlayerTestGetPlayerLevel() {
         //Already tested in valorantPlayerTest()
     }
-
+    /**
+     * Tests ValorantPlayer.getFavoriteAgent()
+     */
     @Test
     public void valorantPlayerTestGetFavoriteAgent() {
         //Already tested in valorantPlayerTest()
     }
-}
+}