Fixed javadoc warnings

jline · May 11, 2020 · 80265b4 · 80265b4
1 parent 3c83e59
commit 80265b4
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 6 deletions.
diff --git a/builtins/src/main/java/org/jline/builtins/ConsoleEngine.java b/builtins/src/main/java/org/jline/builtins/ConsoleEngine.java
@@ -124,7 +124,7 @@ static String plainCommand(String command) {
      * Read object from file
      * @param file file from where object should be read
      * @return object
-     * @throws IOException
+     * @throws IOException in case of error
      */
     public Object slurp(Path file) throws IOException;
 

diff --git a/builtins/src/main/java/org/jline/builtins/SystemRegistry.java b/builtins/src/main/java/org/jline/builtins/SystemRegistry.java
@@ -133,14 +133,14 @@ static SystemRegistry get() {
 
     /**
      * Add systemRegistry to the thread map
-     * @param systemRegistry
+     * @param systemRegistry the systemRegistry
      */
     static void add(SystemRegistry systemRegistry) {
         Registeries.getInstance().addRegistry(systemRegistry);
     }
 
     /**
-     * Remove systemRegistry from the thread map
+     * Remove systemRegistry of the current thread from the thread map
      */
     static void remove() {
         Registeries.getInstance().removeRegistry();

diff --git a/reader/src/main/java/org/jline/console/CommandRegistry.java b/reader/src/main/java/org/jline/console/CommandRegistry.java
@@ -67,6 +67,7 @@ default String name() {
 
     /**
      * Returns a short info about command known by this registry.
+     * @param command the command name
      * @return a short info about command
      */
     List<String> commandInfo(String command);

diff --git a/reader/src/main/java/org/jline/console/ScriptEngine.java b/reader/src/main/java/org/jline/console/ScriptEngine.java
@@ -142,15 +142,15 @@ default Object deserialize(String value) {
      * Executes scriptEngine statement
      * @param statement statement
      * @return result
-     * @throws Exception
+     * @throws Exception in case of error
      */
     Object execute(String statement) throws Exception;
 
     /**
      * Executes scriptEngine script
      * @param script script
      * @return result
-     * @throws Exception
+     * @throws Exception in case of error
      */
     default Object execute(File script) throws Exception {
         return execute(script, null);
@@ -161,7 +161,7 @@ default Object execute(File script) throws Exception {
      * @param script script
      * @param args arguments
      * @return result
-     * @throws Exception
+     * @throws Exception in case of error
      */
     Object execute(File script, Object[] args) throws Exception;