Improves some documentation.

I was starting to get confused.

add-on/build.gradle

@@ -1,3 +1,12 @@
+/*
+ * Copyright (c) 2021 William Hubbard. All Rights Reserved.
+ *
+ * This module contains the browser addon that handles most of the logic for internet songs. When the :browser module is
+ * built, this addon is added to the browser's list of extensions. Then, when it is run, the addon will start the
+ * intermediary program. Then, it will receive commands from the interface through the intermediary application and
+ * manipulate the browser state based on those commands. It will then send the results of those commands back through
+ * the intermediary. The addon will also periodically shoot off updates to the browser.
+ */
 import org.apache.tools.ant.taskdefs.condition.Os
 
 import java.nio.file.Files
@@ -6,10 +15,17 @@ import java.nio.file.StandardCopyOption
 import java.util.stream.Stream
 
 configurations {
+    /**
+     * This configuration is used to export the packaged addon for installation into a browser.
+     */
     addonBuild {
         canBeConsumed = true
         canBeResolved = false
     }
+    /**
+     * The nativeApp configuration is used to import a native application that this addon will start when the browser
+     * does.
+     */
     nativeApp.extendsFrom runtime
 }
 
@@ -30,7 +46,7 @@ extension.description = "A link between the Universal Music Player and the web b
 extension.id = "universalmusic@regis.edu"
 
 /**
- * Creates an addon manifest for running
+ * Creates an addon manifest that defines details for the native application that is run when the app starts.
  */
 abstract class BuildManifest extends DefaultTask {
     @OutputFile
@@ -66,7 +82,7 @@ abstract class BuildManifest extends DefaultTask {
 }
 
 /**
- *
+ * Installs the addon manifest, adding registery keys on Windows and creating the appropriate files on Mac and Linux.
  */
 abstract class InstallAddon extends DefaultTask {
     @InputFile
@@ -97,16 +113,25 @@ dependencies {
     nativeApp project(path: ":addonInter", configuration: 'nativeBuild')
 }
 
+/**
+ * Creates a build manifest that defines details for the native application defined by nativeApp dependencies that will
+ * be run.
+ */
 tasks.register('buildManifest', BuildManifest) {
     manifests = new File(buildDir, "${extension.name.get()}.json")
 }
 
+/**
+ * Registers the build manifest to the OS, allowing for the native application to run properly.
+ * This task depends on buildManifest
+ */
 def installAddon = tasks.register('installAddon', InstallAddon) {
     inputFile = buildManifest.manifests
 }
 
 /**
  * Creates a packaged (albiet unsigned) Firefox addon from the src/main directory.
+ * This task is finished by calling installAddon
  */
 tasks.register('zipAddon', Zip) {
     dependsOn configurations.nativeApp
@@ -146,6 +171,9 @@ tasks.register("clean", Delete) {
     followSymlinks = false
 }
 
+/*
+ * Exports the packaged addon task.
+ */
 artifacts {
     addonBuild(zipAddon)
 }

add-on/src/addon/javascript/background.js

@@ -1,3 +1,52 @@
+/*
+ * Copyright (c) 2021 William Hubbard. All Rights Reserved.
+ *
+ * The background script forms the core of the addon. Running when the browser starts, it starts the native application
+ * (the intermediary program that connects to the interface). The native application will send it commands in the
+ * format of a JSON object containing a "messageNum" field (containing a session-unique identifier for that message) and
+ * "message" (containing the actual message, of which can be of any type). The message data will be forwarded to several
+ * listeners. The listeners will output a single value (or throw an error). In response to either, the addon will send
+ * a JSON object back to the native application in the following format:
+ *
+ * <code>
+ *  {
+ *      "messageNum": 0, // The ID of the message that this response corresponds to
+ *      "message": { //A wrapper that contains, among other things, the return data
+ *          "type": "edu.regis.universeplayer.browserCommands.CommandReturn", // An identifier that tells the interface to treat this data as a return value for a command
+ *          "returnValue": null, // The actual data returned by the listeners. In the event of an error, this will be null.
+ *          "confirmation": { // Contains extra metadata about how the command was executed
+ *              "type": "edu.regis.universeplayer.browserCommands.CommandConfirmation", // Another identifier for the interface
+ *              "message": "Done", // A human-readable message on the results of execution. For non-error returns, this will simply be "done."
+                "errorCode": { // If an error was thrown, this object will contain data on that. Otherwise, it will be null
+                    "type": "edu.regis.universeplayer.browserCommands.BrowserError",
+                    "name": "",
+                    "message": "",
+                    "stack", []
+ *          }
+ *      }
+ *  }
+ * </code>
+ *
+ * The default one (registered by this script) does the majority of processing. This default listener takes an object
+ * with a single "type" field that corresponds to an instance of edu.regis.universeplayer.browserCommands.BrowserQuery
+ * in the Java interface. Using that "type" field, it determines what action to take and uses extra data within the
+ * message object. Should the message be something delegated to a foreground tab (i.e. controlling a YouTube video),
+ * the listener will forward the message to the tab in the following format before returning:
+ *
+ * <code>
+ *  {
+ *      "num": 0, // The ID of the tab-specific message. This is independent of the "messageNum" field above
+ *      "message": {} // A copy of the actual message sent.
+ *  }
+ * </code>
+ *
+ * Either way,
+ *
+ * Then, whenever it receives a command from the application,
+ * it will forward that command to several listeners. One of those listeners, a default one registered by this script,
+ * does the majority of processing. If the message is marked for a specific tab (one running the foreground.js script),
+ * the message is forwarded to that tab for further processing before retrieving the value. Either way,
+ */
 let logger = new Logger("background");
 
 logger.pushUpdate = function (message)
@@ -357,6 +406,12 @@ function queryTab(tab, message)
     });
 }
 
+/**
+ * Contains a list of listeners that will act upon messages from the native app.
+ *
+ * @see handleMessage(message)
+ */
+var listeners = [
 /**
  * A callback for when the native application sends a message.
  *
@@ -365,7 +420,7 @@ function queryTab(tab, message)
  *                              or a new value.
  * @return Either the value passed on returnValue or a new value.
  */
-var listeners = [function (message, returnValue) {
+function (message, returnValue) {
     if (typeof message == "object" && "type" in message)
     {
         let type = message.type;

add-on/src/addon/javascript/foreground.js

@@ -1,3 +1,9 @@
+/*
+ * Copyright (c) 2021 William Hubbard. All Rights Reserved.
+ *
+ * The foreground script serves as the core for managing playback of a song. It receives messages forwarded from the background
+ */
+
 let logger = new Logger("foreground");
 console.debug("Loading foreground.js");
 let background;
@@ -70,7 +76,16 @@ function handleMessage(message)
 
 /**
  * Calling this function will forward playback data to the browser background (and by extension, the
- * interface) as specified by the parameters.
+ * interface) as specified by the parameters. The sent data will be in the following format:
+ *
+ * <code>
+ *  {
+ *      "type": "edu.regis.universeplayer.PlaybackInfo",
+ *      "currentSong": {},
+ *      "status": "STATUS",
+ *      "playTime": 0
+ *  }
+ * </code>
  *
  * @param {string} status   The playback status. This can be "PLAYING", "PAUSED", "STOPPED",
  *                          "FINISHED", or "EMPTY"
@@ -88,7 +103,14 @@ function onStatusUpdate(status, time, songData)
 }
 
 /**
- * Forwards an update to the background (and by extension, the interface).
+ * Forwards an update to the background (and by extension, the interface). The data will be in the following format:
+ *
+ * <code>
+ *  {
+ *      "type": "update",
+ *      "data": {} // The actual data sent.
+ *  }
+ * </code>
  *
  * @param {object|Promise} response The data to forward. If this data is a Promise, then the data
  *                                  will be forwarded upon completion.
@@ -110,10 +132,16 @@ function sendUpdate(response)
 }
 
 $(function () {
+    /*
+     * Preinitializes a few things
+     */
     while (preload.length > 0)
     {
         preload.pop()();
     }
+    /*
+     * Connects to the background.
+     */
     background = browser.runtime.connect({name:"universalMusic"});
 
 //    sendUpdate("loaded");

addonInter/build.gradle

@@ -1,13 +1,11 @@
-import org.apache.tools.ant.taskdefs.condition.Os
-
-import java.lang.reflect.Method
-import java.nio.file.Files
-import java.nio.file.Paths
-import java.nio.file.StandardCopyOption
-import java.util.stream.Stream
-
 /*
  * Copyright (c) 2021 William Hubbard. All Rights Reserved.
+ *
+ * This module contains a program separate from both the browser and the interface. Firefox's native messaging API can
+ * only start a process, it can't communicate with a process that is already running. That is where this module comes
+ * in. The browser will start this module, and the interface will create a server over the localhost. When this program
+ * is started, it connects to that server. It will then relay messages between the browser and interface, translating
+ * between JSON and serialized Java objects as needed.
  */
 plugins {
     id 'java'
@@ -16,10 +14,17 @@ plugins {
 }
 
 configurations {
+    /**
+     * The native build artifact is used by the addon build process to ensure that it knows where the executable can be
+     * found. This is because the addon needs to have the executable registered on install.
+     */
     nativeBuild {
         canBeConsumed = true
         canBeResolved = false
     }
+    /**
+     * The install configuration is used for when we are packaging up the intermediary program.
+     */
     install {
         canBeConsumed = true
         canBeResolved = false

addonInter/src/test/java/edu/regis/universeplayer/addon/BrowserLinkTest.java

@@ -0,0 +1,5 @@
+package edu.regis.universeplayer.addon;
+
+public class BrowserLinkTest
+{
+}

browser/build.gradle

@@ -1,5 +1,13 @@
 /*
  * Copyright (c) 2021 William Hubbard. All Rights Reserved.
+ *
+ * This module is responsible for handling an instance of the Firefox web browser during runtime. This will install the
+ * appropriate version of Firefox Developer edition to the application installation directory, downloading it directly
+ * from Mozilla (administrator privileges are needed on Windows). It will also compile addon dependencies and add them
+ * to the install.
+ *
+ * This is all done prior to compiling the Java component of this module. The Java component is a single library that
+ * contains the appropriate methods to launch the browser and relay messages to and from the running instance.
  */
  
 import org.apache.tools.ant.taskdefs.condition.Os
@@ -12,10 +20,16 @@ plugins {
 }
 
 configurations {
+	/**
+	 * Addons are dependencies that will be added to the Firefox installation as an extension.
+	 */
 	addon {
 		canBeConsumed = false
 		canBeResolved = true
 	}
+	/**
+	 * This will be how the browser policy and addon configuration will be exported.
+	 */
 	install {
 		canBeConsumed = true
 		canBeResolved = false
@@ -49,11 +63,6 @@ repositories {
     }
 }
 
-abstract class InstallBrowserTask extends DefaultTask {
-	@OutputFile
-	final abstract DirectoryProperty installation = project.objects.directoryProperty()
-}
-
 dependencies {
 	implementation 'org.slf4j:slf4j-api:1.7.30'
 	implementation 'org.apache.logging.log4j:log4j-api:2.13.3'
@@ -64,6 +73,11 @@ dependencies {
     addon project(path: ":add-on", configuration: 'addonBuild')
 }
 
+/**
+ * Downloads the 64-bit Linux Firefox installer.
+ *
+ * @return The msi file that installs firefox.
+ */
 task downloadWindows_x86_64(type: Download) {
     src "https://download-installer.cdn.mozilla.net/pub/${firefox_module}/releases/${firefox_revision}/win64/en-US/Firefox%20Setup%20${firefox_revision}.msi"
     dest layout.buildDirectory.file("installer.msi")
@@ -71,6 +85,11 @@ task downloadWindows_x86_64(type: Download) {
 	onlyIfModified true
 }
 
+/**
+ * Downloads the 32-bit Linux Firefox installer.
+ *
+ * @return The msi file that installs firefox.
+ */
 task downloadWindows_x86(type: Download) {
     src "https://download-installer.cdn.mozilla.net/pub/${firefox_module}/releases/${firefox_revision}/win32/en-US/Firefox%20Setup%20${firefox_revision}.msi"
     dest layout.buildDirectory.file("installer.msi")
@@ -78,6 +97,11 @@ task downloadWindows_x86(type: Download) {
 	onlyIfModified true
 }
 
+/**
+ * Downloads the 64-bit Linux Firefox installation.
+ *
+ * @return The tar file that contains the Firefox download.
+ */
 task downloadLinux_x86_64(type: Download) {
     src "https://download-installer.cdn.mozilla.net/pub/${firefox_module}/releases/${firefox_revision}/linux-x86_64/en-US/firefox-${firefox_revision}.tar.bz2"
     dest layout.buildDirectory.file("installer.tar.bz2")
@@ -85,6 +109,11 @@ task downloadLinux_x86_64(type: Download) {
 	onlyIfModified true
 }
 
+/**
+ * Downloads the 32-bit Linux Firefox installation.
+ *
+ * @return The tar file that contains the Firefox download.
+ */
 task downloadLinux_i686(type: Download) {
     src "https://download-installer.cdn.mozilla.net/pub/${firefox_module}/releases/${firefox_revision}/linux-i686/en-US/firefox-${firefox_revision}.tar.bz2"
     dest layout.buildDirectory.file("installer.tar.bz2")
@@ -92,6 +121,14 @@ task downloadLinux_i686(type: Download) {
 	onlyIfModified true
 }
 
+/**
+ * Installs the 64-bit Windows Firefox to the firefox directory within the project root ($rootDir/firefox). Note that
+ * administrator privileges will be needed to properly install.
+ *
+ * This depends on the output of downloadWindows_x86_64.
+ *
+ * @return The directory Firefox was installed to.
+ */
 task installWindows_x86_64(dependsOn: downloadWindows_x86_64, type: Exec) {
 	workingDir layout.buildDirectory
 	commandLine 'msiexec', '/i', '"' + downloadWindows_x86_64.dest + '"', '/li', '"install.log"', '/qb', "INSTALL_DIRECTORY_PATH=\"$rootDir\\firefox\"", 'TASKBAR_SHORTCUT=false', 'DESKTOP_SHORTCUT=false', 'INSTALL_MAINTENANCE_SERVICE=false'
@@ -102,6 +139,14 @@ installWindows_x86_64.doFirst {
 	println "Administrator privileges needed for installing Firefox. Please confirm on the popup."
 }
 
+/**
+ * Installs the 32-bit Windows Firefox to the firefox directory within the project root ($rootDir/firefox). Note that
+ * administrator privileges will be needed to properly install.
+ *
+ * This depends on the output of downloadWindows_x86.
+ *
+ * @return The directory Firefox was installed to.
+ */
 task installWindows_x86(dependsOn: downloadWindows_x86, type: Exec) {
 	workingDir layout.buildDirectory
 	commandLine 'msiexec', '/i', '"' + downloadWindows_x86.dest + '"', '/li', '"install.log"', '/qb', "INSTALL_DIRECTORY_PATH=\"$rootDir/firefox\"", 'TASKBAR_SHORTCUT=false', 'DESKTOP_SHORTCUT=false', 'INSTALL_MAINTENANCE_SERVICE=false'
@@ -112,10 +157,20 @@ installWindows_x86.doFirst {
 	println "Administrator privileges needed for installing Firefox. Please confirm on the popup."
 }
 
+/**
+ * Removes the Firefox installation directory, $rootDir/firefox.
+ */
 task deleteFirefoxWindows(type: Delete) {
 	delete "$rootDir/firefox"
 }
 
+/**
+ * Invoke's the Firefox's Windows uninstaller.
+ *
+ * This task will call deleteFirefoxWindows.
+ *
+ * @return The directory Firefox was installed to.
+ */
 task uninstallFirefoxWindows(type: Exec) {
 	workingDir layout.buildDirectory
 	commandLine 'cmd', '/c', "$rootDir\\firefox\\uninstall\\helper.exe", '/S'
@@ -126,6 +181,13 @@ uninstallFirefoxWindows.doFirst {
 }
 uninstallFirefoxWindows.finalizedBy deleteFirefoxWindows
 
+/**
+ * Installs the 64-bit Linux Firefox to the firefox directory within the project root ($rootDir/firefox).
+ *
+ * This depends on the output of downloadLinux_x86_64.
+ *
+ * @return The directory Firefox was installed to.
+ */
 task installLinux_x86_64(dependsOn: downloadLinux_x86_64, type: Copy) {
     from(tarTree(downloadLinux_x86_64.dest)) {
 		include "firefox/**"
@@ -137,6 +199,13 @@ task installLinux_x86_64(dependsOn: downloadLinux_x86_64, type: Copy) {
 //	outputs.dir(new File(rootDir, "firefox"))
 }
 
+/**
+ * Installs the 32-bit Linux Firefox to the firefox directory within the project root ($rootDir/firefox).
+ *
+ * This depends on the output of downloadLinux_i686.
+ *
+ * @return The directory Firefox was installed to.
+ */
 task installLinux_i686(dependsOn: downloadLinux_i686, type: Copy) {
 	from(tarTree(downloadLinux_i686.dest)) {
 		include "firefox/**"
@@ -148,6 +217,14 @@ task installLinux_i686(dependsOn: downloadLinux_i686, type: Copy) {
 	outputs.dir("$rootDir/firefox")
 }
 
+/**
+ * Installs the version of Firefox appropriate for the current system.
+ *
+ * This depends on the output of installWindows_x86_64, installWindows_x86, installLinux_x86_64, or installLinux_i686,
+ * depending on the architecture.
+ *
+ * @return The directory Firefox was installed in.
+ */
 task installFirefox() {
 	if (Os.isFamily(Os.FAMILY_WINDOWS))
 	{
@@ -201,6 +278,11 @@ task installFirefox() {
 	}
 }
 
+/**
+ * Sets up the folders that addons will be stored in, the /distribution/extensions folder.
+ *
+ * This task depends on installFirefox.
+ */
 task setupProfile {
 	dependsOn installFirefox
 	doFirst {
@@ -215,10 +297,19 @@ task setupProfile {
 	}
 }
 
+/**
+ * This task sets up the policies that Firefox will use when creating new profiles. These are copied from the
+ * browserConf directory.
+ *
+ * This task depends on setupProfile.
+ */
 task movePolicies(type: Copy) {
 	dependsOn setupProfile
 	from files("browserConf")
 	into "$rootDir/firefox/"
+	/*
+	 * Registers any required addons as needed.
+	 */
 	filesMatching('**/policies.json'){
 		def pre = ""
 		for (File addon: configurations.addon.resolve())
@@ -240,6 +331,11 @@ task movePolicies(type: Copy) {
 	}
 }
 
+/**
+ * Builds all addon dependencies and copies them to the Firefox installation's distribution/extensions folder.
+ *
+ * Depends on installFirefox, setupProfile, and addon dependencies.
+ */
 task installAddons(type: Copy) {
 	dependsOn setupProfile
 	dependsOn configurations.addon
@@ -250,6 +346,11 @@ task installAddons(type: Copy) {
 	}
 }
 
+/**
+ * Zips all addons and browser policies into a conf.tar file.
+ *
+ * I don't actually remember what this is supposed to do.
+ */
 task zipPolicies(type: Tar) {
 	archiveFileName = "conf.tar"
 	destinationDirectory = file("$buildDir")
@@ -280,9 +381,15 @@ tasks.named('clean') {
 }
 println configurations.getNames()
 
+/*
+ * The java runtime requires the browser to be set up beforehand.
+ */
 compileJava.dependsOn installAddons
 compileJava.dependsOn movePolicies
 
+/*
+ * Exports the addons and policy configuration.
+ */
 artifacts {
 	install(zipPolicies)
 }

browser/src/main/java/edu/regis/universeplayer/browser/Browser.java

@@ -4,16 +4,17 @@
 
 package edu.regis.universeplayer.browser;
 
-import org.apache.logging.log4j.LogManager;
+import edu.regis.universeplayer.ConfigManager;
+import edu.regis.universeplayer.Log;
+import edu.regis.universeplayer.browserCommands.BrowserConstants;
+import edu.regis.universeplayer.browserCommands.MessageRunner;
 import org.apache.logging.log4j.core.DefaultLoggerContextAccessor;
 import org.apache.logging.log4j.core.LogEvent;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 import java.io.File;
-import java.io.FileWriter;
 import java.io.IOException;
-import java.io.PrintStream;
 import java.lang.reflect.InvocationTargetException;
 import java.lang.reflect.Method;
 import java.net.ConnectException;
@@ -24,12 +25,14 @@ import java.util.Arrays;
 import java.util.Scanner;
 import java.util.concurrent.atomic.AtomicBoolean;
 
-import edu.regis.universeplayer.ConfigManager;
-import edu.regis.universeplayer.Log;
-import edu.regis.universeplayer.browserCommands.BrowserConstants;
-import edu.regis.universeplayer.browserCommands.MessageRunner;
-import edu.regis.universeplayer.browserCommands.UpdateListener;
-
+/**
+ * This message runner is responsible for starting an instance of a browser
+ * and running messages to and from it. This runner provides a static method,
+ * {@link #createBrowser()}, that starts an instance of the Firefox browser.
+ * That instance contains an addon that starts up a third process, the
+ * intermediary program. The intermediary program connects to the interface
+ * and relays messages between the browser and this runner.
+ */
 public class Browser extends MessageRunner
 {
     private static final Logger logger = LoggerFactory.getLogger(Browser.class);
@@ -37,8 +40,18 @@ public class Browser extends MessageRunner
             LoggerFactory.getLogger("browser");
     
     private static Browser INSTANCE;
+    /*
+     * This boolean keeps track of whether the browser has started or not.
+     * Threads that need to wait for the browser to start can wait upon this
+     * object's monitor.
+     */
     private static final AtomicBoolean instanceWaiter = new AtomicBoolean();
     
+    /**
+     * Obtains the running instance of the browser.
+     *
+     * @return The running Browser instance, or null if it is not running.
+     */
     public static Browser getInstance()
     {
         return INSTANCE;
@@ -50,6 +63,13 @@ public class Browser extends MessageRunner
     
     private boolean running = true;
     
+    /**
+     * Launches a browser instance.
+     *
+     * @return The instance launched.
+     * @throws IOException
+     * @throws InterruptedException
+     */
     public static Browser createBrowser() throws IOException, InterruptedException
     {
         if (INSTANCE != null)
@@ -57,6 +77,13 @@ public class Browser extends MessageRunner
             return INSTANCE;
         }
         
+        /*
+         * Creates a server on the localhost. When the browser starts the
+         * intermediary program, that program will attempt to connect to this
+         * server. Any messages the browser outputs will eventually be received
+         * here, and any messages to send will first be pushed through this
+         * server.
+         */
         ServerSocket server = new ServerSocket(BrowserConstants.PORT, 50, InetAddress
                 .getByName(null));
         logger.debug("Server started.");
@@ -86,6 +113,9 @@ public class Browser extends MessageRunner
         }
         logger.debug("Browser started.");
         
+        /*
+         * Waits for the intermediary program to connect to our server.
+         */
         ConnectException connErr = null;
         logger.debug("Attempting connection");
         Socket socket = server.accept();
@@ -113,12 +143,25 @@ public class Browser extends MessageRunner
         {
             logger.debug("Connection established.");
         }
+        /*
+         * Now that the socket connection has been set up, we can create the
+         * message runner.
+         */
         INSTANCE = new Browser(socket, server, browserProcess);
         instanceWaiter.set(true);
         notifyAllInstance();
         return INSTANCE;
     }
     
+    /**
+     * Creates a browser message runner,
+     *
+     * @param socket  - The socket that the browser's intermediary program is
+     *                using.
+     * @param server  - The server that is hosting the above socket.
+     * @param process - The process controlling the browser instance.
+     * @throws IOException
+     */
     private Browser(Socket socket, ServerSocket server, Process process) throws IOException
     {
         super("BrowserRunner", socket.getInputStream(), socket
@@ -128,7 +171,7 @@ public class Browser extends MessageRunner
         this.process = process;
         
         /*
-         * Sends browser logs to the main log.
+         * Automatically sends browser logs that come through to the main log.
          */
         this.addUpdateListener((object, runner) ->
         {
@@ -203,6 +246,12 @@ public class Browser extends MessageRunner
         });
     }
     
+    /**
+     * {@inheritDoc} This keeps the thread running for as long as the
+     * connection exists.
+     *
+     * @return Whether we chould stop this thread or not.
+     */
     @Override
     protected boolean onRun()
     {
@@ -215,6 +264,9 @@ public class Browser extends MessageRunner
         return !this.running;
     }
     
+    /**
+     * {@inheritDoc} This shuts down the socket, server, and browser process.
+     */
     @Override
     protected void onClose()
     {
@@ -245,7 +297,7 @@ public class Browser extends MessageRunner
     }
     
     /**
-     *
+     * Called to stop the browser.
      */
     public void stop()
     {
@@ -253,8 +305,9 @@ public class Browser extends MessageRunner
     }
     
     /**
-     * Utility method for launching a browser instance
+     * Utility method for launching a browser instance process.
      *
+     * @return The process responsible for the browser.
      * @throws IOException - Thrown if there is a problem launching the
      *                     browser.
      */
@@ -294,11 +347,19 @@ public class Browser extends MessageRunner
         return process;
     }
     
-    public static void notifyInstance()
+    /**
+     * Notifies a single random waiting thread that the browser message
+     * runner has started.
+     */
+    private static void notifyInstance()
     {
         instanceWaiter.notify();
     }
     
+    /**
+     * Alerts all threads waiting for the browser to start that the browser has
+     * started.
+     */
     public static void notifyAllInstance()
     {
         synchronized (instanceWaiter)
@@ -307,6 +368,12 @@ public class Browser extends MessageRunner
         }
     }
     
+    /**
+     * Causes the current thread to wait for the browser process to start and
+     * the message runner to properly set up.
+     *
+     * @throws InterruptedException
+     */
     public static void waitInstance() throws InterruptedException
     {
         synchronized (instanceWaiter)
@@ -315,6 +382,12 @@ public class Browser extends MessageRunner
         }
     }
     
+    /**
+     * Causes the current thread to wait for the browser process to start and
+     * the message runner to properly set up.
+     *
+     * @throws InterruptedException
+     */
     public static void waitInstance(long timeoutMillis) throws InterruptedException
     {
         synchronized (instanceWaiter)
@@ -323,6 +396,12 @@ public class Browser extends MessageRunner
         }
     }
     
+    /**
+     * Causes the current thread to wait for the browser process to start and
+     * the message runner to properly set up.
+     *
+     * @throws InterruptedException
+     */
     public static void waitInstance(long timeoutMillis, int nanos) throws InterruptedException
     {
         synchronized (instanceWaiter)

browserCommands/build.gradle

@@ -1,5 +1,9 @@
 /*
  * Copyright (c) 2021 William Hubbard. All Rights Reserved.
+ *
+ * This module contains a series of classes used by multiple modules (notably, the :browser and :interface modules).
+ * Notably, it contains commands that the browser reacts to, the response structure, and data structures that is
+ * frequently passed to and from the interface and browser.
  */
 
 plugins {
@@ -24,6 +28,8 @@ dependencies {
 
     implementation 'net.harawata:appdirs:1.2.1'
 
+    implementation 'net.harawata:appdirs:1.2.1'
+
     // Declare the dependency for your favourite test framework you want to use in your tests.
     // TestNG is also supported by the Gradle Test task. Just change the
     // testCompile dependency to testCompile 'org.testng:testng:6.8.1' and add

browserCommands/src/main/java/edu/regis/universeplayer/browserCommands/MessageSerializer.java

@@ -60,12 +60,17 @@ public interface MessageSerializer
     
     /**
      * Writes a message to the output stream.
+     * <p>
+     * By default, it will first write the number of the message (one integer
+     * of 4 bytes), and then the length of the message in bytes (another
+     * integer of four bytes). It finally writes the data stream before
+     * flushing the stream.
      *
      * @param out        - The output stream to write to.
      * @param messageNum - The ID of the message being sent. This will help keep
      *                   track of responses.
      * @param message    - The actual message contents to write.
-     * @throws IOException Thrown when an exception occures
+     * @throws IOException Thrown when an exception occurs
      */
     default void writeMessage(OutputStream out, int messageNum, byte[] message) throws IOException
     {
@@ -96,7 +101,7 @@ public interface MessageSerializer
     }
     
     /**
-     * Reads a message from the input stream
+     * Reads a message from the input stream.
      *
      * @param in - The input stream to read from.
      * @return Two byte arrays, each with their own value encoded. The first is