From ff953061e6b770b21d95972462c576bf7e446364 Mon Sep 17 00:00:00 2001
From: Ben Culkin <scorpress@gmail.com>
Date: Tue, 6 Oct 2020 19:15:17 -0400
Subject: Info cleanup

---
 firmal/src/main/java/bjc/firmal/Firmal.java        | 12 +++++++
 firmal/src/main/java/bjc/firmal/FirmalBrowser.java | 37 ++++++++++++++++++++++
 firmal/src/main/java/bjc/firmal/FirmalPane.java    |  9 ++++++
 3 files changed, 58 insertions(+)

(limited to 'firmal/src/main/java/bjc')

diff --git a/firmal/src/main/java/bjc/firmal/Firmal.java b/firmal/src/main/java/bjc/firmal/Firmal.java
index 84c91d1..57bbf19 100644
--- a/firmal/src/main/java/bjc/firmal/Firmal.java
+++ b/firmal/src/main/java/bjc/firmal/Firmal.java
@@ -3,7 +3,19 @@ package bjc.firmal;
 import javax.swing.JFrame;
 import javax.swing.WindowConstants;
 
+/**
+ * Main class for Firmal.
+ * 
+ * Firmal is a image/file browser.
+ * 
+ * @author Ben Culkin
+ *
+ */
 public class Firmal {
+	/**
+	 * General main method.
+	 * @param args Currently unused CLI args.
+	 */
 	public static void main(String[] args) {
 		JFrame frame = FirmalPane.createFirmalPane();
 		frame.setDefaultCloseOperation(WindowConstants.EXIT_ON_CLOSE);
diff --git a/firmal/src/main/java/bjc/firmal/FirmalBrowser.java b/firmal/src/main/java/bjc/firmal/FirmalBrowser.java
index 37d08ac..96ca02e 100644
--- a/firmal/src/main/java/bjc/firmal/FirmalBrowser.java
+++ b/firmal/src/main/java/bjc/firmal/FirmalBrowser.java
@@ -18,10 +18,24 @@ import bjc.utils.gui.SimpleDialogs;
 import bjc.utils.gui.SimpleKeyedButton;
 import bjc.utils.gui.layout.VLayout;
 
+/**
+ * Main browser for Firmal.
+ * @author Ben Culkin
+ *
+ */
 public class FirmalBrowser extends JPanel {
+	/**
+	 * Exception thrown when we got a directory when should've gotten a non directory.
+	 * @author Ben Culkin
+	 *
+	 */
 	public class DirectoryExpected extends RuntimeException {
 		private static final long serialVersionUID = 6614868098505684922L;
 
+		/**
+		 * Create a new exception.
+		 * @param pth The path to the directory.
+		 */
 		public DirectoryExpected(String pth) {
 			super(String.format("Non-directory '%s' passed where a directory was expected", pth));
 		}
@@ -38,6 +52,11 @@ public class FirmalBrowser extends JPanel {
 
 	private JFrame root;
 
+	/**
+	 * Create a new browser.
+	 * 
+	 * @param root The root window.
+	 */
 	public FirmalBrowser(JFrame root) {
 		super();
 		
@@ -92,6 +111,9 @@ public class FirmalBrowser extends JPanel {
 		add(BorderLayout.CENTER, scrollPane);
 	}
 
+	/**
+	 * Move the browser to the next file.
+	 */
 	public void moveNext() {
 		boolean res = loadedFiles.right();
 		if (!res) {
@@ -102,6 +124,9 @@ public class FirmalBrowser extends JPanel {
 		loadFile(loadedFiles.item());
 	}
 
+	/**
+	 * Move the browser to the last file.
+	 */
 	public void moveLast() {
 		if (loadedFiles.atEnd()) {
 			SimpleDialogs.showMessage(this, "Already There", "Already at the last file");
@@ -113,6 +138,9 @@ public class FirmalBrowser extends JPanel {
 		loadFile(loadedFiles.item());
 	}
 
+	/**
+	 * Move the browser to the previous file.
+	 */
 	public void movePrevious() {
 		boolean res = loadedFiles.left();
 		if (!res) {
@@ -123,6 +151,9 @@ public class FirmalBrowser extends JPanel {
 		loadFile(loadedFiles.item());
 	}
 
+	/**
+	 * Move the browser to the first file.
+	 */
 	public void moveFirst() {
 		if (loadedFiles.position() == 0) {
 			SimpleDialogs.showMessage(this, "Already There", "Already at the first file");
@@ -134,6 +165,12 @@ public class FirmalBrowser extends JPanel {
 		loadFile(loadedFiles.item());
 	}
 
+	/**
+	 * Opens a directory, populating the list of files.
+	 * @param dir The directory to open.
+	 * 
+	 * @throws DirectoryExpected The argument must be a directory.
+	 */
 	public void openDirectory(File dir) {
 		if (!dir.isDirectory())
 			throw new DirectoryExpected(dir.getAbsolutePath());
diff --git a/firmal/src/main/java/bjc/firmal/FirmalPane.java b/firmal/src/main/java/bjc/firmal/FirmalPane.java
index 0e57462..33c125f 100644
--- a/firmal/src/main/java/bjc/firmal/FirmalPane.java
+++ b/firmal/src/main/java/bjc/firmal/FirmalPane.java
@@ -14,7 +14,16 @@ import javax.swing.KeyStroke;
 import bjc.utils.gui.SimpleFileChooser;
 import bjc.utils.gui.layout.AutosizeLayout;
 
+/**
+ * Pane for Firmal.
+ * @author Ben Culkin
+ *
+ */
 public class FirmalPane {
+	/**
+	 * Create a new Firmal Pane.
+	 * @return The firmal pane.
+	 */
 	public static JFrame createFirmalPane() {
 		JFrame mainframe = new JFrame("Firmal Browser");
 		mainframe.setLayout(new AutosizeLayout());
-- 
cgit v1.2.3