From f3e4fc62084c66e2cc3d724ee593aefa0d9ccbf8 Mon Sep 17 00:00:00 2001
From: Stefan Suhren <suhren.stefan@fh-swf.de>
Date: Mon, 30 Nov 2015 23:55:49 +0100
Subject: Write JavaDoc comments

---
 src/de/fhswf/in/inf/se/notepadMinusMinus/Main.java | 38 +++++++++++++---------
 1 file changed, 22 insertions(+), 16 deletions(-)

(limited to 'src/de/fhswf/in/inf/se/notepadMinusMinus/Main.java')

diff --git a/src/de/fhswf/in/inf/se/notepadMinusMinus/Main.java b/src/de/fhswf/in/inf/se/notepadMinusMinus/Main.java
index d579e0d..c154f3f 100644
--- a/src/de/fhswf/in/inf/se/notepadMinusMinus/Main.java
+++ b/src/de/fhswf/in/inf/se/notepadMinusMinus/Main.java
@@ -18,10 +18,10 @@ import javafx.scene.layout.BorderPane;
 import javafx.stage.Stage;
 
 /**
- * TODO Add comment here
+ * The main {@link File} and {@link Stage} handling class.
  *
- * @author $Author: $
- * @version $Revision: $, $Date: $ UTC
+ * @author Stefan Suhren
+ * @version 1.0
  */
 public class Main extends Application
 {
@@ -63,9 +63,10 @@ public class Main extends Application
    }
 
    /**
-    * TODO Add method comment here
+    * Start the JavaFX {@link Application}.
     *
     * @param args
+    *           The command line arguments.
     */
    public static void main(String[] args)
    {
@@ -73,9 +74,9 @@ public class Main extends Application
    }
 
    /**
-    * TODO Add method comment here
+    * Get the global data class.
     *
-    * @return
+    * @return The global {@link Grades} object.
     */
    public Grades getGradesObject()
    {
@@ -83,9 +84,9 @@ public class Main extends Application
    }
 
    /**
-    * TODO Add method comment here
+    * Get primary {@link Stage} for various things.
     *
-    * @return
+    * @return The primary {@link Stage} of the {@link Application}.
     */
    public Stage getPrimaryStage()
    {
@@ -93,9 +94,9 @@ public class Main extends Application
    }
 
    /**
-    * TODO Add method comment here
+    * Get the {@link File} that is opened right now.
     *
-    * @return
+    * @return The open {@link File} or null if no {@link File} is open.
     */
    public File getOpenFile()
    {
@@ -103,9 +104,11 @@ public class Main extends Application
    }
 
    /**
-    * TODO Add method comment here
+    * Set the {@link File} that is open right now.
     *
     * @param openFile
+    *           The open {@link File} or null if the {@link File} is not
+    *           opened.
     */
    public void setOpenFile(File openFile)
    {
@@ -113,9 +116,9 @@ public class Main extends Application
    }
 
    /**
-    * TODO Add method comment here
+    * Get the last opened {@link File}.
     *
-    * @return
+    * @return The last location as a {@link File}.
     */
    public File getGradesFilePath()
    {
@@ -132,9 +135,10 @@ public class Main extends Application
    }
 
    /**
-    * TODO Add method comment here
+    * Set the last opened {@link File} location.
     *
     * @param file
+    *           The last location as a {@link File}.
     */
    public void setGradesFilePath(File file)
    {
@@ -156,9 +160,10 @@ public class Main extends Application
    }
 
    /**
-    * TODO Add method comment here
+    * Load data from {@link File}.
     *
     * @param file
+    *           The {@link File} to open and read.
     */
    public void loadGradesFromFile(File file)
    {
@@ -195,9 +200,10 @@ public class Main extends Application
    }
 
    /**
-    * TODO Add method comment here
+    * Save data to {@link File}.
     *
     * @param file
+    *           The {@link File} to open and write to.
     */
    public void saveGradesToFile(File file)
    {
-- 
cgit v1.2.3-70-g09d2