Added documentation for commands and classes

src/main/java/jterm/Client.java

@@ -25,6 +25,7 @@
 import java.util.ArrayList;
 
 public class Client implements Runnable {
+
     private static BufferedReader input;
 
     public void run() {
@@ -40,6 +41,10 @@ public void run() {
         }
     }
 
+    /**
+     * Creates new connection to server
+     * @param options
+     */
     public static void connect(ArrayList<String> options) {
         String address = "0.0.0.0";
         String portInput = "80";

src/main/java/jterm/JTerm.java

@@ -89,6 +89,10 @@ public static void main(String[] args) {
         }
     }
 
+    /**
+     * Exectues a command string
+     * @param options
+     */
     public static void executeCommand(String options) {
         List<String> optionsArray = Util.getAsArray(options);
 
@@ -110,6 +114,9 @@ public static void executeCommand(String options) {
         }
     }
 
+    /**
+     * Initialize commands
+     */
     private static void initCommands() {
         // Reflections reflections = new Reflections("jterm.command", new MethodAnnotationsScanner());
         // Set<Method> methods = reflections.getMethodsAnnotatedWith(Command.class);
@@ -175,6 +182,9 @@ private static void initCommands() {
         });
     }
 
+    /**
+     * Sets operating system
+     */
     private static void setOS() {
         String os = System.getProperty("os.name").toLowerCase();
         if (os.contains("windows")) {
@@ -188,14 +198,26 @@ private static void setOS() {
         }
     }
 
+    /**
+     * Check if headless
+     * @return true if headless
+     */
     public static boolean isHeadless() {
         return headless;
     }
 
+    /**
+     * Gets terminal
+     * @return terminal
+     */
     public static Terminal getTerminal() {
         return terminal;
     }
 
+    /**
+     * Gets commands
+     * @return Set<String> commands
+     */
     public static Set<String> getCommands() {
         return JTerm.COMMANDS.keySet();
     }
@@ -205,10 +227,18 @@ public static void setheadless(boolean b){
         headless = b;
     }
 
+    /**
+     * Sets terminal
+     * @param terminal
+     */
     public static void setTerminal(Terminal terminal) {
         JTerm.terminal = terminal;
     }
 
+    /**
+     * Sets prompt
+     * @param prompt
+     */
     public static void setPrompt(String prompt) {
         PROMPT = prompt;
     }

src/main/java/jterm/Server.java

@@ -35,6 +35,10 @@ public class Server implements Runnable {
     public static int port = 0;
     private static String line;
 
+    /**
+     * Create a server instance
+     * @param newSocket
+     */
     public Server(Socket newSocket) {
         socket = newSocket;
     }
@@ -60,6 +64,10 @@ public void run() {
         }
     }
 
+    /**
+     * Start server
+     * @param options
+     */
     public static void start(ArrayList<String> options) {
         String portInput = "80";
         for (String option : options) {

src/main/java/jterm/command/Clear.java

@@ -19,6 +19,10 @@
 
 import java.util.List;
 
+/**
+ * Clear command
+ * @Usage - clears terminal
+ */
 public class Clear {
 
 

src/main/java/jterm/command/CommandExecutor.java

@@ -40,7 +40,7 @@ public void execute(List<String> options) {
             return;
         }
         if (options.size() < minOptions) {
-            throw new CommandException("To few arguments for \'" + commandName + '\'');
+            throw new CommandException("Too few arguments for \'" + commandName + '\'');
         }
         command.accept(options);
     }

src/main/java/jterm/command/Date.java

@@ -23,6 +23,10 @@
 import java.util.Calendar;
 import java.util.List;
 
+/**
+ * Date Command
+ * @Usage - prints current date to terminal
+ */
 public class Date {
     private static final DateFormat dateFormat = new SimpleDateFormat("yyyy/MM/dd HH:mm:ss");
 

src/main/java/jterm/command/Echo.java

@@ -24,6 +24,10 @@
 
 import java.util.List;
 
+/**
+ * Echo command
+ * @Usage - outputs to terminal
+ */
 public class Echo {
     // FIXME: echo is not working correctly, for example: > echo $JAVA_HOME
     @Command(name = "echo", minOptions = 1, syntax = "echo [-h] input")

src/main/java/jterm/command/Exec.java

@@ -23,6 +23,10 @@
 import java.util.List;
 import java.util.Scanner;
 
+/**
+ * Exec command
+ * @Usage - runs executable jar
+ */
 public class Exec {
 
     @Command(name = "exec", minOptions = 1, syntax = "exec executable")

src/main/java/jterm/command/Exit.java

@@ -20,6 +20,10 @@
 
 import java.util.List;
 
+/**
+ * Exit Command
+ * @Usage - exits terminal
+ */
 public class Exit {
 
     @Command(name = "exit", syntax = "exit [-h]")

src/main/java/jterm/command/Files.java

@@ -30,6 +30,10 @@
 
 import static java.nio.file.StandardCopyOption.REPLACE_EXISTING;
 
+/**
+ * Files Command
+ * @Usage- Moves, Renames, Writes, Deletes, Reads, or Downloads a file
+ */
 public class Files {
     // @ojles and @Kaperskyguru
     @Command(name = {"mv", "move"}, minOptions = 2, syntax = "move, mv [-h] source destination")

src/main/java/jterm/command/Help.java

@@ -23,6 +23,10 @@
 import java.util.List;
 import java.util.TreeSet;
 
+/**
+ * Help command
+ * @Usage - View info about commands
+ */
 public class Help {
     @Command(name = "help")
     public static void printHelp(List<String> options) {

src/main/java/jterm/command/Pause.java

@@ -23,6 +23,10 @@
 import java.io.IOException;
 import java.util.List;
 
+/**
+ * Pause command
+ * @Usage - Pauses until user inputs a value
+ */
 public class Pause {
     @Command(name = "pause", syntax = "pause [-h] [input]")
     public void execute(List<String> options) {

src/main/java/jterm/command/Ping.java

@@ -24,6 +24,10 @@
 import java.net.Socket;
 import java.util.List;
 
+/**
+ * Ping command
+ * @Usage - Validate a connection to a server & port
+ */
 public class Ping {
     @Command(name = "ping", minOptions = 1, syntax = "ping [-h] [-p port] host")
     public static void ping(List<String> options) {

src/main/java/jterm/command/Ps.java

@@ -20,6 +20,10 @@
 
 import java.util.List;
 
+/**
+ * Ps Command
+ * @Usage - Print a list of running processes
+ */
 public class Ps {
     private static final String PS_COMMAND;
 

src/main/java/jterm/command/Time.java

@@ -23,6 +23,10 @@
 import java.util.Date;
 import java.util.List;
 
+/**
+ * Time Command
+ * @Usage - prints current time to terminal
+ */
 public class Time {
     private static final DateFormat DATE_FORMAT = new SimpleDateFormat("HH:mm:ss , z");
 

src/main/java/jterm/command/Window.java

@@ -25,6 +25,10 @@
 import java.util.ArrayList;
 import java.util.List;
 
+/**
+ * Window command
+ * @Usage - creates a new window with certain characteristics
+ */
 public class Window {
     public static int windowCount = 0;
     public static final ArrayList<Window> windows = new ArrayList<>();

src/main/java/jterm/util/FileAutocomplete.java

@@ -89,6 +89,9 @@ public static void setCommand(String command) {
         FileAutocomplete.currText = command.endsWith(" ") ? "" : commandArr[commandArr.length - 1];
     }
 
+    /**
+     * Resets variables to default values
+     */
     public static void resetVars() {
         files = null;
         fileNames = new TreeSet<>();

src/main/java/jterm/util/Util.java

@@ -37,14 +37,29 @@ public static String getRunTime(long interval) {
         return builder.toString();
     }
 
+    /**
+     * Turn string to array by splitting at each space in string
+     * @param options
+     * @return ArrayList<String>
+     */
     public static ArrayList<String> getAsArray(String options) {
         return new ArrayList<>(Arrays.asList(options.split(" ")));
     }
 
+    /**
+     * Turn List into long string
+     * @param options
+     * @return string
+     */
     public static String getAsString(List<String> options) {
         return options.toString().replaceAll("[,\\[\\]]", "");
     }
 
+    /**
+     * Get filepath for a file
+     * @param fileName
+     * @return String filepath
+     */
     public static String getFullPath(String fileName) {
         return !fileName.startsWith("/") ? String.format("%s/%s", JTerm.currentDirectory, fileName) : fileName;
     }