Javadoc tweaks

Author: ashleyfrieze

system-stubs-core/src/main/java/uk/org/webcompere/systemstubs/SystemStubs.java

@@ -778,7 +778,7 @@ public static void withSecurityManager(SecurityManager securityManager,
      * }
      * </pre>
      *
-     * <h3>Throwing Exceptions</h3>
+     * <b>Throwing Exceptions</b>
      *
      * <p>You can also simulate a {@code System.in} that throws an
      * {@code IOException} or {@code RuntimeException}. Use

system-stubs-core/src/main/java/uk/org/webcompere/systemstubs/exception/LoadingException.java

@@ -4,6 +4,11 @@
  * When something fails to load as part of a System Stubs operation
  */
 public class LoadingException extends RuntimeException {
+    /**
+     * Construct the Loading exception
+     * @param message the message
+     * @param cause the root cause
+     */
     public LoadingException(String message, Throwable cause) {
         super(message, cause);
     }

system-stubs-core/src/main/java/uk/org/webcompere/systemstubs/stream/input/DecoratingAltStream.java

@@ -9,6 +9,10 @@
 public class DecoratingAltStream extends AltInputStream {
     private InputStream decoratee;
 
+    /**
+     * Construct the stream with the decoratee
+     * @param decoratee the input stream that will be read from
+     */
     public DecoratingAltStream(InputStream decoratee) {
         this.decoratee = decoratee;
     }

system-stubs-core/src/main/java/uk/org/webcompere/systemstubs/stream/output/Output.java

@@ -64,6 +64,7 @@ default void clear() {
 
     /**
      * When the target stream is meant to be closed, then close it
+     * @throws Exception on any error closing
      */
     default void closeOutput() throws Exception {
         // does nothing here

system-stubs-core/src/main/java/uk/org/webcompere/systemstubs/stream/output/OutputFactories.java

@@ -77,6 +77,7 @@ public static OutputFactory<MultiplexOutput> tapAndOutput() {
 
     /**
      * Write to file when the output is active, closing it when it's deactivated
+     * @param file the target file for writing to
      */
     public static OutputFactory<FileOutputStream> writeToFile(File file) {
         return original -> Output.fromCloseableStream(new FileOutputStream(file));

system-stubs-interceptor/src/main/java/uk/org/webcompere/systemstubs/internal/ProcessEnvironmentInterceptor.java

@@ -6,9 +6,18 @@
 
 import static java.util.stream.Collectors.toMap;
 
+/**
+ * Plugs into the boot loader to provide an alternative implementation to ProcessEnvironment
+ * controllable at test time.
+ */
 public class ProcessEnvironmentInterceptor {
     private static Map<String, String> CURRENT_ENVIRONMENT_VARIABLES = new HashMap<>();
 
+    /**
+     * For use by the EnvironmentMocker - this overwrites the effective environment variables that the system
+     * appears to have.
+     * @param env the environment variable map to use - this is kept by reference and so is mutable
+     */
     @SuppressFBWarnings("EI_EXPOSE_STATIC_REP2")
     public static void setEnv(Map<String, String> env) {
         CURRENT_ENVIRONMENT_VARIABLES = env;
@@ -23,10 +32,20 @@ public static Map<String, String> getenv() {
         return filterNulls(CURRENT_ENVIRONMENT_VARIABLES);
     }
 
+    /**
+     * Get a single environment variable
+     * @param name name of the variable
+     * @return the value or null
+     */
     public static String getenv(String name) {
         return getenv().get(name);
     }
 
+    /**
+     * Reads the environment variables as does getenv - a different part of
+     * ProcessEnvironment that we're stubbing
+     * @return the environment map
+     */
     public static Map<String, String> environment() {
         return getenv();
     }