From ef9d8884d4c5053ace44452d4c94d5685c14a34c Mon Sep 17 00:00:00 2001
From: Jessica McAuslin <jam339@uclive.ac.nz>
Date: Fri, 19 May 2017 21:39:25 +1200
Subject: [PATCH] Sparkline methods Javadoc'd

- createSparkline
- updateSparkline

#story[876]
---
 .../java/seng302/Controllers/RaceController.java    | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/visualiser/src/main/java/seng302/Controllers/RaceController.java b/visualiser/src/main/java/seng302/Controllers/RaceController.java
index 61a2e6b0..143fbc7a 100644
--- a/visualiser/src/main/java/seng302/Controllers/RaceController.java
+++ b/visualiser/src/main/java/seng302/Controllers/RaceController.java
@@ -95,6 +95,13 @@ public class RaceController extends Controller {
         });
     }
 
+    /**
+     * Creates and sets initial display for Sparkline for race positions.
+     * A data series for each boat in the race is added.
+     * Position numbers are displayed.
+     *
+     * @param boats boats to display on the sparkline
+     */
     public void createSparkLine(ObservableList<Boat> boats){
         // NOTE: Y axis is in negatives to display correct positions
 
@@ -221,6 +228,12 @@ public class RaceController extends Controller {
         });
     }
 
+    /**
+     * Updates the sparkline to display current boat positions.
+     * New points are plotted to represent each boat when required.
+     *
+     * @param boatsInRace used for current boat positions.
+     */
     public void updateSparkline(ObservableList<Boat> boatsInRace){
         int placingVal = boatsInRace.size();
         sparkLineNumber++;