Fixed JavaDoc, spelling errors, and redundant classes

- Removed some default templates (eg: created by X)
- Wrote JavaDoc for classes that had none
- Made JavaDoc more clear for classes
- Linked JavaDoc to other classes
- Minor spelling errors fixed
- BoatInRace and BoatInRaceTest commented out (to be removed)

#story[1003]
This commit is contained in:
Jessica McAuslin
2017-06-28 20:37:01 +12:00
parent 2bbcb10458
commit cf0adb8511
39 changed files with 567 additions and 566 deletions
@@ -10,10 +10,6 @@ import java.nio.ByteBuffer;
import java.util.Arrays;
import java.util.zip.CRC32;
/**
* Created by hba56 on 21/04/17.
*/
/**
* This class can be used to decode/convert a byte array into a messageBody object, descended from AC35Data.
*/
@@ -187,7 +183,7 @@ public class BinaryMessageDecoder {
return mrDecoder.getMarkRounding();
case COURSEWIND:
//System.out.println("Couse Wind Message!");
//System.out.println("Course Wind Message!");
CourseWindDecoder cwDecoder = new CourseWindDecoder(messageBody);
return new CourseWinds(cwDecoder.getMessageVersionNumber(), cwDecoder.getByteWindID(), cwDecoder.getLoopMessages());
@@ -10,10 +10,6 @@ import static seng302.Networking.Utils.ByteConverter.intToBytes;
import static seng302.Networking.Utils.ByteConverter.longToBytes;
import static seng302.Networking.Utils.ByteConverter.shortToBytes;
/**
* Created by hba56 on 21/04/17.
*/
/**
* This class can be used to encode/convert a byte array message body, plus header data into a byte array containing the entire message, ready to send.
*/
@@ -1,9 +1,5 @@
package seng302.Networking.Exceptions;
/**
* Created by f123 on 07-May-17.
*/
/**
* Exception which is thrown when a message is read, but it is invalid in some way (CRC is wrong, sync bytes, etc...).
*/
@@ -1,10 +1,6 @@
package seng302.Networking.Messages;
/**
* Created by fwy13 on 25/04/17.
*/
import seng302.Networking.Messages.Enums.MessageType;
/**
@@ -1,9 +1,5 @@
package seng302.Networking.Messages;
/**
* Created by f123 on 21-Apr-17.
*/
import seng302.Networking.Messages.Enums.MessageType;
import seng302.Networking.Utils.AC35UnitConverter;
@@ -3,10 +3,6 @@ package seng302.Networking.Messages.Enums;
import java.util.HashMap;
import java.util.Map;
/**
* Created by esa46 on 28/04/17.
*/
/**
* Enumeration that encapsulates the various statuses a boat can have.
*/
@@ -46,8 +42,8 @@ public enum BoatStatusEnum {
private static final Map<Byte, BoatStatusEnum> byteToStatusMap = new HashMap<>();
/**
* Static initialization block. Initializes the byteToStatusMap.
/*
Static initialization block. Initializes the byteToStatusMap.
*/
static {
for (BoatStatusEnum type : BoatStatusEnum.values()) {
@@ -1,9 +1,5 @@
package seng302.Networking.Messages.Enums;
/**
* Created by hba56 on 21/04/17.
*/
import java.util.HashMap;
import java.util.Map;
@@ -49,8 +45,8 @@ public enum MessageType {
private static final Map<Byte, MessageType> byteToTypeMap = new HashMap<>();
/**
* Static initialization block. Initializes the byteToTypeMap.
/*
Static initialization block. Initializes the byteToTypeMap.
*/
static {
for (MessageType type : MessageType.values()) {
@@ -76,8 +76,8 @@ public enum RaceStatusEnum {
private static final Map<Byte, RaceStatusEnum> byteToStatusMap = new HashMap<>();
/**
* Static initialization block. Initializes the byteToStatusMap.
/*
Static initialization block. Initializes the byteToStatusMap.
*/
static {
for (RaceStatusEnum type : RaceStatusEnum.values()) {
@@ -54,8 +54,8 @@ public enum RaceTypeEnum {
private static final Map<Byte, RaceTypeEnum> byteToStatusMap = new HashMap<>();
/**
* Static initialization block. Initializes the byteToStatusMap.
/*
Static initialization block. Initializes the byteToStatusMap.
*/
static {
for (RaceTypeEnum type : RaceTypeEnum.values()) {
@@ -2,10 +2,6 @@ package seng302.Networking.Messages;
import seng302.Networking.Messages.Enums.MessageType;
/**
* Created by fwy13 on 25/04/17.
*/
/**
* Represents a Heartbeat message.
*/