Update documentation

4 files changed, 238 insertions, 7 deletions

diff --git a/src/de/fhswf/in/inf/se/projektthemenvergabe/model/Ansprechpartner.java b/src/de/fhswf/in/inf/se/projektthemenvergabe/model/Ansprechpartner.java
index 7b708f4..8024467 100644
--- a/src/de/fhswf/in/inf/se/projektthemenvergabe/model/Ansprechpartner.java
+++ b/src/de/fhswf/in/inf/se/projektthemenvergabe/model/Ansprechpartner.java
@@ -11,6 +11,13 @@ import javafx.beans.property.SimpleStringProperty;
 import javafx.beans.property.StringProperty;
 import javafx.util.Callback;
 
+/**
+ * 
+ * Class Ansprechpartner to represents data.
+ *
+ * @author Dina-Marie Hanxleden & Stefan Suhren
+ * @version 1.0
+ */
 public class Ansprechpartner
 {
    private StringProperty vorname = new SimpleStringProperty();
@@ -47,7 +54,7 @@ public class Ansprechpartner
    }
 
    /**
-    * TODO Add constructor comment here
+    * Constructor of Ansprechpartner.
     *
     * @param organisation
     */
@@ -62,9 +69,9 @@ public class Ansprechpartner
    }
 
    /**
-    * TODO Add method comment here
+    * Getter for an unmodifiable list of projects.
     *
-    * @return
+    * @return Collection.unmodifiableList(projekt)
     */
    public List<Projekt> getProjekte()
    {
@@ -72,7 +79,7 @@ public class Ansprechpartner
    }
 
    /**
-    * TODO Add method comment here
+    * Add a project to Ansprechpartner.
     *
     * @param projekt
     */
@@ -82,7 +89,7 @@ public class Ansprechpartner
    }
 
    /**
-    * TODO Add method comment here
+    * Remove a project from Ansprechpartner.
     *
     * @param projekt
     */
diff --git a/src/de/fhswf/in/inf/se/projektthemenvergabe/model/Organisation.java b/src/de/fhswf/in/inf/se/projektthemenvergabe/model/Organisation.java
index 4525045..b9a6da4 100644
--- a/src/de/fhswf/in/inf/se/projektthemenvergabe/model/Organisation.java
+++ b/src/de/fhswf/in/inf/se/projektthemenvergabe/model/Organisation.java
@@ -9,6 +9,13 @@ import javafx.beans.property.SimpleStringProperty;
 import javafx.beans.property.StringProperty;
 import javafx.util.Callback;
 
+/**
+ * 
+ * Class Organisation to represents data.
+ *
+ * @author Dina-Marie Hanxleden & Stefan Suhren
+ * @version 1.0
+ */
 public class Organisation
 {
    private StringProperty name = new SimpleStringProperty("");
@@ -27,7 +34,7 @@ public class Organisation
    }
 
    /**
-    * Getter for proerty name.
+    * Getter for property name.
     * 
     * @return Returns the name.
     */
@@ -83,7 +90,7 @@ public class Organisation
    }
 
    /**
-    * TODO Add method comment here
+    * Remove the Ansprechpartner.
     *
     * @param ansprechpartner
     */
diff --git a/src/de/fhswf/in/inf/se/projektthemenvergabe/model/Projekt.java b/src/de/fhswf/in/inf/se/projektthemenvergabe/model/Projekt.java
index a2bd162..91fd89e 100644
--- a/src/de/fhswf/in/inf/se/projektthemenvergabe/model/Projekt.java
+++ b/src/de/fhswf/in/inf/se/projektthemenvergabe/model/Projekt.java
@@ -11,6 +11,13 @@ import javafx.beans.property.SimpleStringProperty;
 import javafx.beans.property.StringProperty;
 import javafx.util.Callback;
 
+/**
+ * 
+ * Class Projekt to represents data.
+ *
+ * @author Dina-Marie Hanxleden & Stefan Suhren
+ * @version 1.0
+ */
 public class Projekt
 {
    private StringProperty projektthema = new SimpleStringProperty("");
@@ -41,6 +48,11 @@ public class Projekt
       return projekt -> new Observable[] { projekt.statusProperty() };
    }
 
+   /**
+    * 
+    * Create the different StatusTypes as enums.
+    *
+    */
    public static enum StatusTypes {
       IN_BEARBEITUNG("In Bearbeitung"), EINGEREICHT(
             "Eingereicht"), IN_UEBERARBEITUNG("In Überarbeitung"), ANGENOMMEN(
@@ -59,6 +71,19 @@ public class Projekt
       }
    }
 
+   /**
+    * 
+    * Constructor of Project.
+    *
+    * @param student1
+    *           The first Student
+    * @param student2
+    *           The second Student
+    * @param student3
+    *           The third Student
+    * @param ansprechpartner
+    *           The Ansprechpartner
+    */
    public Projekt(
 
          Student student1, Student student2,
@@ -100,101 +125,220 @@ public class Projekt
       this.ansprechpartner.addProjekt(this);
    }
 
+   /**
+    * 
+    * Getter for the property projektthema.
+    *
+    * @return Returns the property projecthema
+    */
    public final StringProperty projektthemaProperty()
    {
       return this.projektthema;
    }
 
+   /**
+    * 
+    * Getter for Projektthema.
+    * 
+    * @return Returns Projektthema
+    */
    public final String getProjektthema()
    {
       return this.projektthemaProperty().get();
    }
 
+   /**
+    * 
+    * Setter for the projektthema
+    *
+    * @param projektthema
+    */
    public final void setProjektthema(final String projektthema)
    {
       this.projektthemaProperty().set(projektthema);
    }
 
+   /**
+    * 
+    * Getter for the property skizze.
+    *
+    * @return Returns the property skizze
+    */
    public final StringProperty skizzeProperty()
    {
       return this.skizze;
    }
 
+   /**
+    * 
+    * Getter for skizze.
+    *
+    * @return Returns the skizze
+    */
    public final String getSkizze()
    {
       return this.skizzeProperty().get();
    }
 
+   /**
+    * 
+    * Setter for the skizze.
+    *
+    * @param skizze
+    */
    public final void setSkizze(final String skizze)
    {
       this.skizzeProperty().set(skizze);
    }
 
+   /**
+    * 
+    * Getter for the property projektbeschreibung.
+    *
+    * @return Returns the property projektbeschreibung
+    */
    public final StringProperty projektbeschreibungProperty()
    {
       return this.projektbeschreibung;
    }
 
+   /**
+    * 
+    * Getter for projektbeschreibung.
+    *
+    * @return Returns the projektbeschriebung
+    */
    public final String getProjektbeschreibung()
    {
       return this.projektbeschreibungProperty().get();
    }
 
+   /**
+    * 
+    * Setter for projektbeschreibung.
+    *
+    * @param projektbeschreibung
+    */
    public final void setProjektbeschreibung(final String projektbeschreibung)
    {
       this.projektbeschreibungProperty().set(projektbeschreibung);
    }
 
+   /**
+    * 
+    * Getter for the property projektinhalte.
+    *
+    * @return Returns the property projektinhalte
+    */
    public final StringProperty projekteinhalteProperty()
    {
       return this.projekteinhalte;
    }
 
+   /**
+    * 
+    * Getter for projektinhalte.
+    *
+    * @return Returns the projektinhalte
+    */
    public final String getProjekteinhalte()
    {
       return this.projekteinhalteProperty().get();
    }
 
+   /**
+    * 
+    * Setter for projektinhalte.
+    *
+    * @param projekteinhalte
+    */
    public final void setProjekteinhalte(final String projekteinhalte)
    {
       this.projekteinhalteProperty().set(projekteinhalte);
    }
 
+   /**
+    * Getter for an unmodifiable list of students.
+    *
+    * @return Collection.unmodifiableList(student)
+    */
    public List<Student> getStudents()
    {
       return Collections.unmodifiableList(student);
    }
 
+   /**
+    * 
+    * Getter for Ansprechpartner of the Projekt.
+    *
+    * @return Returns the Ansprechpartner of the Projekt
+    */
    public Ansprechpartner getAnsprechpartner()
    {
       return this.ansprechpartner;
    }
 
+   /**
+    * 
+    * Getter for the property Status.
+    *
+    * @return Returns the property status
+    */
    public final ObjectProperty<StatusTypes> statusProperty()
    {
       return this.status;
    }
 
+   /**
+    * 
+    * Getter for status.
+    *
+    * @return Returns the status
+    */
    public final StatusTypes getStatus()
    {
       return this.statusProperty().get();
    }
 
+   /**
+    * 
+    * Setter of status.
+    *
+    * @param status
+    */
    public final void setStatus(final StatusTypes status)
    {
       this.statusProperty().set(status);
    }
 
+   /**
+    * 
+    * Getter of the property dozentenkommentar.
+    *
+    * @return Returns the property dozentenkommentar
+    */
    public final StringProperty dozentenkommentarProperty()
    {
       return this.dozentenkommentar;
    }
 
+   /**
+    * 
+    * Getter of dozentenkommentar.
+    *
+    * @return Returns the dozentenkommentar
+    */
    public final String getDozentenkommentar()
    {
       return this.dozentenkommentarProperty().get();
    }
 
+   /**
+    * 
+    * Setter for dozentenkommentar.
+    *
+    * @param dozentenkommentar
+    */
    public final void setDozentenkommentar(final String dozentenkommentar)
    {
       this.dozentenkommentarProperty().set(dozentenkommentar);
diff --git a/src/de/fhswf/in/inf/se/projektthemenvergabe/model/Student.java b/src/de/fhswf/in/inf/se/projektthemenvergabe/model/Student.java
index ea5b285..6890714 100644
--- a/src/de/fhswf/in/inf/se/projektthemenvergabe/model/Student.java
+++ b/src/de/fhswf/in/inf/se/projektthemenvergabe/model/Student.java
@@ -5,6 +5,13 @@ import javafx.beans.property.SimpleIntegerProperty;
 import javafx.beans.property.SimpleStringProperty;
 import javafx.beans.property.StringProperty;
 
+/**
+ * 
+ * Class Student to represents data.
+ *
+ * @author Dina-Marie Hanxleden & Stefan Suhren
+ * @version 1.0
+ */
 public class Student
 {
    private StringProperty vorname = new SimpleStringProperty("");
@@ -15,56 +22,122 @@ public class Student
 
    private Projekt projekt;
 
+   /**
+    * 
+    * Getter for the property vorname.
+    *
+    * @return Returns the property vorname
+    */
    public final StringProperty vornameProperty()
    {
       return this.vorname;
    }
 
+   /**
+    * 
+    * Getter for vorname.
+    *
+    * @return Returns the vorname
+    */
    public final String getVorname()
    {
       return this.vornameProperty().get();
    }
 
+   /**
+    * 
+    * Setter for vorname.
+    *
+    * @param vorname
+    */
    public final void setVorname(final String vorname)
    {
       this.vornameProperty().set(vorname);
    }
 
+   /**
+    * 
+    * Getter for the property nachname.
+    *
+    * @return Returns the property nachname
+    */
    public final StringProperty nachnameProperty()
    {
       return this.nachname;
    }
 
+   /**
+    * 
+    * Getter for nachname.
+    *
+    * @return Returns the nachname
+    */
    public final String getNachname()
    {
       return this.nachnameProperty().get();
    }
 
+   /**
+    * 
+    * Setter for nachname.
+    *
+    * @param nachname
+    */
    public final void setNachname(final String nachname)
    {
       this.nachnameProperty().set(nachname);
    }
 
+   /**
+    * 
+    * Getter for the property matrikelnummer.
+    *
+    * @return Returns the property matrikelnummer
+    */
    public final IntegerProperty matrikelnummerProperty()
    {
       return this.matrikelnummer;
    }
 
+   /**
+    * 
+    * Getter for matrikelnummer.
+    *
+    * @return Returns the matrikelnummer
+    */
    public final int getMatrikelnummer()
    {
       return this.matrikelnummerProperty().get();
    }
 
+   /**
+    * 
+    * Setter for matrikelnummer.
+    *
+    * @param matrikelnummer
+    */
    public final void setMatrikelnummer(final int matrikelnummer)
    {
       this.matrikelnummerProperty().set(matrikelnummer);
    }
 
+   /**
+    * 
+    * Set the Projekt to Student.
+    *
+    * @param projekt
+    */
    public void setProjekt(Projekt projekt)
    {
       this.projekt = projekt;
    }
 
+   /**
+    * 
+    * Getter for Projekt.
+    *
+    * @return Returns the Projekt of the student
+    */
    public Projekt getProjekt()
    {
       return this.projekt;