From 3f55a453629b53ae3b06163b824fc7ab533ec0f0 Mon Sep 17 00:00:00 2001
From: Fan-Wu Yang <fwy13@uclive.ac.nz>
Date: Sun, 19 Mar 2017 22:53:57 +1300
Subject: [PATCH] Documented RaceMap - Added Constructor Documentation for
 RaceMap #documentation

---
 .idea/compiler.xml                 | 1 -
 .idea/misc.xml                     | 7 -------
 src/main/java/seng302/RaceMap.java | 9 +++++++++
 3 files changed, 9 insertions(+), 8 deletions(-)

diff --git a/.idea/compiler.xml b/.idea/compiler.xml
index 57e4c6ca..8e141d98 100644
--- a/.idea/compiler.xml
+++ b/.idea/compiler.xml
@@ -22,7 +22,6 @@
         <sourceTestOutputDir name="target/generated-test-sources/test-annotations" />
         <outputRelativeToContentRoot value="true" />
         <processorPath useClasspath="true" />
-        <module name="team-7" />
       </profile>
     </annotationProcessing>
     <bytecodeTargetLevel>
diff --git a/.idea/misc.xml b/.idea/misc.xml
index 1b5f6446..334458a7 100644
--- a/.idea/misc.xml
+++ b/.idea/misc.xml
@@ -21,13 +21,6 @@
     <option name="OPEN_IN_BROWSER" value="true" />
     <option name="OPTION_INCLUDE_LIBS" value="false" />
   </component>
-  <component name="MavenProjectsManager">
-    <option name="originalFiles">
-      <list>
-        <option value="$PROJECT_DIR$/pom.xml" />
-      </list>
-    </option>
-  </component>
   <component name="ProjectRootManager" version="2" languageLevel="JDK_1_8" default="true" assert-keyword="true" jdk-15="true" project-jdk-name="1.8" project-jdk-type="JavaSDK">
     <output url="file://$PROJECT_DIR$/out" />
   </component>
diff --git a/src/main/java/seng302/RaceMap.java b/src/main/java/seng302/RaceMap.java
index 8c30988c..1ad374ab 100644
--- a/src/main/java/seng302/RaceMap.java
+++ b/src/main/java/seng302/RaceMap.java
@@ -7,6 +7,15 @@ public class RaceMap {
     private double x1, x2, y1, y2;
     private int width, height;
 
+    /**
+     * Contructor Method.
+     * @param x1 Latitude of the top left point.
+     * @param y1 Longitude of the top left point.
+     * @param x2 Latitude of the top right point.
+     * @param y2 Longitude of the top right point.
+     * @param width width that the Canvas the race is to be drawn on is.
+     * @param height height that the Canvas the race is to be drawn on is.
+     */
     public RaceMap(double x1, double y1, double x2, double y2, int width, int height) {
         this.x1 = x1; this.x2 = x2; this.y1 = y1; this.y2 = y2; this.width = width; this.height = height;
     }