[maven-script-interpreter] branch master updated: Javadoc fixes

[sl...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

slachiewicz pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-script-interpreter.git


The following commit(s) were added to refs/heads/master by this push:
     new 237a68c  Javadoc fixes
237a68c is described below

commit 237a68c62cd0f1435a99ea9ba14893aefec3b97d
Author: Sylwester Lachiewicz <sl...@gmail.com>
AuthorDate: Sun Oct 4 23:09:30 2020 +0200

    Javadoc fixes
---
 .../maven/shared/scriptinterpreter/BeanShellScriptInterpreter.java   | 4 +---
 .../java/org/apache/maven/shared/scriptinterpreter/FileLogger.java   | 2 ++
 .../maven/shared/scriptinterpreter/FileLoggerMirrorHandler.java      | 2 ++
 .../maven/shared/scriptinterpreter/GroovyScriptInterpreter.java      | 4 +---
 .../maven/shared/scriptinterpreter/ScriptEvaluationException.java    | 3 ++-
 .../org/apache/maven/shared/scriptinterpreter/ScriptException.java   | 3 ++-
 .../org/apache/maven/shared/scriptinterpreter/ScriptInterpreter.java | 4 ++--
 .../apache/maven/shared/scriptinterpreter/ScriptReturnException.java | 5 ++++-
 .../org/apache/maven/shared/scriptinterpreter/FileLoggerTest.java    | 3 +++
 9 files changed, 19 insertions(+), 11 deletions(-)

diff --git a/src/main/java/org/apache/maven/shared/scriptinterpreter/BeanShellScriptInterpreter.java b/src/main/java/org/apache/maven/shared/scriptinterpreter/BeanShellScriptInterpreter.java
index 0fa8de5..e35c99f 100644
--- a/src/main/java/org/apache/maven/shared/scriptinterpreter/BeanShellScriptInterpreter.java
+++ b/src/main/java/org/apache/maven/shared/scriptinterpreter/BeanShellScriptInterpreter.java
@@ -39,9 +39,7 @@ class BeanShellScriptInterpreter
     implements ScriptInterpreter
 {
 
-    /**
-     * {@inheritDoc}
-     */
+    /** {@inheritDoc} */
     @Override
     public Object evaluateScript( String script, List<String> classPath, Map<String, ? extends Object> globalVariables,
                                   PrintStream scriptOutput )
diff --git a/src/main/java/org/apache/maven/shared/scriptinterpreter/FileLogger.java b/src/main/java/org/apache/maven/shared/scriptinterpreter/FileLogger.java
index d60433e..ee5f851 100644
--- a/src/main/java/org/apache/maven/shared/scriptinterpreter/FileLogger.java
+++ b/src/main/java/org/apache/maven/shared/scriptinterpreter/FileLogger.java
@@ -26,6 +26,8 @@ import java.io.OutputStream;
 import java.io.PrintStream;
 
 /**
+ * <p>FileLogger class.</p>
+ *
  */
 public class FileLogger implements ExecutionLogger, AutoCloseable
 {
diff --git a/src/main/java/org/apache/maven/shared/scriptinterpreter/FileLoggerMirrorHandler.java b/src/main/java/org/apache/maven/shared/scriptinterpreter/FileLoggerMirrorHandler.java
index fcc219e..25ef0d5 100644
--- a/src/main/java/org/apache/maven/shared/scriptinterpreter/FileLoggerMirrorHandler.java
+++ b/src/main/java/org/apache/maven/shared/scriptinterpreter/FileLoggerMirrorHandler.java
@@ -21,6 +21,8 @@ package org.apache.maven.shared.scriptinterpreter;
 
 /**
  * Handle output form interpreter.
+ *
+ * @since 1.3
  */
 public interface FileLoggerMirrorHandler
 {
diff --git a/src/main/java/org/apache/maven/shared/scriptinterpreter/GroovyScriptInterpreter.java b/src/main/java/org/apache/maven/shared/scriptinterpreter/GroovyScriptInterpreter.java
index 0bf8e36..53c4aba 100644
--- a/src/main/java/org/apache/maven/shared/scriptinterpreter/GroovyScriptInterpreter.java
+++ b/src/main/java/org/apache/maven/shared/scriptinterpreter/GroovyScriptInterpreter.java
@@ -41,9 +41,7 @@ class GroovyScriptInterpreter
     implements ScriptInterpreter
 {
 
-    /**
-     * {@inheritDoc}
-     */
+    /** {@inheritDoc} */
     @Override
     public Object evaluateScript( String script, List<String> classPath, Map<String, ? extends Object> globalVariables,
                                   PrintStream scriptOutput )
diff --git a/src/main/java/org/apache/maven/shared/scriptinterpreter/ScriptEvaluationException.java b/src/main/java/org/apache/maven/shared/scriptinterpreter/ScriptEvaluationException.java
index 3e878e8..cf22d79 100644
--- a/src/main/java/org/apache/maven/shared/scriptinterpreter/ScriptEvaluationException.java
+++ b/src/main/java/org/apache/maven/shared/scriptinterpreter/ScriptEvaluationException.java
@@ -22,7 +22,7 @@ package org.apache.maven.shared.scriptinterpreter;
 /**
  * Signals an error during parsing/evaluation of a script. This can either be a syntax error in the script itself or an
  * exception triggered by the methods it invoked.
- * 
+ *
  * @author Benjamin Bentmann
  */
 public class ScriptEvaluationException
@@ -49,6 +49,7 @@ public class ScriptEvaluationException
      *
      * @param message The message, may be <code>null</code>.
      * @param cause The cause, may be <code>null</code>.
+     * @since 1.3
      */
     public ScriptEvaluationException( String message, Throwable cause )
     {
diff --git a/src/main/java/org/apache/maven/shared/scriptinterpreter/ScriptException.java b/src/main/java/org/apache/maven/shared/scriptinterpreter/ScriptException.java
index 11404c6..1f24e70 100644
--- a/src/main/java/org/apache/maven/shared/scriptinterpreter/ScriptException.java
+++ b/src/main/java/org/apache/maven/shared/scriptinterpreter/ScriptException.java
@@ -21,8 +21,9 @@ package org.apache.maven.shared.scriptinterpreter;
 
 /**
  * Common errors during script running.
- * 
+ *
  * @author Slawomir Jaranowski
+ * @since 1.3
  */
 public class ScriptException
     extends Exception
diff --git a/src/main/java/org/apache/maven/shared/scriptinterpreter/ScriptInterpreter.java b/src/main/java/org/apache/maven/shared/scriptinterpreter/ScriptInterpreter.java
index 16b3177..bde2541 100644
--- a/src/main/java/org/apache/maven/shared/scriptinterpreter/ScriptInterpreter.java
+++ b/src/main/java/org/apache/maven/shared/scriptinterpreter/ScriptInterpreter.java
@@ -26,7 +26,7 @@ import java.util.Map;
 /**
  * Defines a simple abstraction used to plug-in several script interpreters for the pre-/post-build-hooks. Each
  * interpreter implementation should be stateless and support reuse.
- * 
+ *
  * @author Benjamin Bentmann
  */
 public interface ScriptInterpreter
@@ -34,7 +34,7 @@ public interface ScriptInterpreter
 
     /**
      * Evaluates the specified script.
-     * 
+     *
      * @param script The script contents to evaluate, must not be <code>null</code>.
      * @param classPath The additional class path for the script interpreter, may be <code>null</code> or empty if only
      *            the plugin realm should be used for the script evaluation. If specified, this class path will precede
diff --git a/src/main/java/org/apache/maven/shared/scriptinterpreter/ScriptReturnException.java b/src/main/java/org/apache/maven/shared/scriptinterpreter/ScriptReturnException.java
index 046c56b..51c416a 100644
--- a/src/main/java/org/apache/maven/shared/scriptinterpreter/ScriptReturnException.java
+++ b/src/main/java/org/apache/maven/shared/scriptinterpreter/ScriptReturnException.java
@@ -23,12 +23,15 @@ package org.apache.maven.shared.scriptinterpreter;
  * Signals an invalid value returned from script execution.
  *
  * @author Slawomir Jaranowski
+ * @since 1.3
  */
 public class ScriptReturnException extends ScriptException
 {
 
     private static final long serialVersionUID = -4705573157701206786L;
-
+    /**
+     * Result
+     */
     private final Object result;
 
     /**
diff --git a/src/test/java/org/apache/maven/shared/scriptinterpreter/FileLoggerTest.java b/src/test/java/org/apache/maven/shared/scriptinterpreter/FileLoggerTest.java
index 2ed12a0..c5813ff 100644
--- a/src/test/java/org/apache/maven/shared/scriptinterpreter/FileLoggerTest.java
+++ b/src/test/java/org/apache/maven/shared/scriptinterpreter/FileLoggerTest.java
@@ -29,6 +29,9 @@ import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertNull;
 import static org.junit.Assert.assertTrue;
 
+/**
+ * FileLoggerTest
+ */
 public class FileLoggerTest
 {