diff --git a/racevisionGame/src/main/java/mock/app/Event.java b/racevisionGame/src/main/java/mock/app/Event.java index c69c9122..080e8405 100644 --- a/racevisionGame/src/main/java/mock/app/Event.java +++ b/racevisionGame/src/main/java/mock/app/Event.java @@ -39,7 +39,7 @@ public class Event { * @param regattaXML The regatta.xml file. * @param boatXML The boat.xml file. * @param type How to read the file - e.g., load as resource. - * @param boatPolars + * @param boatPolars polars that the boat uses */ public Event(String raceXML, String regattaXML, String boatXML, XMLFileType type, Polars boatPolars) { diff --git a/racevisionGame/src/main/java/shared/dataInput/RegattaDataSource.java b/racevisionGame/src/main/java/shared/dataInput/RegattaDataSource.java index 7fa9aa43..eb198cb2 100644 --- a/racevisionGame/src/main/java/shared/dataInput/RegattaDataSource.java +++ b/racevisionGame/src/main/java/shared/dataInput/RegattaDataSource.java @@ -28,7 +28,7 @@ public interface RegattaDataSource { /** * Returns the name of the course. - * @return + * @return the name of the course */ String getCourseName(); diff --git a/racevisionGame/src/main/java/shared/model/CompoundMark.java b/racevisionGame/src/main/java/shared/model/CompoundMark.java index 7070270f..b9f45753 100644 --- a/racevisionGame/src/main/java/shared/model/CompoundMark.java +++ b/racevisionGame/src/main/java/shared/model/CompoundMark.java @@ -34,6 +34,8 @@ public class CompoundMark { /** * Constructs a compound mark from a single mark. + * @param id the id of the compound mark + * @param name name of the compound mark * @param mark1 The individual mark that comprises this compound mark. */ public CompoundMark(int id, String name, Mark mark1) { @@ -47,6 +49,8 @@ public class CompoundMark { /** * Constructs a compound mark from a pair of marks. + * @param id the id of the compound mark + * @param name name of the compound mark * @param mark1 The first individual mark that comprises this compound mark. * @param mark2 The second individual mark that comprises this compound mark. */ diff --git a/racevisionGame/src/main/java/visualiser/model/GraphCoordinate.java b/racevisionGame/src/main/java/visualiser/model/GraphCoordinate.java index 8bc0baad..a6a2132b 100644 --- a/racevisionGame/src/main/java/visualiser/model/GraphCoordinate.java +++ b/racevisionGame/src/main/java/visualiser/model/GraphCoordinate.java @@ -1,10 +1,8 @@ package visualiser.model; /** - * It is a coordinate representing a location on the - * {@link ResizableRaceMap}. - * It has been converted from a {@link shared.model.GPSCoordinate} - * to display objects in their relative positions. + * It is a coordinate representing a location + * resizable race canvas */ public class GraphCoordinate { diff --git a/racevisionGame/src/main/java/visualiser/model/RaceMap.java b/racevisionGame/src/main/java/visualiser/model/RaceMap.java index c0e9b56e..1583e0a5 100644 --- a/racevisionGame/src/main/java/visualiser/model/RaceMap.java +++ b/racevisionGame/src/main/java/visualiser/model/RaceMap.java @@ -4,10 +4,7 @@ import shared.model.GPSCoordinate; /** * The base size of the map to be used for the - * {@link ResizableRaceMap} and - * {@link ResizableRaceCanvas}. It is used - * to convert {@link shared.model.GPSCoordinate}s to relative - * {@link GraphCoordinate}s. + * resizable race map */ public class RaceMap {