Added docstrings to classes

Tags: #docs

src/main/java/seng302/Boat.java

@@ -1,6 +1,8 @@
 package seng302;
 
-
+/**
+* Represents a boat in the race.
+*/
 public class Boat {
 
     private String teamName; // The name of the team, this is also the name of the boat

src/main/java/seng302/Event.java

@@ -3,6 +3,10 @@ package seng302;
 import java.text.SimpleDateFormat;
 import java.util.Date;
 
+/**
+* Event class containing the time of specific event, related team/boat, and
+* event location such as leg.
+*/
 public class Event {
 
     private long time; // Time the event occurs

src/main/java/seng302/Leg.java

@@ -1,5 +1,8 @@
 package seng302;
 
+/**
+* Represents the leg of a race.
+*/
 public class Leg {
     private int heading;
     private int distance;

src/main/java/seng302/Marker.java

@@ -2,6 +2,9 @@ package seng302;
 
 import java.util.ArrayList;
 
+/**
+* Represents the marker at the beginning of a leg
+*/
 class Marker{
     private String name;
     private ArrayList<Boat> boatOrder;

src/main/java/seng302/Race.java

@@ -3,6 +3,9 @@ package seng302;
 import java.lang.reflect.Array;
 import java.util.*;
 
+/**
+* Race class containing the boats and legs in the race
+*/
 public class Race {
     private ArrayList<Boat> boats; // The boats in the race
     private ArrayList<Leg> legs; // The legs in the race