From 28c7eaa26160ab5dfb32562efabb573d5a9e2734 Mon Sep 17 00:00:00 2001 From: Andrew Lalis Date: Sat, 11 May 2019 08:39:03 +0200 Subject: [PATCH] Added javadoc strings to Person. --- .../model/people/Person.java | 20 +++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/src/main/java/nl/andrewlalis/teaching_assistant_assistant/model/people/Person.java b/src/main/java/nl/andrewlalis/teaching_assistant_assistant/model/people/Person.java index 5d7446c..c029594 100644 --- a/src/main/java/nl/andrewlalis/teaching_assistant_assistant/model/people/Person.java +++ b/src/main/java/nl/andrewlalis/teaching_assistant_assistant/model/people/Person.java @@ -18,15 +18,27 @@ import java.util.List; ) public abstract class Person extends BasicEntity { + /** + * The person's first name. + */ @Column(nullable = false) private String firstName; + /** + * The person's last name. + */ @Column(nullable = false) private String lastName; + /** + * The person's email address. + */ @Column private String emailAddress; + /** + * The person's github username. + */ @Column private String githubUsername; @@ -74,12 +86,20 @@ public abstract class Person extends BasicEntity { this.githubUsername = githubUsername; } + /** + * Assigns this person to a team. + * @param team The team to assign to. + */ public void assignToTeam(Team team) { if (!this.teams.contains(team)) { this.teams.add(team); } } + /** + * Removes this person from a team. + * @param team The team to remove from. + */ public void removeFromAssignedTeam(Team team) { this.teams.remove(team); }