Fixed JavaDoc errors by adding missing @params

This commit is contained in:
Michael Rausch
2017-04-04 19:29:05 +12:00
parent dde4b2fcba
commit 9817fc9093
2 changed files with 9 additions and 2 deletions
+7
View File
@@ -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();
+2 -2
View File
@@ -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()]);