java doc fixes to fix the ci build problems
#story[1003]
This commit is contained in:
@@ -39,7 +39,7 @@ public class Event {
|
|||||||
* @param regattaXML The regatta.xml file.
|
* @param regattaXML The regatta.xml file.
|
||||||
* @param boatXML The boat.xml file.
|
* @param boatXML The boat.xml file.
|
||||||
* @param type How to read the file - e.g., load as resource.
|
* @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) {
|
public Event(String raceXML, String regattaXML, String boatXML, XMLFileType type, Polars boatPolars) {
|
||||||
|
|
||||||
|
|||||||
@@ -28,7 +28,7 @@ public interface RegattaDataSource {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Returns the name of the course.
|
* Returns the name of the course.
|
||||||
* @return
|
* @return the name of the course
|
||||||
*/
|
*/
|
||||||
String getCourseName();
|
String getCourseName();
|
||||||
|
|
||||||
|
|||||||
@@ -34,6 +34,8 @@ public class CompoundMark {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Constructs a compound mark from a single mark.
|
* 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.
|
* @param mark1 The individual mark that comprises this compound mark.
|
||||||
*/
|
*/
|
||||||
public CompoundMark(int id, String name, Mark mark1) {
|
public CompoundMark(int id, String name, Mark mark1) {
|
||||||
@@ -47,6 +49,8 @@ public class CompoundMark {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Constructs a compound mark from a pair of marks.
|
* 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 mark1 The first individual mark that comprises this compound mark.
|
||||||
* @param mark2 The second individual mark that comprises this compound mark.
|
* @param mark2 The second individual mark that comprises this compound mark.
|
||||||
*/
|
*/
|
||||||
|
|||||||
@@ -1,10 +1,8 @@
|
|||||||
package visualiser.model;
|
package visualiser.model;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* It is a coordinate representing a location on the
|
* It is a coordinate representing a location
|
||||||
* {@link ResizableRaceMap}.
|
* resizable race canvas
|
||||||
* It has been converted from a {@link shared.model.GPSCoordinate}
|
|
||||||
* to display objects in their relative positions.
|
|
||||||
*/
|
*/
|
||||||
public class GraphCoordinate {
|
public class GraphCoordinate {
|
||||||
|
|
||||||
|
|||||||
@@ -4,10 +4,7 @@ import shared.model.GPSCoordinate;
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* The base size of the map to be used for the
|
* The base size of the map to be used for the
|
||||||
* {@link ResizableRaceMap} and
|
* resizable race map
|
||||||
* {@link ResizableRaceCanvas}. It is used
|
|
||||||
* to convert {@link shared.model.GPSCoordinate}s to relative
|
|
||||||
* {@link GraphCoordinate}s.
|
|
||||||
*/
|
*/
|
||||||
public class RaceMap {
|
public class RaceMap {
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user