From 9817fc90939d9fd44f831ee307d3b05ad339680f Mon Sep 17 00:00:00 2001
From: Michael Rausch <mra106@uclive.ac.nz>
Date: Tue, 4 Apr 2017 19:29:05 +1200
Subject: [PATCH] Fixed JavaDoc errors by adding missing @params

---
 src/main/java/seng302/models/Leg.java  | 7 +++++++
 src/main/java/seng302/models/Race.java | 4 ++--
 2 files changed, 9 insertions(+), 2 deletions(-)

diff --git a/src/main/java/seng302/models/Leg.java b/src/main/java/seng302/models/Leg.java
index e5d5977e..8f21a6ea 100644
--- a/src/main/java/seng302/models/Leg.java
+++ b/src/main/java/seng302/models/Leg.java
@@ -41,6 +41,7 @@ public class Leg {
 
     /**
      * Get the heading of this leg
+     * @return int
      */
     public int getHeading() {
         return this.heading;
@@ -48,6 +49,7 @@ public class Leg {
 
     /**
      * Set the heading for this leg
+     * @param heading
      */
     public void setHeading(int heading) {
         this.heading = heading;
@@ -55,6 +57,7 @@ public class Leg {
 
     /**
      * Get the total distance of this leg in meters
+     * @return int
      */
     public int getDistance() {
         return this.distance;
@@ -62,6 +65,7 @@ public class Leg {
 
     /**
      * Set the distance of this leg in meters
+     * @param distance
      */
     public void setDistance(int distance) {
         this.distance = distance;
@@ -69,6 +73,7 @@ public class Leg {
 
     /**
      * Returns the marker this leg started on
+     * @return SingleMark
      */
     public SingleMark getMarker() {
         return this.startingSingleMark;
@@ -76,6 +81,7 @@ public class Leg {
 
     /**
      * Set the singleMark this leg starts on
+     * @param singleMark
      */
     public void setMarker(SingleMark singleMark) {
         this.startingSingleMark = singleMark;
@@ -83,6 +89,7 @@ public class Leg {
 
     /**
      * Returns the name of the marker this leg started on
+     * @return String
      */
     public String getMarkerLabel() {
         return this.startingSingleMark.getName();
diff --git a/src/main/java/seng302/models/Race.java b/src/main/java/seng302/models/Race.java
index 0be777ff..165d9468 100644
--- a/src/main/java/seng302/models/Race.java
+++ b/src/main/java/seng302/models/Race.java
@@ -39,7 +39,7 @@ public class Race {
     /**
      * Returns a list of boats in a random order
      *
-     * @returns a list of boats
+     * @return a list of boats
      */
     public Boat[] getShuffledBoats() {
         // Shuffle the list of boats
@@ -53,7 +53,7 @@ public class Race {
      * Returns a list of boats in the order that they
      * finished the race (position 0 is first place)
      *
-     * @returns a list of boats
+     * @return a list of boats
      */
     public Boat[] getFinishedBoats() {
         return this.finishingOrder.toArray(new Boat[this.finishingOrder.size()]);