fanwuyang
/
SENG302
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fixed java doc issues on my side #story[1092]

Browse Source
main
Fan-Wu Yang 8 years ago
parent a4e1dfb3d7
commit 8d87da6206
13 changed files with 47 additions and 41 deletions
Show Stats Download Patch File Download Diff File

4
racevisionGame/src/main/java/mock/app/Event.java
Unescape View File

@ -94,6 +94,10 @@ public class Event {
* @throws XMLReaderException Thrown if any of the xml files cannot be parsed. * @throws XMLReaderException Thrown if any of the xml files cannot be parsed.
* @throws InvalidBoatDataException Thrown if the boat xml file cannot be parsed. * @throws InvalidBoatDataException Thrown if the boat xml file cannot be parsed.
* @throws InvalidRegattaDataException Thrown if the regatta xml file cannot be parsed. * @throws InvalidRegattaDataException Thrown if the regatta xml file cannot be parsed.
* @throws ParserConfigurationException Error in parsing XML
* @throws JAXBException error in mapping the xml to a schema
* @throws SAXException error in reading the schema
* @throws IOException error in finding the schema
*/ */
public void start() throws InvalidRaceDataException, XMLReaderException, InvalidBoatDataException, InvalidRegattaDataException, ParserConfigurationException, JAXBException, SAXException, IOException { public void start() throws InvalidRaceDataException, XMLReaderException, InvalidBoatDataException, InvalidRegattaDataException, ParserConfigurationException, JAXBException, SAXException, IOException {
new Thread(connectionAcceptor, "Event.Start()->ConnectionAcceptor thread").start(); new Thread(connectionAcceptor, "Event.Start()->ConnectionAcceptor thread").start();

4
racevisionGame/src/main/java/mock/xml/RaceXMLCreator.java
Unescape View File

@ -70,6 +70,9 @@ public class RaceXMLCreator {
* @throws XMLReaderException if the xml is not readable * @throws XMLReaderException if the xml is not readable
* @throws InvalidRaceDataException if the race is invalid * @throws InvalidRaceDataException if the race is invalid
* @throws JAXBException if the Race class cannot be parsed into a xml. * @throws JAXBException if the Race class cannot be parsed into a xml.
* @throws IOException if the schema file cannot be found
* @throws SAXException error in schema file
* @throws ParserConfigurationException error in parsing the schema file
*/ */
public static String alterRaceToWind(String s, double degrees) throws XMLReaderException, InvalidRaceDataException, JAXBException, IOException, SAXException, ParserConfigurationException { public static String alterRaceToWind(String s, double degrees) throws XMLReaderException, InvalidRaceDataException, JAXBException, IOException, SAXException, ParserConfigurationException {
RaceXMLReader reader = new RaceXMLReader(s, XMLFileType.ResourcePath); RaceXMLReader reader = new RaceXMLReader(s, XMLFileType.ResourcePath);
@ -187,7 +190,6 @@ public class RaceXMLCreator {
/** /**
* Sets the xml description of the race to show the race was created now, and starts in 4 minutes * Sets the xml description of the race to show the race was created now, and starts in 4 minutes
* @param raceXML The race.xml contents. * @param raceXML The race.xml contents.
* @return String containing edited xml
*/ */
public static void setRaceXMLAtCurrentTimeToNow(XMLRace raceXML) { public static void setRaceXMLAtCurrentTimeToNow(XMLRace raceXML) {

6
racevisionGame/src/main/java/shared/xml/Race/XMLCompoundMark.java
Unescape View File

@ -83,7 +83,7 @@ public class XMLCompoundMark {
* Objects of the following type(s) are allowed in the list * Objects of the following type(s) are allowed in the list
* {@link XMLMark } * {@link XMLMark }
* *
* * @return list of marks
*/ */
public List<XMLMark> getMark() { public List<XMLMark> getMark() {
if (mark == null) { if (mark == null) {
@ -94,7 +94,7 @@ public class XMLCompoundMark {
/** /**
* Gets the value of the compoundMarkID property. * Gets the value of the compoundMarkID property.
* * @return the id of the compound mark
*/ */
public int getCompoundMarkID() { public int getCompoundMarkID() {
return compoundMarkID; return compoundMarkID;
@ -102,7 +102,7 @@ public class XMLCompoundMark {
/** /**
* Sets the value of the compoundMarkID property. * Sets the value of the compoundMarkID property.
* * @param value sets ID of the compound mark
*/ */
public void setCompoundMarkID(int value) { public void setCompoundMarkID(int value) {
this.compoundMarkID = value; this.compoundMarkID = value;

2
racevisionGame/src/main/java/shared/xml/Race/XMLCompoundMarkSequence.java
Unescape View File

@ -75,7 +75,7 @@ public class XMLCompoundMarkSequence {
* Objects of the following type(s) are allowed in the list * Objects of the following type(s) are allowed in the list
* {@link XMLCorner } * {@link XMLCorner }
* *
* * @return getCorners/legs that the boats are to sequentially pass
*/ */
public List<XMLCorner> getCorner() { public List<XMLCorner> getCorner() {
if (corner == null) { if (corner == null) {

12
racevisionGame/src/main/java/shared/xml/Race/XMLCorner.java
Unescape View File

@ -49,7 +49,7 @@ public class XMLCorner {
/** /**
* Gets the value of the compoundMarkID property. * Gets the value of the compoundMarkID property.
* * @return Id of the compound mark
*/ */
public int getCompoundMarkID() { public int getCompoundMarkID() {
return compoundMarkID; return compoundMarkID;
@ -57,7 +57,7 @@ public class XMLCorner {
/** /**
* Sets the value of the compoundMarkID property. * Sets the value of the compoundMarkID property.
* * @param value sets the id of the compound mark
*/ */
public void setCompoundMarkID(int value) { public void setCompoundMarkID(int value) {
this.compoundMarkID = value; this.compoundMarkID = value;
@ -65,7 +65,7 @@ public class XMLCorner {
/** /**
* Gets the value of the seqID property. * Gets the value of the seqID property.
* * @return the order that the mark is to be passed at
*/ */
public int getSeqID() { public int getSeqID() {
return seqID; return seqID;
@ -73,7 +73,7 @@ public class XMLCorner {
/** /**
* Sets the value of the seqID property. * Sets the value of the seqID property.
* * @param value sets the order that this corner is to appear in a race at.
*/ */
public void setSeqID(int value) { public void setSeqID(int value) {
this.seqID = value; this.seqID = value;
@ -105,7 +105,7 @@ public class XMLCorner {
/** /**
* Gets the value of the zoneSize property. * Gets the value of the zoneSize property.
* * @return the size of the leg
*/ */
public int getZoneSize() { public int getZoneSize() {
return zoneSize; return zoneSize;
@ -113,7 +113,7 @@ public class XMLCorner {
/** /**
* Sets the value of the zoneSize property. * Sets the value of the zoneSize property.
* * @param value sets the size of the corner.
*/ */
public void setZoneSize(int value) { public void setZoneSize(int value) {
this.zoneSize = value; this.zoneSize = value;

2
racevisionGame/src/main/java/shared/xml/Race/XMLCourse.java
Unescape View File

@ -88,7 +88,7 @@ public class XMLCourse {
* Objects of the following type(s) are allowed in the list * Objects of the following type(s) are allowed in the list
* {@link XMLCompoundMark } * {@link XMLCompoundMark }
* *
* * @return the compound marks in the course.
*/ */
public List<XMLCompoundMark> getCompoundMark() { public List<XMLCompoundMark> getCompoundMark() {
if (compoundMark == null) { if (compoundMark == null) {

2
racevisionGame/src/main/java/shared/xml/Race/XMLCourseLimit.java
Unescape View File

@ -74,7 +74,7 @@ public class XMLCourseLimit {
* Objects of the following type(s) are allowed in the list * Objects of the following type(s) are allowed in the list
* {@link XMLLimit } * {@link XMLLimit }
* *
* * @return the limits of the race
*/ */
public List<XMLLimit> getLimit() { public List<XMLLimit> getLimit() {
if (limit == null) { if (limit == null) {

12
racevisionGame/src/main/java/shared/xml/Race/XMLLimit.java
Unescape View File

@ -46,7 +46,7 @@ public class XMLLimit {
/** /**
* Gets the value of the lat property. * Gets the value of the lat property.
* * @return get the latitude of the limit
*/ */
public double getLat() { public double getLat() {
return lat; return lat;
@ -54,7 +54,7 @@ public class XMLLimit {
/** /**
* Sets the value of the lat property. * Sets the value of the lat property.
* * @param value sets the latitude of the limit
*/ */
public void setLat(double value) { public void setLat(double value) {
this.lat = value; this.lat = value;
@ -62,7 +62,7 @@ public class XMLLimit {
/** /**
* Gets the value of the lon property. * Gets the value of the lon property.
* * @return sets the longitude of the limit
*/ */
public double getLon() { public double getLon() {
return lon; return lon;
@ -70,7 +70,7 @@ public class XMLLimit {
/** /**
* Sets the value of the lon property. * Sets the value of the lon property.
* * @param value sets the longitude of the limit
*/ */
public void setLon(double value) { public void setLon(double value) {
this.lon = value; this.lon = value;
@ -78,7 +78,7 @@ public class XMLLimit {
/** /**
* Gets the value of the seqID property. * Gets the value of the seqID property.
* * @return gets the sequence that the limit is at.
*/ */
public int getSeqID() { public int getSeqID() {
return seqID; return seqID;
@ -86,7 +86,7 @@ public class XMLLimit {
/** /**
* Sets the value of the seqID property. * Sets the value of the seqID property.
* * @param value sets the order that this limit is to appear in.
*/ */
public void setSeqID(int value) { public void setSeqID(int value) {
this.seqID = value; this.seqID = value;

12
racevisionGame/src/main/java/shared/xml/Race/XMLMark.java
Unescape View File

@ -100,7 +100,7 @@ public class XMLMark {
/** /**
* Gets the value of the targetLat property. * Gets the value of the targetLat property.
* * @return latitude that mark is at
*/ */
public double getTargetLat() { public double getTargetLat() {
return targetLat; return targetLat;
@ -108,7 +108,7 @@ public class XMLMark {
/** /**
* Sets the value of the targetLat property. * Sets the value of the targetLat property.
* * @param value sets the latitude that the mark is at.
*/ */
public void setTargetLat(double value) { public void setTargetLat(double value) {
this.targetLat = value; this.targetLat = value;
@ -116,7 +116,7 @@ public class XMLMark {
/** /**
* Gets the value of the targetLng property. * Gets the value of the targetLng property.
* * @return the longitude the mark is at
*/ */
public double getTargetLng() { public double getTargetLng() {
return targetLng; return targetLng;
@ -124,7 +124,7 @@ public class XMLMark {
/** /**
* Sets the value of the targetLng property. * Sets the value of the targetLng property.
* * @param value sets the longitude that the value is at
*/ */
public void setTargetLng(double value) { public void setTargetLng(double value) {
this.targetLng = value; this.targetLng = value;
@ -132,7 +132,7 @@ public class XMLMark {
/** /**
* Gets the value of the sourceID property. * Gets the value of the sourceID property.
* * @return the markerboats source ID
*/ */
public int getSourceID() { public int getSourceID() {
return sourceID; return sourceID;
@ -140,7 +140,7 @@ public class XMLMark {
/** /**
* Sets the value of the sourceID property. * Sets the value of the sourceID property.
* * @param value sets the id of the boat that the mark is referencing to.
*/ */
public void setSourceID(int value) { public void setSourceID(int value) {
this.sourceID = value; this.sourceID = value;

2
racevisionGame/src/main/java/shared/xml/Race/XMLParticipants.java
Unescape View File

@ -73,7 +73,7 @@ public class XMLParticipants {
* Objects of the following type(s) are allowed in the list * Objects of the following type(s) are allowed in the list
* {@link XMLYacht } * {@link XMLYacht }
* *
* * @return the yachts that are part of the race.
*/ */
public List<XMLYacht> getYacht() { public List<XMLYacht> getYacht() {
if (yacht == null) { if (yacht == null) {

4
racevisionGame/src/main/java/shared/xml/Race/XMLRace.java
Unescape View File

@ -177,7 +177,7 @@ public class XMLRace {
/** /**
* Gets the value of the raceID property. * Gets the value of the raceID property.
* * @return the id of the race
*/ */
public int getRaceID() { public int getRaceID() {
return raceID; return raceID;
@ -185,7 +185,7 @@ public class XMLRace {
/** /**
* Sets the value of the raceID property. * Sets the value of the raceID property.
* * @param value sets the id of the race
*/ */
public void setRaceID(int value) { public void setRaceID(int value) {
this.raceID = value; this.raceID = value;

22
racevisionGame/src/main/java/shared/xml/Race/XMLRaceFactory.java
Unescape View File

@ -38,7 +38,7 @@ public class XMLRaceFactory {
/** /**
* Create an instance of {@link XMLRace } * Create an instance of {@link XMLRace }
* * @return a new instance of a race.
*/ */
public XMLRace createRace() { public XMLRace createRace() {
return new XMLRace(); return new XMLRace();
@ -46,7 +46,7 @@ public class XMLRaceFactory {
/** /**
* Create an instance of {@link XMLRaceStartTime } * Create an instance of {@link XMLRaceStartTime }
* * @return a new start time for the race
*/ */
public XMLRaceStartTime createXMLRaceStartTime() { public XMLRaceStartTime createXMLRaceStartTime() {
return new XMLRaceStartTime(); return new XMLRaceStartTime();
@ -54,7 +54,7 @@ public class XMLRaceFactory {
/** /**
* Create an instance of {@link XMLParticipants } * Create an instance of {@link XMLParticipants }
* * @return a new participant of the race
*/ */
public XMLParticipants createXMLParticipants() { public XMLParticipants createXMLParticipants() {
return new XMLParticipants(); return new XMLParticipants();
@ -62,7 +62,7 @@ public class XMLRaceFactory {
/** /**
* Create an instance of {@link XMLCompoundMarkSequence } * Create an instance of {@link XMLCompoundMarkSequence }
* * @return a new Compound Mark Sequence that hte race is to follow.
*/ */
public XMLCompoundMarkSequence createXMLCompoundMarkSequence() { public XMLCompoundMarkSequence createXMLCompoundMarkSequence() {
return new XMLCompoundMarkSequence(); return new XMLCompoundMarkSequence();
@ -70,7 +70,7 @@ public class XMLRaceFactory {
/** /**
* Create an instance of {@link XMLCourse } * Create an instance of {@link XMLCourse }
* * @return the course the race is to use.
*/ */
public XMLCourse createXMLCourse() { public XMLCourse createXMLCourse() {
return new XMLCourse(); return new XMLCourse();
@ -78,7 +78,7 @@ public class XMLRaceFactory {
/** /**
* Create an instance of {@link XMLCourseLimit } * Create an instance of {@link XMLCourseLimit }
* * @return the limits/boundaries of the course.
*/ */
public XMLCourseLimit createXMLCourseLimit() { public XMLCourseLimit createXMLCourseLimit() {
return new XMLCourseLimit(); return new XMLCourseLimit();
@ -86,7 +86,7 @@ public class XMLRaceFactory {
/** /**
* Create an instance of {@link XMLLimit } * Create an instance of {@link XMLLimit }
* * @return a point on hte boundaries
*/ */
public XMLLimit createXMLLimit() { public XMLLimit createXMLLimit() {
return new XMLLimit(); return new XMLLimit();
@ -94,7 +94,7 @@ public class XMLRaceFactory {
/** /**
* Create an instance of {@link XMLCompoundMark } * Create an instance of {@link XMLCompoundMark }
* * @return a compound mark (made out of multiple marks)
*/ */
public XMLCompoundMark createXMLCompoundMark() { public XMLCompoundMark createXMLCompoundMark() {
return new XMLCompoundMark(); return new XMLCompoundMark();
@ -102,7 +102,7 @@ public class XMLRaceFactory {
/** /**
* Create an instance of {@link XMLMark } * Create an instance of {@link XMLMark }
* * @return a mark
*/ */
public XMLMark createXMLMark() { public XMLMark createXMLMark() {
return new XMLMark(); return new XMLMark();
@ -110,7 +110,7 @@ public class XMLRaceFactory {
/** /**
* Create an instance of {@link XMLCorner } * Create an instance of {@link XMLCorner }
* * @return a corner of a compound mark sequence
*/ */
public XMLCorner createXMLCorner() { public XMLCorner createXMLCorner() {
return new XMLCorner(); return new XMLCorner();
@ -118,7 +118,7 @@ public class XMLRaceFactory {
/** /**
* Create an instance of {@link XMLYacht } * Create an instance of {@link XMLYacht }
* * @return creates a new Yacht.
*/ */
public XMLYacht createXMLYacht() { public XMLYacht createXMLYacht() {
return new XMLYacht(); return new XMLYacht();

4
racevisionGame/src/main/java/shared/xml/Race/XMLYacht.java
Unescape View File

@ -43,7 +43,7 @@ public class XMLYacht {
/** /**
* Gets the value of the sourceID property. * Gets the value of the sourceID property.
* * @return the id of the yacht
*/ */
public int getSourceID() { public int getSourceID() {
return sourceID; return sourceID;
@ -51,7 +51,7 @@ public class XMLYacht {
/** /**
* Sets the value of the sourceID property. * Sets the value of the sourceID property.
* * @param value sets the source ID of the a yacht that is participating in the race
*/ */
public void setSourceID(int value) { public void setSourceID(int value) {
this.sourceID = value; this.sourceID = value;

Write Preview
Loading…
Cancel
Save