mirror of
https://github.com/michaelrausch/Party-Parrots-At-Sea.git
synced 2026-05-09 06:18:44 +00:00
Fixed JavaDoc errors by adding missing @params
This commit is contained in:
@@ -41,6 +41,7 @@ public class Leg {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get the heading of this leg
|
* Get the heading of this leg
|
||||||
|
* @return int
|
||||||
*/
|
*/
|
||||||
public int getHeading() {
|
public int getHeading() {
|
||||||
return this.heading;
|
return this.heading;
|
||||||
@@ -48,6 +49,7 @@ public class Leg {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Set the heading for this leg
|
* Set the heading for this leg
|
||||||
|
* @param heading
|
||||||
*/
|
*/
|
||||||
public void setHeading(int heading) {
|
public void setHeading(int heading) {
|
||||||
this.heading = heading;
|
this.heading = heading;
|
||||||
@@ -55,6 +57,7 @@ public class Leg {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get the total distance of this leg in meters
|
* Get the total distance of this leg in meters
|
||||||
|
* @return int
|
||||||
*/
|
*/
|
||||||
public int getDistance() {
|
public int getDistance() {
|
||||||
return this.distance;
|
return this.distance;
|
||||||
@@ -62,6 +65,7 @@ public class Leg {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Set the distance of this leg in meters
|
* Set the distance of this leg in meters
|
||||||
|
* @param distance
|
||||||
*/
|
*/
|
||||||
public void setDistance(int distance) {
|
public void setDistance(int distance) {
|
||||||
this.distance = distance;
|
this.distance = distance;
|
||||||
@@ -69,6 +73,7 @@ public class Leg {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Returns the marker this leg started on
|
* Returns the marker this leg started on
|
||||||
|
* @return SingleMark
|
||||||
*/
|
*/
|
||||||
public SingleMark getMarker() {
|
public SingleMark getMarker() {
|
||||||
return this.startingSingleMark;
|
return this.startingSingleMark;
|
||||||
@@ -76,6 +81,7 @@ public class Leg {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Set the singleMark this leg starts on
|
* Set the singleMark this leg starts on
|
||||||
|
* @param singleMark
|
||||||
*/
|
*/
|
||||||
public void setMarker(SingleMark singleMark) {
|
public void setMarker(SingleMark singleMark) {
|
||||||
this.startingSingleMark = singleMark;
|
this.startingSingleMark = singleMark;
|
||||||
@@ -83,6 +89,7 @@ public class Leg {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Returns the name of the marker this leg started on
|
* Returns the name of the marker this leg started on
|
||||||
|
* @return String
|
||||||
*/
|
*/
|
||||||
public String getMarkerLabel() {
|
public String getMarkerLabel() {
|
||||||
return this.startingSingleMark.getName();
|
return this.startingSingleMark.getName();
|
||||||
|
|||||||
@@ -39,7 +39,7 @@ public class Race {
|
|||||||
/**
|
/**
|
||||||
* Returns a list of boats in a random order
|
* Returns a list of boats in a random order
|
||||||
*
|
*
|
||||||
* @returns a list of boats
|
* @return a list of boats
|
||||||
*/
|
*/
|
||||||
public Boat[] getShuffledBoats() {
|
public Boat[] getShuffledBoats() {
|
||||||
// Shuffle the list of boats
|
// Shuffle the list of boats
|
||||||
@@ -53,7 +53,7 @@ public class Race {
|
|||||||
* Returns a list of boats in the order that they
|
* Returns a list of boats in the order that they
|
||||||
* finished the race (position 0 is first place)
|
* finished the race (position 0 is first place)
|
||||||
*
|
*
|
||||||
* @returns a list of boats
|
* @return a list of boats
|
||||||
*/
|
*/
|
||||||
public Boat[] getFinishedBoats() {
|
public Boat[] getFinishedBoats() {
|
||||||
return this.finishingOrder.toArray(new Boat[this.finishingOrder.size()]);
|
return this.finishingOrder.toArray(new Boat[this.finishingOrder.size()]);
|
||||||
|
|||||||
Reference in New Issue
Block a user