Write JavaDoc comments

1 files changed, 22 insertions, 18 deletions

diff --git a/src/de/fhswf/in/inf/se/notepadMinusMinus/model/Grades.java b/src/de/fhswf/in/inf/se/notepadMinusMinus/model/Grades.java
index aafc1e6..18622cd 100644
--- a/src/de/fhswf/in/inf/se/notepadMinusMinus/model/Grades.java
+++ b/src/de/fhswf/in/inf/se/notepadMinusMinus/model/Grades.java
@@ -8,15 +8,16 @@ import javax.xml.bind.annotation.XmlElement;
 import javax.xml.bind.annotation.XmlRootElement;
 
 import javafx.beans.property.ObjectProperty;
+import javafx.beans.property.Property;
 import javafx.beans.property.SimpleObjectProperty;
 import javafx.collections.FXCollections;
 import javafx.collections.ObservableList;
 
 /**
- * TODO Add comment here
+ * The wrapper for the gradeList.
  *
- * @author $Author: $
- * @version $Revision: $, $Date: $ UTC
+ * @author Stefan Suhren
+ * @version 1.0
  */
 @XmlRootElement(name = "grades")
 public class Grades
@@ -31,9 +32,9 @@ public class Grades
          new BigDecimal("0.0"));
 
    /**
-    * TODO Add method comment here
+    * Get the {@link Grades} as a {@link List}.
     *
-    * @return
+    * @return The {@link List} of {@link Grade}s.
     */
    @XmlElement(name = "grade", required = true)
    public List<Grade> getGrades()
@@ -42,9 +43,10 @@ public class Grades
    }
 
    /**
-    * TODO Add method comment here
+    * Set the {@link Grades} as {@link List}.
     *
     * @param grades
+    *           The {@link List} of {@link Grade}s to set.
     */
    public void setGrades(List<Grade> grades)
    {
@@ -53,9 +55,9 @@ public class Grades
    }
 
    /**
-    * TODO Add method comment here
+    * Get the {@link ObservableList} of {@link Grade}s.
     *
-    * @return
+    * @return The {@link ObservableList}
     */
    public ObservableList<Grade> gradesProperty()
    {
@@ -63,9 +65,9 @@ public class Grades
    }
 
    /**
-    * TODO Add method comment here
+    * Get the thesis grade {@link Property}.
     *
-    * @return
+    * @return The {@link Property} grade of the thesis.
     */
    public final ObjectProperty<BigDecimal> thesisProperty()
    {
@@ -73,9 +75,9 @@ public class Grades
    }
 
    /**
-    * TODO Add method comment here
+    * Set the grade of the thesis.
     *
-    * @return
+    * @return The grade of the thesis.
     */
    @XmlAttribute(name = "thesis")
    public final BigDecimal getThesis()
@@ -84,9 +86,10 @@ public class Grades
    }
 
    /**
-    * TODO Add method comment here
+    * Set the grade of the thesis.
     *
     * @param thesis
+    *           The new grade of the thesis.
     */
    public final void setThesis(final BigDecimal thesis)
    {
@@ -94,9 +97,9 @@ public class Grades
    }
 
    /**
-    * TODO Add method comment here
+    * Get the colloquium grade {@link Property}.
     *
-    * @return
+    * @return The colloquium grade {@link Property}.
     */
    public final ObjectProperty<BigDecimal> colloquiumProperty()
    {
@@ -104,9 +107,9 @@ public class Grades
    }
 
    /**
-    * TODO Add method comment here
+    * Get the colloquium grade.
     *
-    * @return
+    * @return The colloquium grade.
     */
    @XmlAttribute(name = "colloquium")
    public final BigDecimal getColloquium()
@@ -115,9 +118,10 @@ public class Grades
    }
 
    /**
-    * TODO Add method comment here
+    * Set the colloquium grade.
     *
     * @param colloquium
+    *           The new colloquium grade.
     */
    public final void setColloquium(final BigDecimal colloquium)
    {