From d33a88d313f7081b02431d44db3f29d90ed18193 Mon Sep 17 00:00:00 2001
From: Michael Rausch <mra106@uclive.ac.nz>
Date: Wed, 8 Mar 2017 23:02:45 +1300
Subject: [PATCH] Added docstrings to classes Tags: #docs

---
 src/main/java/seng302/Boat.java   | 4 +++-
 src/main/java/seng302/Event.java  | 4 ++++
 src/main/java/seng302/Leg.java    | 3 +++
 src/main/java/seng302/Marker.java | 3 +++
 src/main/java/seng302/Race.java   | 3 +++
 5 files changed, 16 insertions(+), 1 deletion(-)

diff --git a/src/main/java/seng302/Boat.java b/src/main/java/seng302/Boat.java
index 99707181..ffda9f7c 100644
--- a/src/main/java/seng302/Boat.java
+++ b/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
diff --git a/src/main/java/seng302/Event.java b/src/main/java/seng302/Event.java
index 3dc0e87c..50b84c95 100644
--- a/src/main/java/seng302/Event.java
+++ b/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
diff --git a/src/main/java/seng302/Leg.java b/src/main/java/seng302/Leg.java
index 59966744..c16bb569 100644
--- a/src/main/java/seng302/Leg.java
+++ b/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;
diff --git a/src/main/java/seng302/Marker.java b/src/main/java/seng302/Marker.java
index cf51fab7..16f2eed0 100644
--- a/src/main/java/seng302/Marker.java
+++ b/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;
diff --git a/src/main/java/seng302/Race.java b/src/main/java/seng302/Race.java
index 071b5df6..949d4ea8 100644
--- a/src/main/java/seng302/Race.java
+++ b/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