javadoc fixes for some warnings.

main
fjc40 8 years ago
parent b486f99dbe
commit e464ee298e

@ -29,6 +29,7 @@ public class BinaryMessageDecoderTest {
/** /**
* Tests if an XMLMessage can be encoded and decoded correctly. * Tests if an XMLMessage can be encoded and decoded correctly.
* @throws Exception if test fails.
*/ */
@Test @Test
public void xmlMessageTest() throws Exception { public void xmlMessageTest() throws Exception {

@ -21,6 +21,7 @@ public class BoatActionDecoderTest {
* Encodes and decodes a given message. * Encodes and decodes a given message.
* @param message Message to encode/decode. * @param message Message to encode/decode.
* @return The decoded message. * @return The decoded message.
* @throws InvalidMessageException If the message cannot be encoded.
*/ */
private BoatAction encodeDecodeMessage(BoatAction message) throws InvalidMessageException { private BoatAction encodeDecodeMessage(BoatAction message) throws InvalidMessageException {
@ -40,6 +41,7 @@ public class BoatActionDecoderTest {
/** /**
* Tests if a specific boat action type message can be encoded and decoded correctly. * Tests if a specific boat action type message can be encoded and decoded correctly.
* @param type The type of boat action. * @param type The type of boat action.
* @throws Exception if test fails.
*/ */
private void boatActionTypeTest(BoatActionEnum type) throws Exception { private void boatActionTypeTest(BoatActionEnum type) throws Exception {
@ -59,6 +61,7 @@ public class BoatActionDecoderTest {
/** /**
* Tests if an autopilot message can be encoded and decoded correctly. * Tests if an autopilot message can be encoded and decoded correctly.
* @throws Exception if test fails.
*/ */
@Test @Test
public void autoPilotTest() throws Exception { public void autoPilotTest() throws Exception {
@ -67,6 +70,7 @@ public class BoatActionDecoderTest {
/** /**
* Tests if a sails in message can be encoded and decoded correctly. * Tests if a sails in message can be encoded and decoded correctly.
* @throws Exception if test fails.
*/ */
@Test @Test
public void sailsInTest() throws Exception { public void sailsInTest() throws Exception {
@ -75,6 +79,7 @@ public class BoatActionDecoderTest {
/** /**
* Tests if a sails out message can be encoded and decoded correctly. * Tests if a sails out message can be encoded and decoded correctly.
* @throws Exception if test fails.
*/ */
@Test @Test
public void sailsOutTest() throws Exception { public void sailsOutTest() throws Exception {
@ -83,6 +88,7 @@ public class BoatActionDecoderTest {
/** /**
* Tests if a tack/gybe message can be encoded and decoded correctly. * Tests if a tack/gybe message can be encoded and decoded correctly.
* @throws Exception if test fails.
*/ */
@Test @Test
public void tackGybeTest() throws Exception { public void tackGybeTest() throws Exception {
@ -91,6 +97,7 @@ public class BoatActionDecoderTest {
/** /**
* Tests if an upwind message can be encoded and decoded correctly. * Tests if an upwind message can be encoded and decoded correctly.
* @throws Exception if test fails.
*/ */
@Test @Test
public void upwindTest() throws Exception { public void upwindTest() throws Exception {
@ -99,6 +106,7 @@ public class BoatActionDecoderTest {
/** /**
* Tests if a downwind message can be encoded and decoded correctly. * Tests if a downwind message can be encoded and decoded correctly.
* @throws Exception if test fails.
*/ */
@Test @Test
public void downwindTest() throws Exception { public void downwindTest() throws Exception {

@ -14,6 +14,7 @@ public class BoatLocationDecoderTest {
/** /**
* Creates a BoatLocation message, encodes it, decodes it, and checks that the result matches the starting message. * Creates a BoatLocation message, encodes it, decodes it, and checks that the result matches the starting message.
* @throws Exception if test fails.
*/ */
@Test @Test
public void boatLocationEncodeDecodeTest() throws Exception { public void boatLocationEncodeDecodeTest() throws Exception {

@ -20,6 +20,7 @@ public class HeartBeatDecoderTest {
* Encodes and decodes a given message. * Encodes and decodes a given message.
* @param message Message to encode/decode. * @param message Message to encode/decode.
* @return The decoded message. * @return The decoded message.
* @throws InvalidMessageException if the message cannot be encoded.
*/ */
private HeartBeat encodeDecodeMessage(HeartBeat message) throws InvalidMessageException { private HeartBeat encodeDecodeMessage(HeartBeat message) throws InvalidMessageException {
@ -37,6 +38,7 @@ public class HeartBeatDecoderTest {
/** /**
* Tests if a heartbeat message with a given sequence number can be encoded and decoded correctly. * Tests if a heartbeat message with a given sequence number can be encoded and decoded correctly.
* @param sequenceNumber The sequenceNumber to use. * @param sequenceNumber The sequenceNumber to use.
* @throws Exception if test fails.
*/ */
private void heartBeatTest(long sequenceNumber) throws Exception { private void heartBeatTest(long sequenceNumber) throws Exception {
@ -56,6 +58,7 @@ public class HeartBeatDecoderTest {
/** /**
* Tests if a heartbeat message with a sequence number of zero can be encoded and decoded correctly. * Tests if a heartbeat message with a sequence number of zero can be encoded and decoded correctly.
* @throws Exception if test fails.
*/ */
@Test @Test
public void heartBeatZeroTest() throws Exception { public void heartBeatZeroTest() throws Exception {
@ -64,6 +67,7 @@ public class HeartBeatDecoderTest {
/** /**
* Tests if a heartbeat message with a sequence number of 1234512 can be encoded and decoded correctly. * Tests if a heartbeat message with a sequence number of 1234512 can be encoded and decoded correctly.
* @throws Exception if test fails.
*/ */
@Test @Test
public void heartBeatNonZeroTest() throws Exception { public void heartBeatNonZeroTest() throws Exception {

@ -19,6 +19,7 @@ public class JoinAcceptanceDecoderTest {
* Encodes and decodes a given message. * Encodes and decodes a given message.
* @param message Message to encode/decode. * @param message Message to encode/decode.
* @return The decoded message. * @return The decoded message.
* @throws InvalidMessageException If the message cannot be encoded.
*/ */
private JoinAcceptance encodeDecodeMessage(JoinAcceptance message) throws InvalidMessageException { private JoinAcceptance encodeDecodeMessage(JoinAcceptance message) throws InvalidMessageException {
@ -37,6 +38,7 @@ public class JoinAcceptanceDecoderTest {
* Tests if a specific acceptance type message can be encoded and decoded correctly. * Tests if a specific acceptance type message can be encoded and decoded correctly.
* @param type The type of acceptance response. * @param type The type of acceptance response.
* @param sourceID The source ID to assign. * @param sourceID The source ID to assign.
* @throws Exception if test fails.
*/ */
private void responseTypeTest(JoinAcceptanceEnum type, int sourceID) throws Exception { private void responseTypeTest(JoinAcceptanceEnum type, int sourceID) throws Exception {
@ -57,6 +59,7 @@ public class JoinAcceptanceDecoderTest {
/** /**
* Tests if a join success message, with a source ID, can be encoded and decoded correctly. * Tests if a join success message, with a source ID, can be encoded and decoded correctly.
* @throws Exception if test fails.
*/ */
@Test @Test
public void joinSuccessSourceIDTest() throws Exception { public void joinSuccessSourceIDTest() throws Exception {
@ -65,6 +68,7 @@ public class JoinAcceptanceDecoderTest {
/** /**
* Tests if a join success message, with no source ID, can be encoded and decoded correctly. * Tests if a join success message, with no source ID, can be encoded and decoded correctly.
* @throws Exception if test fails.
*/ */
@Test @Test
public void joinSuccessNoSourceIDTest() throws Exception { public void joinSuccessNoSourceIDTest() throws Exception {
@ -73,6 +77,7 @@ public class JoinAcceptanceDecoderTest {
/** /**
* Tests if a participants full message can be encoded and decoded correctly. * Tests if a participants full message can be encoded and decoded correctly.
* @throws Exception if test fails.
*/ */
@Test @Test
public void participantFullTest() throws Exception { public void participantFullTest() throws Exception {
@ -81,6 +86,7 @@ public class JoinAcceptanceDecoderTest {
/** /**
* Tests if a ghosts full message can be encoded and decoded correctly. * Tests if a ghosts full message can be encoded and decoded correctly.
* @throws Exception if test fails.
*/ */
@Test @Test
public void ghostFullTest() throws Exception { public void ghostFullTest() throws Exception {
@ -89,6 +95,7 @@ public class JoinAcceptanceDecoderTest {
/** /**
* Tests if a server full message can be encoded and decoded correctly. * Tests if a server full message can be encoded and decoded correctly.
* @throws Exception if test fails.
*/ */
@Test @Test
public void serverFullTest() throws Exception { public void serverFullTest() throws Exception {

@ -20,6 +20,7 @@ public class RequestToJoinDecoderTest {
* Encodes and decodes a given message. * Encodes and decodes a given message.
* @param message Message to encode/decode. * @param message Message to encode/decode.
* @return The decoded message. * @return The decoded message.
* @throws InvalidMessageException If the message cannot be encoded.
*/ */
private RequestToJoin encodeDecodeMessage(RequestToJoin message) throws InvalidMessageException { private RequestToJoin encodeDecodeMessage(RequestToJoin message) throws InvalidMessageException {
@ -37,6 +38,7 @@ public class RequestToJoinDecoderTest {
/** /**
* Tests if a specific request type message can be encoded and decoded correctly. * Tests if a specific request type message can be encoded and decoded correctly.
* @param type The type of join request. * @param type The type of join request.
* @throws Exception if test fails.
*/ */
private void requestTypeTest(RequestToJoinEnum type) throws Exception { private void requestTypeTest(RequestToJoinEnum type) throws Exception {
@ -56,6 +58,7 @@ public class RequestToJoinDecoderTest {
/** /**
* Tests if a spectator request message can be encoded and decoded correctly. * Tests if a spectator request message can be encoded and decoded correctly.
* @throws Exception if test fails.
*/ */
@Test @Test
public void spectatorTest() throws Exception { public void spectatorTest() throws Exception {
@ -64,6 +67,7 @@ public class RequestToJoinDecoderTest {
/** /**
* Tests if a participant request message can be encoded and decoded correctly. * Tests if a participant request message can be encoded and decoded correctly.
* @throws Exception if test fails.
*/ */
@Test @Test
public void participantTest() throws Exception { public void participantTest() throws Exception {
@ -72,6 +76,7 @@ public class RequestToJoinDecoderTest {
/** /**
* Tests if a ghost request message can be encoded and decoded correctly. * Tests if a ghost request message can be encoded and decoded correctly.
* @throws Exception if test fails.
*/ */
@Test @Test
public void ghostTest() throws Exception { public void ghostTest() throws Exception {

@ -77,6 +77,7 @@ public class XMLMessageDecoderTest {
/** /**
* Tests if a regatta.xml message can be encoded and decoded. * Tests if a regatta.xml message can be encoded and decoded.
* @throws Exception if test fails.
*/ */
@Test @Test
public void regattaXMLMessageTest() throws Exception { public void regattaXMLMessageTest() throws Exception {
@ -86,6 +87,7 @@ public class XMLMessageDecoderTest {
/** /**
* Tests if a race.xml message can be encoded and decoded. * Tests if a race.xml message can be encoded and decoded.
* @throws Exception if test fails.
*/ */
@Test @Test
public void raceXMLMessageTest() throws Exception { public void raceXMLMessageTest() throws Exception {
@ -95,6 +97,7 @@ public class XMLMessageDecoderTest {
/** /**
* Tests if a boat.xml message can be encoded and decoded. * Tests if a boat.xml message can be encoded and decoded.
* @throws Exception if test fails.
*/ */
@Test @Test
public void boatXMLMessageTest() throws Exception { public void boatXMLMessageTest() throws Exception {

Loading…
Cancel
Save