Initial documentation

README.md

-angular-seed-play
+COSC360 - PPMG Swimming Live Scoring
 =================
 
-This project illustrates how [WebJars](http://www.webjars.org/) can be used along with
-[requirejs](http://requirejs.org/) in relation to the popular
-[angular-seed](https://github.com/angular/angular-seed) project.
+Web Development Assignment by [David Findlay](mailto:davidjwfindlay@gmail.com)
+
+Project Uses
+* [Play Framework](https://www.playframework.com)
+* [angular-seed](https://github.com/angular/angular-seed)
+* [WebJars](http://www.webjars.org/)
+* [requirejs](http://requirejs.org/)
+* [Typesafe Activator Template](http://typesafe.com/activator/template/angular-seed-play).
+* [AngularJS](https://angularjs.org/)
+* [HTML 5 Boilerplate](https://html5boilerplate.com/)
+
 
-The project is available as a [Typesafe Activator Template](http://typesafe.com/activator/template/angular-seed-play).

app/au/org/mastersswimmingqld/ppmg/models/Athlete.java

@@ -3,6 +3,11 @@ package au.org.mastersswimmingqld.ppmg.models;
 import java.util.Date;
 import java.util.List;
 
+/**
+ * Handles details of individual athletes
+ *
+ *
+ */
 public class Athlete {
 
     private long id;
@@ -14,5 +19,6 @@ public class Athlete {
     private Date dob;
 
     private List<Team> teams;
+    private List<Entry> entries;
 
 }

app/au/org/mastersswimmingqld/ppmg/models/Entry.java

@@ -3,7 +3,8 @@ package au.org.mastersswimmingqld.ppmg.models;
 import java.util.List;
 
 /**
- * Created by david on 10/09/2016.
+ * Handles entries to meets for athletes
+ *
  */
 public class Entry {
 

app/au/org/mastersswimmingqld/ppmg/models/EntryEvent.java

@@ -3,7 +3,7 @@ package au.org.mastersswimmingqld.ppmg.models;
 import java.util.List;
 
 /**
- * Created by david on 10/09/2016.
+ * Handles events in entries
  */
 public class EntryEvent {
 

app/au/org/mastersswimmingqld/ppmg/models/Event.java

@@ -3,6 +3,9 @@ package au.org.mastersswimmingqld.ppmg.models;
 import au.org.mastersswimmingqld.ppmg.enums.Course;
 import au.org.mastersswimmingqld.ppmg.enums.Stroke;
 
+/**
+ * Handles events in meets
+ */
 public class Event {
 
     private long id;

app/au/org/mastersswimmingqld/ppmg/models/Heat.java

@@ -3,7 +3,7 @@ package au.org.mastersswimmingqld.ppmg.models;
 import java.util.Map;
 
 /**
- * Created by david on 10/09/2016.
+ * Heat handling class
  */
 public class Heat {
 

app/au/org/mastersswimmingqld/ppmg/models/Meet.java

@@ -4,7 +4,8 @@ import java.util.Date;
 import java.util.List;
 
 /**
- * Created by david on 9/09/2016.
+ * Handles details of meets
+ *
  */
 public class Meet {
 

app/au/org/mastersswimmingqld/ppmg/models/Result.java

 package au.org.mastersswimmingqld.ppmg.models;
 
 /**
- * Created by david on 10/09/2016.
+ * Handles splits and final time results
+ *
  */
 public class Result {
 

app/au/org/mastersswimmingqld/ppmg/models/Session.java

@@ -3,9 +3,6 @@ package au.org.mastersswimmingqld.ppmg.models;
 import java.time.ZonedDateTime;
 import java.util.List;
 
-/**
- * Created by david on 10/09/2016.
- */
 public class Session {
 
     private long id;

app/au/org/mastersswimmingqld/ppmg/models/Team.java

@@ -2,6 +2,10 @@ package au.org.mastersswimmingqld.ppmg.models;
 
 import java.util.List;
 
+/**
+ * Handles teams for athletes
+ *
+ */
 public class Team {
     private long id;