diff --git a/racevisionGame/src/main/java/shared/xml/XMLUtilities.java b/racevisionGame/src/main/java/shared/xml/XMLUtilities.java index 0a50f77d..6106f1ff 100644 --- a/racevisionGame/src/main/java/shared/xml/XMLUtilities.java +++ b/racevisionGame/src/main/java/shared/xml/XMLUtilities.java @@ -63,10 +63,10 @@ public class XMLUtilities { * @param c The XML class to convert to. * @param The XML class to convert to. * @return The XML class object. - * @throws ParserConfigurationException - * @throws IOException - * @throws SAXException - * @throws JAXBException + * @throws ParserConfigurationException Thrown if input cannot be converted to class. + * @throws IOException Thrown if input cannot be converted to class. + * @throws SAXException Thrown if input cannot be converted to class. + * @throws JAXBException Thrown if input cannot be converted to class. */ public static T xmlToClass(InputStream i, URL schemaURL, Class c) throws ParserConfigurationException, IOException, SAXException, JAXBException { DocumentBuilder parser = DocumentBuilderFactory.newInstance().newDocumentBuilder(); diff --git a/racevisionGame/src/main/java/shared/xml/boats/BoatConfig.java b/racevisionGame/src/main/java/shared/xml/boats/BoatConfig.java index c0361b52..e3d309fc 100644 --- a/racevisionGame/src/main/java/shared/xml/boats/BoatConfig.java +++ b/racevisionGame/src/main/java/shared/xml/boats/BoatConfig.java @@ -184,7 +184,7 @@ public class BoatConfig { * Objects of the following type(s) are allowed in the list * {@link BoatConfig.Boats.Boat } * - * + * @return List of Boat entries. */ public List getBoat() { if (boat == null) { @@ -327,7 +327,7 @@ public class BoatConfig { /** * Gets the value of the sourceID property. - * + * @return source id. */ public int getSourceID() { return sourceID; @@ -335,7 +335,7 @@ public class BoatConfig { /** * Sets the value of the sourceID property. - * + * @param value new source id. */ public void setSourceID(int value) { this.sourceID = value; @@ -494,7 +494,7 @@ public class BoatConfig { /** * Gets the value of the y property. - * + * @return Y value. */ public double getY() { return y; @@ -502,7 +502,7 @@ public class BoatConfig { /** * Sets the value of the y property. - * + * @param value new y value. */ public void setY(double value) { this.y = value; @@ -510,7 +510,7 @@ public class BoatConfig { /** * Gets the value of the z property. - * + * @return z value. */ public double getZ() { return z; @@ -518,7 +518,7 @@ public class BoatConfig { /** * Sets the value of the z property. - * + * @param value new z value. */ public void setZ(double value) { this.z = value; diff --git a/racevisionGame/src/main/java/shared/xml/boats/ObjectFactory.java b/racevisionGame/src/main/java/shared/xml/boats/ObjectFactory.java index 0319de9a..ed3dbfb2 100644 --- a/racevisionGame/src/main/java/shared/xml/boats/ObjectFactory.java +++ b/racevisionGame/src/main/java/shared/xml/boats/ObjectFactory.java @@ -38,7 +38,7 @@ public class ObjectFactory { /** * Create an instance of {@link BoatConfig } - * + * @return BoatConfig. */ public BoatConfig createBoatConfig() { return new BoatConfig(); @@ -46,7 +46,7 @@ public class ObjectFactory { /** * Create an instance of {@link BoatConfig.Boats } - * + * @return Boats. */ public BoatConfig.Boats createBoatConfigBoats() { return new BoatConfig.Boats(); @@ -54,7 +54,7 @@ public class ObjectFactory { /** * Create an instance of {@link BoatConfig.Boats.Boat } - * + * @return Boat. */ public BoatConfig.Boats.Boat createBoatConfigBoatsBoat() { return new BoatConfig.Boats.Boat(); @@ -62,7 +62,7 @@ public class ObjectFactory { /** * Create an instance of {@link BoatConfig.Boats.Boat.GPSposition } - * + * @return GPSposition. */ public BoatConfig.Boats.Boat.GPSposition createBoatConfigBoatsBoatGPSposition() { return new BoatConfig.Boats.Boat.GPSposition(); diff --git a/racevisionGame/src/main/java/shared/xml/regatta/RegattaConfig.java b/racevisionGame/src/main/java/shared/xml/regatta/RegattaConfig.java index d8cc1613..eebee2ae 100644 --- a/racevisionGame/src/main/java/shared/xml/regatta/RegattaConfig.java +++ b/racevisionGame/src/main/java/shared/xml/regatta/RegattaConfig.java @@ -74,7 +74,7 @@ public class RegattaConfig { /** * Gets the value of the regattaID property. - * + * @return regatta id. */ public int getRegattaID() { return regattaID; @@ -82,7 +82,7 @@ public class RegattaConfig { /** * Sets the value of the regattaID property. - * + * @param value new regatta id. */ public void setRegattaID(int value) { this.regattaID = value; @@ -138,7 +138,7 @@ public class RegattaConfig { /** * Gets the value of the centralLatitude property. - * + * @return central latitude. */ public double getCentralLatitude() { return centralLatitude; @@ -146,7 +146,7 @@ public class RegattaConfig { /** * Sets the value of the centralLatitude property. - * + * @param value new central latitude. */ public void setCentralLatitude(double value) { this.centralLatitude = value; @@ -154,7 +154,7 @@ public class RegattaConfig { /** * Gets the value of the centralLongitude property. - * + * @return central longitude. */ public double getCentralLongitude() { return centralLongitude; @@ -162,7 +162,7 @@ public class RegattaConfig { /** * Sets the value of the centralLongitude property. - * + * @param value new central longitude. */ public void setCentralLongitude(double value) { this.centralLongitude = value; @@ -170,7 +170,7 @@ public class RegattaConfig { /** * Gets the value of the centralAltitude property. - * + * @return central altitude. */ public double getCentralAltitude() { return centralAltitude; @@ -178,7 +178,7 @@ public class RegattaConfig { /** * Sets the value of the centralAltitude property. - * + * @param value new central altitude. */ public void setCentralAltitude(double value) { this.centralAltitude = value; @@ -186,7 +186,7 @@ public class RegattaConfig { /** * Gets the value of the utcOffset property. - * + * @return utc offset. */ public double getUtcOffset() { return utcOffset; @@ -194,7 +194,7 @@ public class RegattaConfig { /** * Sets the value of the utcOffset property. - * + * @param value new utc offset. */ public void setUtcOffset(double value) { this.utcOffset = value; @@ -202,7 +202,7 @@ public class RegattaConfig { /** * Gets the value of the magneticVariation property. - * + * @return magnetic variation. */ public double getMagneticVariation() { return magneticVariation; @@ -210,7 +210,7 @@ public class RegattaConfig { /** * Sets the value of the magneticVariation property. - * + * @param value new magnetic variation. */ public void setMagneticVariation(double value) { this.magneticVariation = value;