Add missing JavaDoc (#289)

Author: sbabcoc

docs/ConfiguringProjectSettings.md

@@ -83,7 +83,7 @@ The **`HUB_HOST`** setting specifies the URL of the **Selenium Grid** hub server
 
 > If this setting is left undefined or specifies an inactive `localhost` URL, **Selenium Foundation** will automatically launch a local Grid instance as specified by the [local Grid configuration](LocalGridConfiguration.md).
 
-The **`GRID_PLUGINS`** setting specifies a semicolon-delimited list of fully-qualified names of local **Selenium Grid** driver plugin classes.
+The **`GRID_PLUGINS`** setting specifies a semicolon-delimited list of fully-qualified names of local **Selenium Grid** driver plug-in classes.
 
 **NOTE**: Defining a value for this setting overrides the **ServiceLoader** specification defined by the associated provider configuration file (_com.nordstrom.automation.selenium.DriverPlugin_).
 
@@ -99,7 +99,7 @@ The **`GRID_PLUGINS`** setting specifies a semicolon-delimited list of fully-qua
 
 #### Grid Configuration for Selenium Foundation unit tests
 
-By default, the unit tests are [configured](LocalGridConfiguration.md) to run the "support" tests, which don't require browser sessions. The local Grid instance launched for this configuration runs in "servlet container" mode. The Gradle project file defines a set of profiles, one for each supported browser, which specify the corresponding dependencies, settings, and driver plugin needed to run the unit tests for that browser.
+By default, the unit tests are [configured](LocalGridConfiguration.md) to run the "support" tests, which don't require browser sessions. The local Grid instance launched for this configuration runs in "servlet container" mode. The Gradle project file defines a set of profiles, one for each supported browser, which specify the corresponding dependencies, settings, and driver plug-in needed to run the unit tests for that browser.
 
 | Profile | Browser / Appium Engine |
 | --- |:---:|

docs/LocalGridConfiguration.md

@@ -44,7 +44,7 @@ In addition to declaring driver plug-ins in the **ServiceLoader** provider confi
 
 ### Driver Plug-Ins for Desktop Browsers and Appium Engines
 
-Driver plug-ins encapsulate the specific details related to launching **Selenium Grid** nodes that support the corresponding drivers. **Selenium Foundation** provides [driver plugin-ins](ConfiguringProjectSettings.md#desktop-browser-support) for all of the major browsers. It also provides plug-ins for all of the major [automation engines](ConfiguringProjectSettings.md#appium-automation-engine-support) of the `Appium` project.
+Driver plug-ins encapsulate the specific details related to launching **Selenium Grid** nodes that support the corresponding drivers. **Selenium Foundation** provides [driver plug-ins](ConfiguringProjectSettings.md#desktop-browser-support) for all of the major browsers. It also provides plug-ins for all of the major [automation engines](ConfiguringProjectSettings.md#appium-automation-engine-support) of the `Appium` project.
 
 #### Drivers for Desktop Browsers
 

src/main/java/com/nordstrom/automation/selenium/AbstractSeleniumConfig.java

@@ -54,6 +54,7 @@ public abstract class AbstractSeleniumConfig extends
 
     private static final String SETTINGS_FILE = "settings.properties";
 
+    /** suffix for node configuration modifier files */
     protected static final String NODE_MODS_SUFFIX = ".node.mods";
     private static final String CAPS_MODS_SUFFIX = ".caps.mods";
 
@@ -116,7 +117,7 @@ public enum SeleniumSettings implements SettingsCore.SettingsAPI {
 
         /**
          * This setting specifies a path-delimited list of fully-qualified names of local <b>Selenium Grid</b> driver
-         * plugin classes.
+         * plug-in classes.
          * <p>
          * <b>NOTE</b>: Defining a value for this setting overrides the <b>ServiceLoader</b> specification defined
          * by the associated provider configuration file (<i>com.nordstrom.automation.selenium.DriverPlugin</i>).
@@ -522,6 +523,7 @@ public SearchContextWait getWait(final SearchContext context) {
 
     }
 
+    /** singleton instance of concrete version-specific configuration */
     protected static SeleniumConfig seleniumConfig;
 
     private URI targetUri;
@@ -530,6 +532,12 @@ public SearchContextWait getWait(final SearchContext context) {
     private URL hubUrl;
     private SeleniumGrid seleniumGrid;
 
+    /**
+     * Instantiate a configuration object for the specified enumeration class.
+     * 
+     * @throws ConfigurationException if a failure is encountered while initializing this configuration object
+     * @throws IOException if a failure is encountered while reading from a configuration input stream
+     */
     public AbstractSeleniumConfig() throws ConfigurationException, IOException {
         super(SeleniumSettings.class);
     }

src/main/java/com/nordstrom/automation/selenium/DriverPlugin.java

@@ -17,6 +17,9 @@
 import com.nordstrom.automation.selenium.core.LocalSeleniumGrid.LocalGridServer;
 import net.bytebuddy.implementation.Implementation;
 
+/**
+ * This interface defines the contract for driver plug-in objects.
+ */
 public interface DriverPlugin {
 
     /**

src/main/java/com/nordstrom/automation/selenium/core/GridUtility.java

@@ -380,7 +380,7 @@ private static <T extends RemoteWebDriver> Constructor<T> getRemoteWebDriverCtor
      * Get instances of all configured driver plugins.
      * 
      * @param config {@link SeleniumConfig} object
-     * @return list of driver plugin instances
+     * @return list of driver plug-in instances
      */
     public static List<DriverPlugin> getDriverPlugins(SeleniumConfig config) {
         List<DriverPlugin> driverPlugins = new ArrayList<>();
@@ -389,29 +389,29 @@ public static List<DriverPlugin> getDriverPlugins(SeleniumConfig config) {
         String gridPlugins = config.getString(SeleniumSettings.GRID_PLUGINS.key());
         // if setting is defined and not empty
         if ( ! (gridPlugins == null || gridPlugins.trim().isEmpty())) {
-            // iterate specified driver plugin class names
+            // iterate specified driver plug-in class names
             for (String driverPlugin : gridPlugins.split(File.pathSeparator)) {
                 String className = driverPlugin.trim();
                 try {
-                    // load driver plugin class
+                    // load driver plug-in class
                     Class<?> pluginClass = Class.forName(className);
                     // get no-argument constructor
                     Constructor<?> ctor = pluginClass.getConstructor();
                     // add instance to plugins list
                     driverPlugins.add((DriverPlugin) ctor.newInstance());
                 } catch (ClassNotFoundException e) {
-                    throw new ServiceConfigurationError("Specified driver plugin '" + className + "' not found", e);
+                    throw new ServiceConfigurationError("Specified driver plug-in '" + className + "' not found", e);
                 } catch (ClassCastException e) {
-                    throw new ServiceConfigurationError("Specified driver plugin '" + className
+                    throw new ServiceConfigurationError("Specified driver plug-in '" + className
                             + "' is not a subclass of DriverPlugin", e);
                 } catch (NoSuchMethodException | SecurityException e) {
-                    throw new ServiceConfigurationError("Specified driver plugin '" + className
+                    throw new ServiceConfigurationError("Specified driver plug-in '" + className
                             + "' lacks an accessible no-argument constructor", e);
                 } catch (InstantiationException | IllegalAccessException | IllegalArgumentException e) {
-                    throw new ServiceConfigurationError("Specified driver plugin '" + className
+                    throw new ServiceConfigurationError("Specified driver plug-in '" + className
                             + "' could not be instantiated", e);
                 } catch (InvocationTargetException e) {
-                    throw new ServiceConfigurationError("Constructor for driver plugin '" + className
+                    throw new ServiceConfigurationError("Constructor for driver plug-in '" + className
                             + "' threw an exception", e.getTargetException());
                 }
             }

src/main/java/com/nordstrom/automation/selenium/core/SeleniumGrid.java

@@ -71,12 +71,14 @@ public Thread newThread(Runnable r) {
 
     private GridServer hubServer;
     private Map<URL, GridServer> nodeServers = new HashMap<>();
-    protected Map<String, String> personalities = new HashMap<>();
 
+    /** "personalities" supported by this Grid instance */
+    protected Map<String, String> personalities = new HashMap<>();
+    /** SLF4J logger for this Selenium Grid model */
     protected static final Logger LOGGER = LoggerFactory.getLogger(SeleniumGrid.class);
 
     /**
-     * Constructor for Selenium Grid from hub URL.
+     * Constructor for models of Selenium Grid instances from hub URL.
      * <p>
      * This is used to create an interface for an active grid - remote or local.
      *