Merge branch 'master' of https://gitlab.dcs.aber.ac.uk/ncw/gp20

2020-05-01 14:18:30 +01:00 · 2020-05-01 14:18:30 +01:00 · 232a629fe2
commit 232a629fe2
parent b7df7c1a1b ea9619366d
16 changed files with 59 additions and 25 deletions
--- a/Tutor/src/main/java/uk/ac/aber/cs221/group20/javafx/AddWordController.java
+++ b/Tutor/src/main/java/uk/ac/aber/cs221/group20/javafx/AddWordController.java
@ -28,7 +28,7 @@ import uk.ac.aber.cs221.group20.json.DictionaryEntry;
 * @author Luke Wybar [law39]
 * @author Marcin Jakob [maj83]
 * @author Oscar Pocock [osp1]
- * @author Tom Perry [top1]
+ * @author Tom Perry [top19]
 * @author Waylen Watts [ncw]
 * @version 0.1 Initial development.
 * @see DictionaryEntry
--- a/Tutor/src/main/java/uk/ac/aber/cs221/group20/javafx/Application.java
+++ b/Tutor/src/main/java/uk/ac/aber/cs221/group20/javafx/Application.java
@ -23,7 +23,7 @@ import java.util.LinkedList;
 * @author Brad Corbett [brc9]
 * @author Henry Dugmore [hjd3]
 * @author Marcin Jakob [maj83]
- * @author Tom Perry [top1]
+ * @author Tom Perry [top19]
 * @author Oscar Pocock [osp1]
 * @author Waylen Watts [ncw]
 * @author Luke Wybar [law39]
--- a/Tutor/src/main/java/uk/ac/aber/cs221/group20/javafx/DictionaryController.java
+++ b/Tutor/src/main/java/uk/ac/aber/cs221/group20/javafx/DictionaryController.java
@ -38,7 +38,7 @@ import java.util.Comparator;
 * @author Luke Wybar [law39]
 * @author Marcin Jakob [maj83]
 * @author Oscar Pocock [osp1]
- * @author Tom Perry [top1]
+ * @author Tom Perry [top19]
 * @author Waylen Watts [ncw]
 * @version 0.1 Initial development.
 * @see DictionaryEntry
--- a/Tutor/src/main/java/uk/ac/aber/cs221/group20/javafx/FlashcardController.java
+++ b/Tutor/src/main/java/uk/ac/aber/cs221/group20/javafx/FlashcardController.java
@ -1,3 +1,9 @@
+/**
+ * @(#) FlashcardController.java 0,1 2020/05/07
+ * <p>
+ * Copyright (c) 2020 Aberystwyth University.
+ * All rights reserved.
+ */
 package uk.ac.aber.cs221.group20.javafx;

 import javafx.animation.*;
@ -26,6 +32,7 @@ import uk.ac.aber.cs221.group20.json.DictionaryEntry;
 * @see Application
 * @see DictionaryEntry
 * @see SharedCodeController
+ * @see RotateTransition
 */

 public class FlashcardController extends SharedCodeController {
@ -35,7 +42,7 @@ public class FlashcardController extends SharedCodeController {
   // /////////////////// //

   int index = 0;
-   Node card;
+   Node card; // Node that will be flipped using RotateTransition.

   @FXML
   private Text counter;
@ -58,11 +65,13 @@ public class FlashcardController extends SharedCodeController {
   /**
    * Method that initializes 'flashcard.fxml' by setting up the icons and text. This method is called automatically whenever the flashcard scene starts.
    *
+    * @see DictionaryEntry
+    * @see Image
    */
   @FXML
   private void initialize() {
-      // Call method from SharedCodeController to setup the menu screen.
-      setup();
+
+      setup(); // Call method from SharedCodeController to setup the menu screens images.
      currentPageIcon.setImage(new Image("file:src/main/resources/assets/icons/white_icons/50px/flashcard-50.png"));
      currentPageText.setText("Flashcard");
      flashcardIcon.setImage(new Image("file:src/main/resources/assets/icons/black_icons/50px/flashcard-50.png"));
@ -76,8 +85,7 @@ public class FlashcardController extends SharedCodeController {
         wordType.setText("Welsh");
      }

-      updateCounter();
-      card = flashcard;
+      updateCounter(); // Update the on screen counter and setup the flashcards images.
      flashcard.setImage(new Image("file:src/main/resources/assets/flashcard/FlashCard.png"));
      leftArrow.setImage(new Image("file:src/main/resources/assets/icons/black_icons/50px/left-50.png"));
      rightArrow.setImage(new Image("file:src/main/resources/assets/icons/black_icons/50px/right-50.png"));
@ -85,16 +93,19 @@ public class FlashcardController extends SharedCodeController {

   /**
    * Event that rotates the scenes flashcard using RotateTransition whenever the user clicks the flashcard.
+    *
    * @see RotateTransition
    */
   @FXML
   private void handleFlashcardClick() {
-      RotateTransition rotator = RotateCard(card);
+      card = flashcard;
+      RotateTransition rotator = RotateCard(card); // Call method to create the RotateTransition.
      rotator.play(); // Play the rotate transition.
   }

   /**
    * Event that switches to the previous flashcard whenever the user clicks the 'leftArrow' icon.
+    *
    * @see Application
    * @see DictionaryEntry
    */
@ -117,6 +128,7 @@ public class FlashcardController extends SharedCodeController {

   /**
    * Event that switches to the next flashcard whenever the user clicks the 'right-arrow' icon.
+    *
    * @see Application
    * @see DictionaryEntry
    */
@ -140,6 +152,7 @@ public class FlashcardController extends SharedCodeController {

   /**
    * Method that updates the onscreen counter of the current flashcard.
+    *
    * @see Application
    * @see DictionaryEntry
    */
@ -149,6 +162,7 @@ public class FlashcardController extends SharedCodeController {

   /**
    * Method that creates a RotateTransition animation for flipping the flashcard 180 degrees.
+    *
    * @param card FXML rectangle element that will be flipped.
    * @return RotateTransition that will flip the rectangle 180 degrees.
    * @see Application
--- a/Tutor/src/main/java/uk/ac/aber/cs221/group20/javafx/MatchTheMeaningController.java
+++ b/Tutor/src/main/java/uk/ac/aber/cs221/group20/javafx/MatchTheMeaningController.java
@ -27,7 +27,7 @@ import java.util.*;
 * @author Luke Wybar [law39]
 * @author Marcin Jakobik [maj83]
 * @author Oscar Pocock [osp1]
- * @author Tom Perry [top1]
+ * @author Tom Perry [top19]
 * @author Waylen Watts [ncw]
 * @version 0.4 Initial development
 * @see Application
--- a/Tutor/src/main/java/uk/ac/aber/cs221/group20/javafx/PracticeListController.java
+++ b/Tutor/src/main/java/uk/ac/aber/cs221/group20/javafx/PracticeListController.java
@ -34,7 +34,7 @@ import java.util.Comparator;
 * @author Luke Wybar [law39]
 * @author Marcin Jakob [maj83]
 * @author Oscar Pocock [osp1]
- * @author Tom Perry [top1]
+ * @author Tom Perry [top19]
 * @author Waylen Watts [ncw]
 * @version 0.1 Initial development.
 * @see DictionaryEntry
--- a/Tutor/src/main/java/uk/ac/aber/cs221/group20/javafx/ScreenSwitch.java
+++ b/Tutor/src/main/java/uk/ac/aber/cs221/group20/javafx/ScreenSwitch.java
@ -1,5 +1,10 @@
 package uk.ac.aber.cs221.group20.javafx;
-
+/**
+ * @(#) ScreenSwitch.java 0.1 2020/04/07
+ * <p>
+ * Copyright (c) 2020 Aberystwyth University.
+ * All rights reserved.
+ */
 import javafx.fxml.FXMLLoader;
 import javafx.scene.Parent;
 import javafx.scene.Scene;
@ -12,7 +17,14 @@ import java.net.URL;
 * Class that contains a sub-enumeration containing all scenes and FXML references
 * Also controls the stage, for the purpose of switching to new scenes
 *
- * @author Luke Wybar (LAW39)
+ * @author Brad Corbett [brc9]
+ * @author Henry Dugmore [hjd3]
+ * @author Kain Bryan-Jones [kab74]
+ * @author Luke Wybar [law39]
+ * @author Marcin Jakob [maj83]
+ * @author Oscar Pocock [osp1]
+ * @author Tom Perry [top19]
+ * @author Waylen Watts [ncw]
 * @version 0.1
 * @see SceneType
 */
@ -58,11 +70,12 @@ public class ScreenSwitch extends SharedCodeController {
    */
   private static Parent fxmlLoader(SceneType newScene){
      Parent root = null;
+
+      // If an error occurs while loading, print out error message and stack trace on STDIO, then crash gracefully
      try{
         String fxmlName = newScene.getFXML();
         root = FXMLLoader.load(new URL("file:src/main/resources/uk/ac/aber/cs221/group20/" + fxmlName));
-
-      }catch (IOException e){ // If an error occurs, print out error message on STDIO and crash gracefully
+      }catch (IOException e){
         System.err.print("Loading the FXML file ");
         System.err.print(newScene.getFXML());
         System.err.println(" Failed!");
@ -82,7 +95,14 @@ public class ScreenSwitch extends SharedCodeController {
       * Following the spirit of those already setup.
       * This file must be located in the resources folder in the package uk.ac.aber.cs22120.group20.
       *
-       * @author Luke Wybar (LAW39)
+       * @author Brad Corbett [brc9]
+       * @author Henry Dugmore [hjd3]
+       * @author Kain Bryan-Jones [kab74]
+       * @author Luke Wybar [law39]
+       * @author Marcin Jakob [maj83]
+       * @author Oscar Pocock [osp1]
+       * @author Tom Perry [top19]
+       * @author Waylen Watts [ncw]
       * @version 0.1
       * @see ScreenSwitch
       */
--- a/Tutor/src/main/java/uk/ac/aber/cs221/group20/javafx/SharedCodeController.java
+++ b/Tutor/src/main/java/uk/ac/aber/cs221/group20/javafx/SharedCodeController.java
@ -12,7 +12,7 @@ import uk.ac.aber.cs221.group20.json.DictionaryEntry;
 * Abstract class that contains all the shared FXML elements between the
 * different controller classes including the sliding menu and the test score counter, to reduce code
 * duplication. This will be extended by all the controller classes.
- * @Author top19
+ * @author Tom Perry [top19]
 * @Version 0.1 Initial development.
 * @see Application
 * @see DictionaryEntry
--- a/Tutor/src/main/java/uk/ac/aber/cs221/group20/javafx/SixMeaningsController.java
+++ b/Tutor/src/main/java/uk/ac/aber/cs221/group20/javafx/SixMeaningsController.java
@ -29,7 +29,7 @@ import java.util.Collections;
 * @author Luke Wybar [law39]
 * @author Marcin Jakobik [maj83]
 * @author Oscar Pocock [osp1]
- * @author Tom Perry [top1]
+ * @author Tom Perry [top19]
 * @author Waylen Watts [ncw]
 * @version 0.1 Initial development
 * @see Application
--- a/Tutor/src/main/java/uk/ac/aber/cs221/group20/json/JsonProcessing.java
+++ b/Tutor/src/main/java/uk/ac/aber/cs221/group20/json/JsonProcessing.java
@ -25,7 +25,7 @@ import java.util.LinkedList;
 * @author Luke Wybar [law39]
 * @author Marcin Jakob [maj83]
 * @author Oscar Pocock [osp1]
- * @author Tom Perry [top1]
+ * @author Tom Perry [top19]
 * @author Waylen Watts [ncw]
 * @version 0.1 Initial development.
 * @see DictionaryEntry
--- a/Tutor/src/main/java/uk/ac/aber/cs221/group20/selfassessment/AssessmentGenerator.java
+++ b/Tutor/src/main/java/uk/ac/aber/cs221/group20/selfassessment/AssessmentGenerator.java
@ -19,7 +19,7 @@ import java.util.*;
 * @author Luke Wybar [law39]
 * @author Marcin Jakob [maj83]
 * @author Oscar Pocock [osp1]
- * @author Tom Perry [top1]
+ * @author Tom Perry [top19]
 * @author Waylen Watts [ncw]
 * @version 0.1 Initial development
 * @see Question
--- a/Tutor/src/main/java/uk/ac/aber/cs221/group20/selfassessment/MatchTheMeaningQuestion.java
+++ b/Tutor/src/main/java/uk/ac/aber/cs221/group20/selfassessment/MatchTheMeaningQuestion.java
@ -13,7 +13,7 @@ import java.util.Arrays;
 * @author Luke Wybar [law39]
 * @author Marcin Jakob [maj83]
 * @author Oscar Pocock [osp1]
- * @author Tom Perry [top1]
+ * @author Tom Perry [top19]
 * @author Waylen Watts [ncw]
 * @version 0.1 Initial development
 * @see Question
--- a/Tutor/src/main/java/uk/ac/aber/cs221/group20/selfassessment/Question.java
+++ b/Tutor/src/main/java/uk/ac/aber/cs221/group20/selfassessment/Question.java
@ -17,7 +17,7 @@ import java.util.ArrayList;
 * @author Luke Wybar [law39]
 * @author Marcin Jakob [maj83]
 * @author Oscar Pocock [osp1]
- * @author Tom Perry [top1]
+ * @author Tom Perry [top19]
 * @author Waylen Watts [ncw]
 * @version 0.1 Initial development
 */
--- a/Tutor/src/main/java/uk/ac/aber/cs221/group20/selfassessment/SixMeaningsQuestion.java
+++ b/Tutor/src/main/java/uk/ac/aber/cs221/group20/selfassessment/SixMeaningsQuestion.java
@ -13,7 +13,7 @@ import java.util.Random;
 * @author Luke Wybar [law39]
 * @author Marcin Jakob [maj83]
 * @author Oscar Pocock [osp1]
- * @author Tom Perry [top1]
+ * @author Tom Perry [top19]
 * @author Waylen Watts [ncw]
 * @version 0.1 Initial development
 * @see Question
--- a/Tutor/src/main/java/uk/ac/aber/cs221/group20/selfassessment/TranslationQuestion.java
+++ b/Tutor/src/main/java/uk/ac/aber/cs221/group20/selfassessment/TranslationQuestion.java
@ -10,7 +10,7 @@ import uk.ac.aber.cs221.group20.json.DictionaryEntry;
 * @author Luke Wybar [law39]
 * @author Marcin Jakob [maj83]
 * @author Oscar Pocock [osp1]
- * @author Tom Perry [top1]
+ * @author Tom Perry [top19]
 * @author Waylen Watts [ncw]
 * @version 0.1 Initial development
 * @see Question
--- a/Tutor/src/main/java/uk/ac/aber/cs221/group20/test/QuestionTest.java
+++ b/Tutor/src/main/java/uk/ac/aber/cs221/group20/test/QuestionTest.java
@ -23,7 +23,7 @@ import static uk.ac.aber.cs221.group20.json.DictionaryEntry.wordTypeEnum.verb;
 * @author Luke Wybar [law39]
 * @author Marcin Jakob [maj83]
 * @author Oscar Pocock [osp1]
- * @author Tom Perry [top1]
+ * @author Tom Perry [top19]
 * @author Waylen Watts [ncw]
 * @version 0.1 Initial development
 * @See Question