Fixed some javadoc typos

jline · May 24, 2020 · 67b2ba1 · 67b2ba1
1 parent 56dbf56
commit 67b2ba1
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 18 deletions.
diff --git a/reader/src/main/java/org/jline/console/CommandRegistry.java b/reader/src/main/java/org/jline/console/CommandRegistry.java
@@ -88,8 +88,8 @@ default String name() {
 
     /**
      * Returns a command description for use in the JLine Widgets framework.
-     * Default method must be overriden to return subcommand descriptions.
-     * @param args commandline arguments
+     * Default method must be overridden to return sub command descriptions.
+     * @param args command line arguments
      * @return command description for JLine TailTipWidgets to be displayed
      *         in the terminal status bar.
      */
@@ -99,7 +99,7 @@ default CmdDesc commandDescription(List<String> args) {
 
     /**
      * Returns a command description for use in the JLine Widgets framework.
-     * @param command name of the command whose description to return
+     * @param command the name of the command whose description to return
      * @return command description for JLine TailTipWidgets to be displayed
      *         in the terminal status bar.
      */

diff --git a/reader/src/main/java/org/jline/console/Printer.java b/reader/src/main/java/org/jline/console/Printer.java
@@ -69,7 +69,7 @@ public interface Printer {
     /**
      * Value: Integer<br>
      * Applies: MAP and TABLE<br>
-     * Maximum number of lines on display.
+     * Maximum number of lines to display.
      */
     final static String MAXROWS = "maxrows";
     /**
@@ -87,7 +87,7 @@ public interface Printer {
     /**
      * Value: Boolean<br>
      * Applies: TABLE<br>
-     * Truncate table column names: property.field -> field.
+     * Truncate table column names: property.field to field.
      */
     final static String SHORT_NAMES = "shortNames";
     /**
@@ -99,7 +99,7 @@ public interface Printer {
     /**
      * Value: Boolean<br>
      * Applies: TABLE<br>
-     * Display structs and lists on table.
+     * Display object structures and lists on table.
      */
     final static String STRUCT_ON_TABLE = "structsOnTable";
     /**
@@ -145,7 +145,7 @@ public interface Printer {
      * Value: {@code Map<regex, function>}.<br>
      * Applies: TABLE<br>
      * If command result map key matches with regex the highlight function is applied
-     * to the corresponding map value. The regex =* is processed after all the other regexes and the highlight
+     * to the corresponding map value. The regex = * is processed after all the other regexes and the highlight
      * function will be applied to all map values that have not been already highlighted.
      */
     final static String HIGHLIGHT_VALUE = "highlightValue";

diff --git a/reader/src/main/java/org/jline/console/ScriptEngine.java b/reader/src/main/java/org/jline/console/ScriptEngine.java
@@ -68,8 +68,8 @@ default Map<String,Object> find() {
     Map<String,Object> find(String name);
 
     /**
-     * Deletes variables. Variable name cab contain * wild cards.
-     * @param vars variables to be delted
+     * Deletes variables. Variable name can contain * wild cards.
+     * @param vars variables to be deleted
      */
     void del(String... vars);
 
@@ -82,21 +82,21 @@ default Map<String,Object> find() {
 
     /**
      * Converts object to string.
-     * @param object object to converts to string
+     * @param object the object
      * @return object string value
      */
     String toString(Object object);
 
     /**
      * Converts object fields to map.
-     * @param object object to convert to map
+     * @param object the object
      * @return object fields map
      */
     Map<String,Object> toMap(Object object);
 
     /**
      * Deserialize value
-     * @param value value to deserialize
+     * @param value the value
      * @return deserialized value
      */
     default Object deserialize(String value) {
@@ -105,7 +105,7 @@ default Object deserialize(String value) {
 
     /**
      * Deserialize value
-     * @param value value to deserialize
+     * @param value the value
      * @param format serialization format
      * @return deserialized value
      */
@@ -132,23 +132,23 @@ default Object deserialize(String value) {
 
     /**
      * Persists object value to file.
-     * @param file file
-     * @param object object
+     * @param file the file
+     * @param object the object
      * @param format serialization format
      */
     void persist(Path file, Object object, String format);
 
     /**
      * Executes scriptEngine statement
-     * @param statement statement
+     * @param statement the statement
      * @return result
      * @throws Exception in case of error
      */
     Object execute(String statement) throws Exception;
 
     /**
      * Executes scriptEngine script
-     * @param script script
+     * @param script the script
      * @return result
      * @throws Exception in case of error
      */
@@ -158,7 +158,7 @@ default Object execute(File script) throws Exception {
 
     /**
      * Executes scriptEngine script
-     * @param script script
+     * @param script the script
      * @param args arguments
      * @return result
      * @throws Exception in case of error