From 2bf4058a13491ab12e1c177a3125c095d310e812 Mon Sep 17 00:00:00 2001
From: Guillaume Nodet <gnodet@gmail.com>
Date: Thu, 24 May 2018 22:33:33 +0200
Subject: [PATCH] Remove javadoc warnings

---
 .gitignore                                    |   1 +
 .../java/org/jline/builtins/Completers.java   |   3 +-
 .../main/java/org/jline/builtins/Less.java    |   4 +-
 .../java/org/jline/builtins/NfaMatcher.java   |   5 +-
 .../main/java/org/jline/builtins/Options.java |   7 +-
 .../java/org/jline/keymap/BindingReader.java  |   3 +-
 .../main/java/org/jline/reader/Candidate.java |  17 ++-
 .../main/java/org/jline/reader/Completer.java |   3 +-
 .../main/java/org/jline/reader/History.java   |  11 +-
 .../java/org/jline/reader/LineReader.java     |  44 +++++--
 .../org/jline/reader/MaskingCallback.java     |  10 +-
 .../java/org/jline/reader/ParsedLine.java     |  22 +++-
 .../org/jline/reader/impl/DefaultParser.java  |  27 +++--
 .../java/org/jline/reader/impl/KillRing.java  |   9 +-
 .../org/jline/reader/impl/LineReaderImpl.java |  76 +++++++++---
 .../impl/completer/ArgumentCompleter.java     |   6 +-
 .../impl/completer/FileNameCompleter.java     |   9 +-
 .../reader/impl/history/DefaultHistory.java   |   5 +-
 .../org/jline/builtins/telnet/Connection.java |  12 +-
 .../jline/builtins/telnet/ConnectionData.java |   9 +-
 .../builtins/telnet/ConnectionEvent.java      |   7 +-
 .../builtins/telnet/ConnectionManager.java    |   7 +-
 .../jline/builtins/telnet/PortListener.java   |   3 +-
 .../org/jline/builtins/telnet/TelnetIO.java   |  35 ++++--
 .../java/org/jline/style/StyleExpression.java |   8 +-
 .../java/org/jline/style/StyleFactory.java    |  16 ++-
 .../java/org/jline/style/StyleSource.java     |  16 ++-
 .../src/main/java/org/jline/style/Styler.java |  21 +++-
 .../impl/jansi/win/WindowsAnsiWriter.java     |   6 +-
 .../main/java/org/jline/terminal/Size.java    |  11 +-
 .../java/org/jline/terminal/Terminal.java     |   8 +-
 .../org/jline/terminal/TerminalBuilder.java   |  18 ++-
 .../impl/AbstractWindowsTerminal.java         |   1 +
 .../terminal/impl/LineDisciplineTerminal.java |   4 +-
 .../main/java/org/jline/utils/AnsiWriter.java | 112 +++++++++---------
 .../jline/utils/AttributedStringBuilder.java  |   5 +-
 .../java/org/jline/utils/AttributedStyle.java |   4 +-
 .../src/main/java/org/jline/utils/Curses.java |   3 +-
 .../main/java/org/jline/utils/Display.java    |  16 ++-
 .../jline/utils/NonBlockingInputStream.java   |  22 +++-
 .../utils/NonBlockingInputStreamImpl.java     |   3 +
 .../org/jline/utils/NonBlockingReader.java    |  10 +-
 .../jline/utils/NonBlockingReaderImpl.java    |   5 +-
 .../java/org/jline/utils/StyleResolver.java   |  24 +++-
 44 files changed, 470 insertions(+), 178 deletions(-)

diff --git a/.gitignore b/.gitignore
index 49085bd72..02340f222 100644
--- a/.gitignore
+++ b/.gitignore
@@ -5,3 +5,4 @@ target
 .settings/
 .idea
 build.rc
+.vscode
diff --git a/builtins/src/main/java/org/jline/builtins/Completers.java b/builtins/src/main/java/org/jline/builtins/Completers.java
index 2b760ceed..22473d3fa 100644
--- a/builtins/src/main/java/org/jline/builtins/Completers.java
+++ b/builtins/src/main/java/org/jline/builtins/Completers.java
@@ -257,11 +257,10 @@ protected Path getUserDir() {
     /**
      * A file name completer takes the buffer and issues a list of
      * potential completions.
-     * <p/>
+     * <p>
      * This completer tries to behave as similar as possible to
      * <i>bash</i>'s file name completion (using GNU readline)
      * with the following exceptions:
-     * <p/>
      * <ul>
      * <li>Candidates that are directories will end with "/"</li>
      * <li>Wildcard regular expressions are not evaluated or replaced</li>
diff --git a/builtins/src/main/java/org/jline/builtins/Less.java b/builtins/src/main/java/org/jline/builtins/Less.java
index abda3b49a..7afb8e56e 100644
--- a/builtins/src/main/java/org/jline/builtins/Less.java
+++ b/builtins/src/main/java/org/jline/builtins/Less.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2002-2017, the original author or authors.
+ * Copyright (c) 2002-2018, the original author or authors.
  *
  * This software is distributable under the BSD license. See the terms of the
  * BSD license in the documentation provided with this software.
@@ -646,7 +646,7 @@ AttributedString getLine(int line) throws IOException {
     /**
      * This is for long running commands to be interrupted by ctrl-c
      *
-     * @throws InterruptedException
+     * @throws InterruptedException if the thread has been interruped
      */
     public static void checkInterrupted() throws InterruptedException {
         Thread.yield();
diff --git a/builtins/src/main/java/org/jline/builtins/NfaMatcher.java b/builtins/src/main/java/org/jline/builtins/NfaMatcher.java
index cf0f90105..ed1832b70 100644
--- a/builtins/src/main/java/org/jline/builtins/NfaMatcher.java
+++ b/builtins/src/main/java/org/jline/builtins/NfaMatcher.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2002-2017, the original author or authors.
+ * Copyright (c) 2002-2018, the original author or authors.
  *
  * This software is distributable under the BSD license. See the terms of the
  * BSD license in the documentation provided with this software.
@@ -52,6 +52,9 @@ public boolean match(List<T> args) {
 
     /**
      * Returns the list of possible matcher names for the next object
+     *
+     * @param args input list
+     * @return the list of possible matcher names for the next object
      */
     public Set<String> matchPartial(List<T> args) {
         Set<State> clist = new HashSet<>();
diff --git a/builtins/src/main/java/org/jline/builtins/Options.java b/builtins/src/main/java/org/jline/builtins/Options.java
index 616f0e635..427bf4d89 100644
--- a/builtins/src/main/java/org/jline/builtins/Options.java
+++ b/builtins/src/main/java/org/jline/builtins/Options.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2002-2016, the original author or authors.
+ * Copyright (c) 2002-2018, the original author or authors.
  *
  * This software is distributable under the BSD license. See the terms of the
  * BSD license in the documentation provided with this software.
@@ -241,7 +241,10 @@ public void usage(PrintStream err) {
     }
 
     /**
-     * prints usage message and returns IllegalArgumentException, for you to throw.
+     * Prints usage message and returns IllegalArgumentException, for you to throw.
+     *
+     * @param s the message to display
+     * @return an exception with the generated message
      */
     public IllegalArgumentException usageError(String s) {
         error = usageName + ": " + s;
diff --git a/reader/src/main/java/org/jline/keymap/BindingReader.java b/reader/src/main/java/org/jline/keymap/BindingReader.java
index e3e376316..add3f8576 100644
--- a/reader/src/main/java/org/jline/keymap/BindingReader.java
+++ b/reader/src/main/java/org/jline/keymap/BindingReader.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2002-2016, the original author or authors.
+ * Copyright (c) 2002-2018, the original author or authors.
  *
  * This software is distributable under the BSD license. See the terms of the
  * BSD license in the documentation provided with this software.
@@ -49,6 +49,7 @@ public BindingReader(NonBlockingReader reader) {
      * will be returned.
      *
      * @param keys the KeyMap to use for decoding the input stream
+     * @param <T> the type of bindings to be read
      * @return the decoded binding or <code>null</code> if the end of
      *         stream has been reached
      */
diff --git a/reader/src/main/java/org/jline/reader/Candidate.java b/reader/src/main/java/org/jline/reader/Candidate.java
index ac2b358e7..7fd45b6c8 100644
--- a/reader/src/main/java/org/jline/reader/Candidate.java
+++ b/reader/src/main/java/org/jline/reader/Candidate.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2002-2016, the original author or authors.
+ * Copyright (c) 2002-2018, the original author or authors.
  *
  * This software is distributable under the BSD license. See the terms of the
  * BSD license in the documentation provided with this software.
@@ -36,6 +36,14 @@ public Candidate(String value) {
 
     /**
      * Constructs a new Candidate.
+     *
+     * @param value the value
+     * @param displ the display string
+     * @param group the group
+     * @param descr the description
+     * @param suffix the suffix
+     * @param key the key
+     * @param complete the complete flag
      */
     public Candidate(String value, String displ, String group, String descr, String suffix, String key, boolean complete) {
         Objects.requireNonNull(value);
@@ -51,6 +59,7 @@ public Candidate(String value, String displ, String group, String descr, String
     /**
      * The value that will be used for the actual completion.
      * This string should not contain ANSI sequences.
+     * @return the value
      */
     public String value() {
         return value;
@@ -59,6 +68,7 @@ public String value() {
     /**
      * The string that will be displayed to the user.
      * This string may contain ANSI sequences.
+     * @return the display string
      */
     public String displ() {
         return displ;
@@ -68,6 +78,7 @@ public String displ() {
      * The group name for this candidate.
      * Candidates can be grouped together and this string is used
      * as a key for the group and displayed to the user.
+     * @return the group
      *
      * @see LineReader.Option#GROUP
      * @see LineReader.Option#AUTO_GROUP
@@ -80,6 +91,7 @@ public String group() {
      * Description of this candidate, usually a small help message
      * to understand the meaning of this candidate.
      * This string may contain ANSI sequences.
+     * @return the description
      */
     public String descr() {
         return descr;
@@ -90,6 +102,7 @@ public String descr() {
      * However, if the next character entered does not match,
      * the suffix will be automatically removed.
      * This string should not contain ANSI sequences.
+     * @return the suffix
      *
      * @see LineReader.Option#AUTO_REMOVE_SLASH
      * @see LineReader#REMOVE_SUFFIX_CHARS
@@ -102,6 +115,7 @@ public String suffix() {
      * Candidates which have the same key will be merged together.
      * For example, if a command has multiple aliases, they can be merged
      * if they are using the same key.
+     * @return the key
      */
     public String key() {
         return key;
@@ -114,6 +128,7 @@ public String key() {
      * This can be the case when completing folders for example.
      * If the candidate is complete and is selected, a space
      * separator will be added.
+     * @return the completion flag
      */
     public boolean complete() {
         return complete;
diff --git a/reader/src/main/java/org/jline/reader/Completer.java b/reader/src/main/java/org/jline/reader/Completer.java
index 01ada8e3a..bbbeadc2e 100644
--- a/reader/src/main/java/org/jline/reader/Completer.java
+++ b/reader/src/main/java/org/jline/reader/Completer.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2002-2016, the original author or authors.
+ * Copyright (c) 2002-2018, the original author or authors.
  *
  * This software is distributable under the BSD license. See the terms of the
  * BSD license in the documentation provided with this software.
@@ -30,6 +30,7 @@ public interface Completer
      * for the typo matcher to work, all possible candidates for the word being
      * completed should be returned.
      *
+     * @param reader        The line reader
      * @param line          The parsed command line
      * @param candidates    The {@link List} of candidates to populate
      */
diff --git a/reader/src/main/java/org/jline/reader/History.java b/reader/src/main/java/org/jline/reader/History.java
index 83890472b..4556828dd 100644
--- a/reader/src/main/java/org/jline/reader/History.java
+++ b/reader/src/main/java/org/jline/reader/History.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2002-2016, the original author or authors.
+ * Copyright (c) 2002-2018, the original author or authors.
  *
  * This software is distributable under the BSD license. See the terms of the
  * BSD license in the documentation provided with this software.
@@ -25,21 +25,25 @@ public interface History extends Iterable<History.Entry>
 
     /**
      * Initialize the history for the given reader.
+     * @param reader the reader to attach to
      */
     void attach(LineReader reader);
 
     /**
      * Load history.
+     * @throws IOException if a problem occurs
      */
     void load() throws IOException;
 
     /**
      * Save history.
+     * @throws IOException if a problem occurs
      */
     void save() throws IOException;
 
     /**
      * Purge history.
+     * @throws IOException if a problem occurs
      */
     void purge() throws IOException;
 
@@ -107,6 +111,8 @@ public Entry next() {
 
     /**
      * Return the content of the current buffer.
+     *
+     * @return the content of the current buffer
      */
     String current();
 
@@ -143,6 +149,9 @@ public Entry next() {
 
     /**
      * Move to the specified index in the history
+     *
+     * @param index The index to move to.
+     * @return      Returns true if the index was moved.
      */
     boolean moveTo(int index);
 
diff --git a/reader/src/main/java/org/jline/reader/LineReader.java b/reader/src/main/java/org/jline/reader/LineReader.java
index 39c127ccc..622d55912 100644
--- a/reader/src/main/java/org/jline/reader/LineReader.java
+++ b/reader/src/main/java/org/jline/reader/LineReader.java
@@ -19,7 +19,6 @@
 /** Read lines from the console, with input editing.
  *
  * <h3>Prompt strings</h3>
- * <p>
  * It is traditional for an interactive console-based program
  * to print a short prompt string to signal that the user is expected
  * to type a command.  JLine supports 3 kinds of prompt string:
@@ -33,13 +32,14 @@
  * All of these are specified with prompt templates,
  * which are similar to {@code printf} format strings,
  * using the character {@code '%'} to indicate special functionality.
- * <p>
+ * </p>
  * The pattern may include ANSI escapes.
  * It may include these template markers:
  * <dl>
  * <dt>{@code %N}</dt>
  * <dd>A line number. This is the sum of {@code getLineNumber()}
  *   and a counter starting with 1 for the first continuation line.
+ * </dd>
  * <dt>{@code %M}</dt>
  * <dd>A short word explaining what is "missing". This is supplied from
  * the {@link EOFError#getMissing()} method, if provided.
@@ -56,9 +56,8 @@
  * <dt>{@code %%}</dt>
  * <dd>A literal {@code '%'}.
  * </dd>
- * <dt><code>%{</code></dt>
- * <dt><code>%}</code></dt>
- * Text between a <code>%{</code>...<code>%}</code> pair is printed as
+ * <dt><code>%{</code></dt><dt><code>%}</code></dt>
+ * <dd>Text between a <code>%{</code>...<code>%}</code> pair is printed as
  * part of a prompt, but not interpreted by JLine
  * (except that {@code '%'}-escapes are processed).  The text is assumed
  * to take zero columns (not move the cursor).  If it changes the style,
@@ -66,7 +65,6 @@
  * do not need to be within a <code>%{</code>...<code>%}</code> pair
  * (though can be) since JLine knows how to deal with them.  However,
  * these delimiters are needed for unusual non-standard escape sequences.
- * <dd>
  * </dd>
  * </dl>
  */
@@ -379,7 +377,7 @@ enum Option {
         DELAY_LINE_WRAP,
         AUTO_PARAM_SLASH(true),
         AUTO_REMOVE_SLASH(true),
-        /** When hitting the <tab> key at the beginning of the line, insert a tabulation
+        /** When hitting the <code>&lt;tab&gt;</code> key at the beginning of the line, insert a tabulation
          *  instead of completing.  This is mainly useful when {@link #BRACKETED_PASTE} is
          *  disabled, so that copy/paste of indented text does not trigger completion.
          */
@@ -423,7 +421,11 @@ enum RegionType {
     /**
      * Read the next line and return the contents of the buffer.
      *
-     * Equivalent to <code>readLine(null, null, null)</code>
+     * Equivalent to <code>readLine(null, null, null)</code>.
+     *
+     * @return the line read
+     * @throws UserInterruptException If the call was interrupted by the user.
+     * @throws EndOfFileException     If the end of the input stream was reached.
      */
     String readLine() throws UserInterruptException, EndOfFileException;
 
@@ -432,6 +434,11 @@ enum RegionType {
      * characters will be echoed. If 0, then no characters will be echoed.
      *
      * Equivalent to <code>readLine(null, mask, null)</code>
+     *
+     * @param mask      The mask character, <code>null</code> or <code>0</code>.
+     * @return          A line that is read from the terminal, can never be null.
+     * @throws UserInterruptException If the call was interrupted by the user.
+     * @throws EndOfFileException     If the end of the input stream was reached.
      */
     String readLine(Character mask) throws UserInterruptException, EndOfFileException;
 
@@ -440,6 +447,11 @@ enum RegionType {
      * If null, then the default prompt will be used.
      *
      * Equivalent to <code>readLine(prompt, null, null)</code>
+     *
+     * @param prompt    The prompt to issue to the terminal, may be null.
+     * @return          A line that is read from the terminal, can never be null.
+     * @throws UserInterruptException If the call was interrupted by the user.
+     * @throws EndOfFileException     If the end of the input stream was reached.
      */
     String readLine(String prompt) throws UserInterruptException, EndOfFileException;
 
@@ -448,6 +460,12 @@ enum RegionType {
      * (without any trailing newlines).
      *
      * Equivalent to <code>readLine(prompt, mask, null)</code>
+     *
+     * @param prompt    The prompt to issue to the terminal, may be null.
+     * @param mask      The mask character, <code>null</code> or <code>0</code>.
+     * @return          A line that is read from the terminal, can never be null.
+     * @throws UserInterruptException If the call was interrupted by the user.
+     * @throws EndOfFileException     If the end of the input stream was reached.
      */
     String readLine(String prompt, Character mask) throws UserInterruptException, EndOfFileException;
 
@@ -455,14 +473,16 @@ enum RegionType {
      * Read a line from the <i>in</i> {@link InputStream}, and return the line
      * (without any trailing newlines).
      *
+     * Equivalent to <code>readLine(prompt, null, mask, buffer)</code>
+     *
      * @param prompt    The prompt to issue to the terminal, may be null.
      *   This is a template, with optional {@code '%'} escapes, as
      *   described in the class header.
      * @param mask      The character mask, may be null.
      * @param buffer    The default value presented to the user to edit, may be null.
      * @return          A line that is read from the terminal, can never be null.
-     *
-     * Equivalent to <code>readLine(prompt, null, mask, buffer)</code>
+     * @throws UserInterruptException If the call was interrupted by the user.
+     * @throws EndOfFileException     If the end of the input stream was reached.
      */
     String readLine(String prompt, Character mask, String buffer) throws UserInterruptException, EndOfFileException;
 
@@ -483,6 +503,8 @@ enum RegionType {
      * @throws UserInterruptException if readLine was interrupted (using Ctrl-C for example)
      * @throws EndOfFileException if an EOF has been found (using Ctrl-D for example)
      * @throws java.io.IOError in case of other i/o errors
+     * @throws UserInterruptException If the call was interrupted by the user.
+     * @throws EndOfFileException     If the end of the input stream was reached.
      */
     String readLine(String prompt, String rightPrompt, Character mask, String buffer) throws UserInterruptException, EndOfFileException;
 
@@ -503,6 +525,8 @@ enum RegionType {
      * @throws UserInterruptException if readLine was interrupted (using Ctrl-C for example)
      * @throws EndOfFileException if an EOF has been found (using Ctrl-D for example)
      * @throws java.io.IOError in case of other i/o errors
+     * @throws UserInterruptException If the call was interrupted by the user.
+     * @throws EndOfFileException     If the end of the input stream was reached.
      */
     String readLine(String prompt, String rightPrompt, MaskingCallback maskingCallback, String buffer) throws UserInterruptException, EndOfFileException;
 
diff --git a/reader/src/main/java/org/jline/reader/MaskingCallback.java b/reader/src/main/java/org/jline/reader/MaskingCallback.java
index 3218f7d99..0d5f1269e 100644
--- a/reader/src/main/java/org/jline/reader/MaskingCallback.java
+++ b/reader/src/main/java/org/jline/reader/MaskingCallback.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2002-2017, the original author or authors.
+ * Copyright (c) 2002-2018, the original author or authors.
  *
  * This software is distributable under the BSD license. See the terms of the
  * BSD license in the documentation provided with this software.
@@ -16,11 +16,19 @@ public interface MaskingCallback {
     /**
      * Transforms the line before it is displayed so that
      * some parts can be hidden.
+     *
+     * @param line the current line being edited
+     * @return the modified line to display
      */
     String display(String line);
 
     /**
      * Transforms the line before storing in the history.
+     * If the return value is empty or null, it will not be saved
+     * in the history.
+     *
+     * @param line the line to be added to history
+     * @return the modified line
      */
     String history(String line);
 
diff --git a/reader/src/main/java/org/jline/reader/ParsedLine.java b/reader/src/main/java/org/jline/reader/ParsedLine.java
index d3d90eba3..a46fea420 100644
--- a/reader/src/main/java/org/jline/reader/ParsedLine.java
+++ b/reader/src/main/java/org/jline/reader/ParsedLine.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2002-2016, the original author or authors.
+ * Copyright (c) 2002-2018, the original author or authors.
  *
  * This software is distributable under the BSD license. See the terms of the
  * BSD license in the documentation provided with this software.
@@ -21,27 +21,37 @@ public interface ParsedLine {
     String word();
 
     /**
-     * The cursor position within the current word
+     * The cursor position within the current word.
+     *
+     * @return the cursor position within the current word
      */
     int wordCursor();
 
     /**
-     * The index of the current word in the list of words
+     * The index of the current word in the list of words.
+     *
+     * @return the index of the current word in the list of words
      */
     int wordIndex();
 
     /**
-     * The list of words
+     * The list of words.
+     *
+     * @return the list of words
      */
     List<String> words();
 
     /**
-     * The unparsed line
+     * The unparsed line.
+     *
+     * @return the unparsed line
      */
     String line();
 
     /**
-     * The cursor position within the line
+     * The cursor position within the line.
+     *
+     * @return the cursor position within the line
      */
     int cursor();
 
diff --git a/reader/src/main/java/org/jline/reader/impl/DefaultParser.java b/reader/src/main/java/org/jline/reader/impl/DefaultParser.java
index 789b74307..6a6f85c61 100644
--- a/reader/src/main/java/org/jline/reader/impl/DefaultParser.java
+++ b/reader/src/main/java/org/jline/reader/impl/DefaultParser.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2002-2016, the original author or authors.
+ * Copyright (c) 2002-2018, the original author or authors.
  *
  * This software is distributable under the BSD license. See the terms of the
  * BSD license in the documentation provided with this software.
@@ -204,6 +204,13 @@ public boolean isQuoteChar(final CharSequence buffer, final int pos) {
 
     /**
      * Check if this character is a valid escape char (i.e. one that has not been escaped)
+     *
+     * @param buffer
+     *          the buffer to check in
+     * @param pos
+     *          the position of the character to check
+     * @return true if the character at the specified position in the given buffer is an escape
+     *         character and the character immediately preceding it is not an escape character.
      */
     public boolean isEscapeChar(final CharSequence buffer, final int pos) {
         if (pos < 0) {
@@ -226,8 +233,8 @@ public boolean isEscapeChar(final CharSequence buffer, final int pos) {
      *          the buffer to check in
      * @param pos
      *          the position of the character to check
-     * @return true if the character at the specified position in the given buffer is an escape character and the character immediately preceding it is not an
-     *         escape character.
+     * @return true if the character at the specified position in the given buffer is an escape
+     *         character and the character immediately preceding it is an escape character.
      */
     public boolean isEscaped(final CharSequence buffer, final int pos) {
         if (pos <= 0) {
@@ -240,6 +247,12 @@ public boolean isEscaped(final CharSequence buffer, final int pos) {
      * Returns true if the character at the specified position if a delimiter. This method will only be called if
      * the character is not enclosed in any of the {@link #getQuoteChars}, and is not escaped by ant of the
      * {@link #getEscapeChars}. To perform escaping manually, override {@link #isDelimiter} instead.
+     *
+     * @param buffer
+     *          the buffer to check in
+     * @param pos
+     *          the position of the character to check
+     * @return true if the character at the specified position in the given buffer is a delimiter.
      */
     public boolean isDelimiterChar(CharSequence buffer, int pos) {
         return Character.isWhitespace(buffer.charAt(pos));
@@ -301,10 +314,10 @@ public ArgumentList(final String line, final List<String> words,
         /**
          *
          * @param line the command line being edited
-         * @param words
-         * @param wordIndex
-         * @param wordCursor
-         * @param cursor
+         * @param words the list of words
+         * @param wordIndex the index of the current word in the list of words
+         * @param wordCursor the cursor position within the current word
+         * @param cursor the cursor position within the line
          * @param openingQuote the opening quote (usually '\"' or '\'') or null
          * @param rawWordCursor the cursor position inside the raw word (i.e. including quotes and escape characters)
          * @param rawWordLength the raw word length, including quotes and escape characters
diff --git a/reader/src/main/java/org/jline/reader/impl/KillRing.java b/reader/src/main/java/org/jline/reader/impl/KillRing.java
index 3bc4e1df9..9c11a79b0 100644
--- a/reader/src/main/java/org/jline/reader/impl/KillRing.java
+++ b/reader/src/main/java/org/jline/reader/impl/KillRing.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2002-2016, the original author or authors.
+ * Copyright (c) 2002-2018, the original author or authors.
  *
  * This software is distributable under the BSD license. See the terms of the
  * BSD license in the documentation provided with this software.
@@ -32,6 +32,8 @@ public final class KillRing {
 
     /**
      * Creates a new kill ring of the given size.
+     *
+     * @param size the size of the ring
      */
     public KillRing(int size) {
         slots = new String[size];
@@ -60,6 +62,7 @@ public void resetLastKill() {
 
     /**
      * Returns {@code true} if the last command was a yank.
+     * @return {@code true} if the last command was a yank
      */
     public boolean lastYank() {
         return lastYank;
@@ -68,6 +71,7 @@ public boolean lastYank() {
     /**
      * Adds the string to the kill-ring. Also sets lastYank to false
      * and lastKill to true.
+     * @param str the string to add
      */
     public void add(String str) {
         lastYank = false;
@@ -90,6 +94,7 @@ public void add(String str) {
      * adds the text at the beginning of the previous kill to avoid
      * that two consecutive backwards kills followed by a yank leaves
      * things reversed.
+     * @param str the string to add
      */
     public void addBackwards(String str) {
         lastYank = false;
@@ -109,6 +114,7 @@ public void addBackwards(String str) {
     /**
      * Yanks a previously killed text. Returns {@code null} if the
      * ring is empty.
+     * @return the text in the current position
      */
     public String yank() {
         lastKill = false;
@@ -120,6 +126,7 @@ public String yank() {
      * Moves the pointer to the current slot back and returns the text
      * in that position. If the previous command was not yank returns
      * null.
+     * @return the text in the previous position
      */
     public String yankPop() {
         lastKill = false;
diff --git a/reader/src/main/java/org/jline/reader/impl/LineReaderImpl.java b/reader/src/main/java/org/jline/reader/impl/LineReaderImpl.java
index 416eb873e..f6e9cf2d3 100644
--- a/reader/src/main/java/org/jline/reader/impl/LineReaderImpl.java
+++ b/reader/src/main/java/org/jline/reader/impl/LineReaderImpl.java
@@ -308,6 +308,8 @@ public MouseEvent readMouseEvent() {
 
     /**
      * Set the completer.
+     *
+     * @param completer the completer to use
      */
     public void setCompleter(Completer completer) {
         this.completer = completer;
@@ -315,6 +317,8 @@ public void setCompleter(Completer completer) {
 
     /**
      * Returns the completer.
+     *
+     * @return the completer
      */
     public Completer getCompleter() {
         return completer;
@@ -368,6 +372,8 @@ public void setExpander(Expander expander) {
 
     /**
      * Read the next line and return the contents of the buffer.
+     *
+     * @return          A line that is read from the terminal, can never be null.
      */
     public String readLine() throws UserInterruptException, EndOfFileException {
         return readLine(null, null, (MaskingCallback) null, null);
@@ -376,11 +382,21 @@ public String readLine() throws UserInterruptException, EndOfFileException {
     /**
      * Read the next line with the specified character mask. If null, then
      * characters will be echoed. If 0, then no characters will be echoed.
+     *
+     * @param mask      The mask character, <code>null</code> or <code>0</code>.
+     * @return          A line that is read from the terminal, can never be null.
      */
     public String readLine(Character mask) throws UserInterruptException, EndOfFileException {
         return readLine(null, null, mask, null);
     }
 
+    /**
+     * Read a line from the <i>in</i> {@link InputStream}, and return the line
+     * (without any trailing newlines).
+     *
+     * @param prompt    The prompt to issue to the terminal, may be null.
+     * @return          A line that is read from the terminal, can never be null.
+     */
     public String readLine(String prompt) throws UserInterruptException, EndOfFileException {
         return readLine(prompt, null, (MaskingCallback) null, null);
     }
@@ -390,8 +406,8 @@ public String readLine(String prompt) throws UserInterruptException, EndOfFileEx
      * (without any trailing newlines).
      *
      * @param prompt    The prompt to issue to the terminal, may be null.
-     * @return          A line that is read from the terminal, or null if there was null input (e.g., <i>CTRL-D</i>
-     *                  was pressed).
+     * @param mask      The mask character, <code>null</code> or <code>0</code>.
+     * @return          A line that is read from the terminal, can never be null.
      */
     public String readLine(String prompt, Character mask) throws UserInterruptException, EndOfFileException {
         return readLine(prompt, null, mask, null);
@@ -402,8 +418,9 @@ public String readLine(String prompt, Character mask) throws UserInterruptExcept
      * (without any trailing newlines).
      *
      * @param prompt    The prompt to issue to the terminal, may be null.
-     * @return          A line that is read from the terminal, or null if there was null input (e.g., <i>CTRL-D</i>
-     *                  was pressed).
+     * @param mask      The mask character, <code>null</code> or <code>0</code>.
+     * @param buffer    A string that will be set for editing.
+     * @return          A line that is read from the terminal, can never be null.
      */
     public String readLine(String prompt, Character mask, String buffer) throws UserInterruptException, EndOfFileException {
         return readLine(prompt, null, mask, buffer);
@@ -413,14 +430,26 @@ public String readLine(String prompt, Character mask, String buffer) throws User
      * Read a line from the <i>in</i> {@link InputStream}, and return the line
      * (without any trailing newlines).
      *
-     * @param prompt    The prompt to issue to the terminal, may be null.
-     * @return          A line that is read from the terminal, or null if there was null input (e.g., <i>CTRL-D</i>
-     *                  was pressed).
+     * @param prompt      The prompt to issue to the terminal, may be null.
+     * @param rightPrompt The prompt to issue to the right of the terminal, may be null.
+     * @param mask        The mask character, <code>null</code> or <code>0</code>.
+     * @param buffer      A string that will be set for editing.
+     * @return            A line that is read from the terminal, can never be null.
      */
     public String readLine(String prompt, String rightPrompt, Character mask, String buffer) throws UserInterruptException, EndOfFileException {
         return readLine(prompt, rightPrompt, mask != null ? new SimpleMaskingCallback(mask) : null, buffer);
     }
 
+    /**
+     * Read a line from the <i>in</i> {@link InputStream}, and return the line
+     * (without any trailing newlines).
+     *
+     * @param prompt          The prompt to issue to the terminal, may be null.
+     * @param rightPrompt     The prompt to issue to the right of the terminal, may be null.
+     * @param maskingCallback The callback used to mask parts of the edited line.
+     * @param buffer          A string that will be set for editing.
+     * @return                A line that is read from the terminal, can never be null.
+     */
     public String readLine(String prompt, String rightPrompt, MaskingCallback maskingCallback, String buffer) throws UserInterruptException, EndOfFileException {
         // prompt may be null
         // maskingCallback may be null
@@ -599,7 +628,7 @@ public String readLine(String prompt, String rightPrompt, MaskingCallback maskin
         }
     }
 
-    /** Make sure we position the cursor on column 0 */
+    /* Make sure we position the cursor on column 0 */
     protected boolean freshLine() {
         boolean wrapAtEol = terminal.getBooleanCapability(Capability.auto_right_margin);
         boolean delayedWrapAtEol = wrapAtEol && terminal.getBooleanCapability(Capability.eat_newline_glitch);
@@ -657,6 +686,7 @@ public void callWidget(String name) {
 
     /**
      * Clear the line and redraw it.
+     * @return <code>true</code>
      */
     public boolean redrawLine() {
         display.reset();
@@ -665,14 +695,16 @@ public boolean redrawLine() {
 
     /**
      * Write out the specified string to the buffer and the output stream.
+     * @param str the char sequence to write in the buffer
      */
     public void putString(final CharSequence str) {
         buf.write(str, overTyping);
     }
 
     /**
-     * Flush the terminal output stream. This is important for printout out single characters (like a buf.backspace or
-     * keyboard) that we want the terminal to handle immediately.
+     * Flush the terminal output stream. This is important for printout out single
+     * characters (like a buf.backspace or keyboard) that we want the terminal to
+     * handle immediately.
      */
     public void flush() {
         terminal.flush();
@@ -1770,6 +1802,8 @@ private boolean callNeg(Widget widget) {
 
     /**
      * Implements vi search ("/" or "?").
+     *
+     * @return <code>true</code> if the search was successful
      */
     protected boolean viHistorySearchForward() {
         searchDir = 1;
@@ -1937,7 +1971,7 @@ protected boolean undefinedKey() {
     /**
      * Implements vi style bracket matching ("%" command). The matching
      * bracket for the current bracket type that you are sitting on is matched.
-     * The logic works like so:
+     *
      * @return true if it worked, false if the cursor was not on a bracket
      *   character or if there was no matching bracket.
      */
@@ -2007,6 +2041,7 @@ protected int getBracketType (int ch) {
      * Performs character transpose. The character prior to the cursor and the
      * character under the cursor are swapped and the cursor is advanced one.
      * Do not cross line breaks.
+     * @return true
      */
     protected boolean transposeChars() {
         int lstart = buf.cursor() - 1;
@@ -2953,6 +2988,7 @@ protected boolean deleteChar() {
 
     /**
      * Deletes the previous character from the cursor position
+     * @return <code>true</code> if it succeeded, <code>false</code> otherwise
      */
     protected boolean viBackwardDeleteChar() {
         for (int i = 0; i < count; i++) {
@@ -2966,6 +3002,7 @@ protected boolean viBackwardDeleteChar() {
     /**
      * Deletes the character you are sitting on and sucks the rest of
      * the line in from the right.
+     * @return <code>true</code> if it succeeded, <code>false</code> otherwise
      */
     protected boolean viDeleteChar() {
         for (int i = 0; i < count; i++) {
@@ -2980,6 +3017,7 @@ protected boolean viDeleteChar() {
      * Switches the case of the current character from upper to lower
      * or lower to upper as necessary and advances the cursor one
      * position to the right.
+     * @return <code>true</code> if it succeeded, <code>false</code> otherwise
      */
     protected boolean viSwapCase() {
         for (int i = 0; i < count; i++) {
@@ -2998,6 +3036,7 @@ protected boolean viSwapCase() {
     /**
      * Implements the vi change character command (in move-mode "r"
      * followed by the character to change to).
+     * @return <code>true</code> if it succeeded, <code>false</code> otherwise
      */
     protected boolean viReplaceChars() {
         int c = readCharacter();
@@ -3034,7 +3073,7 @@ protected boolean viDeleteTo(int startPos, int endPos) {
      * @param isChange If true, then the delete is part of a change operationg
      *    (e.g. "c$" is change-to-end-of line, so we first must delete to end
      *    of line to start the change
-     * @return true if it succeeded, false otherwise
+     * @return <code>true</code> if it succeeded, <code>false</code> otherwise
      */
     protected boolean doViDeleteOrChange(int startPos, int endPos, boolean isChange) {
         if (startPos == endPos) {
@@ -3068,7 +3107,7 @@ protected boolean doViDeleteOrChange(int startPos, int endPos, boolean isChange)
      *
      * @param startPos The starting position from which to yank
      * @param endPos The ending position to which to yank
-     * @return true if the yank succeeded
+     * @return <code>true</code> if the yank succeeded
      */
     protected boolean viYankTo(int startPos, int endPos) {
         int cursorPos = startPos;
@@ -3110,6 +3149,7 @@ protected boolean viOpenLineBelow() {
     /**
      * Pasts the yank buffer to the right of the current cursor position
      * and moves the cursor to the end of the pasted region.
+     * @return <code>true</code>
      */
     protected boolean viPutAfter() {
         if (yankBuffer.indexOf('\n') >= 0) {
@@ -3524,7 +3564,7 @@ private void concat(List<AttributedString> lines, AttributedStringBuilder sb) {
     /**
      * Compute the full string to be displayed with the left, right and secondary prompts
      * @param secondaryPrompts a list to store the secondary prompts
-     * @return
+     * @return the displayed string including the buffer, left prompts and the help below
      */
     public AttributedString getDisplayedBufferWithPrompts(List<AttributedString> secondaryPrompts) {
         AttributedString attBuf = getHighlightedBuffer(buf.toString());
@@ -4812,6 +4852,8 @@ protected boolean moveHistory(final boolean next, int count) {
 
     /**
      * Move up or down the history tree.
+     * @param next <code>true</code> to go to the next, <code>false</code> for the previous.
+     * @return <code>true</code> if successful, <code>false</code> otherwise
      */
     protected boolean moveHistory(final boolean next) {
         if (!buf.toString().equals(history.current())) {
@@ -4836,7 +4878,8 @@ else if (!next && !history.previous()) {
     //
 
     /**
-     * Raw output printing
+     * Raw output printing.
+     * @param str the string to print to the terminal
      */
     void print(String str) {
         terminal.writer().write(str);
@@ -5124,6 +5167,7 @@ public boolean focusOut() {
 
     /**
      * Clean the used display
+     * @return <code>true</code>
      */
     public boolean clear() {
         display.update(Collections.emptyList(), 0);
@@ -5132,6 +5176,7 @@ public boolean clear() {
 
     /**
      * Clear the screen by issuing the ANSI "clear screen" code.
+     * @return <code>true</code>
      */
     public boolean clearScreen() {
         if (terminal.puts(Capability.clear_screen)) {
@@ -5144,6 +5189,7 @@ public boolean clearScreen() {
 
     /**
      * Issue an audible keyboard bell.
+     * @return <code>true</code>
      */
     public boolean beep() {
         BellType bell_preference = BellType.AUDIBLE;
diff --git a/reader/src/main/java/org/jline/reader/impl/completer/ArgumentCompleter.java b/reader/src/main/java/org/jline/reader/impl/completer/ArgumentCompleter.java
index 3a9b9cf72..c2217ec9b 100644
--- a/reader/src/main/java/org/jline/reader/impl/completer/ArgumentCompleter.java
+++ b/reader/src/main/java/org/jline/reader/impl/completer/ArgumentCompleter.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2002-2016, the original author or authors.
+ * Copyright (c) 2002-2018, the original author or authors.
  *
  * This software is distributable under the BSD license. See the terms of the
  * BSD license in the documentation provided with this software.
@@ -57,6 +57,8 @@ public ArgumentCompleter(final Completer... completers) {
     /**
      * If true, a completion at argument index N will only succeed
      * if all the completions from 0-(N-1) also succeed.
+     *
+     * @param strict the strict flag
      */
     public void setStrict(final boolean strict) {
         this.strict = strict;
@@ -74,6 +76,8 @@ public boolean isStrict() {
     }
 
     /**
+     * Returns the list of completers used inside this <code>ArgumentCompleter</code>.
+     * @return The list of completers.
      * @since 2.3
      */
     public List<Completer> getCompleters() {
diff --git a/reader/src/main/java/org/jline/reader/impl/completer/FileNameCompleter.java b/reader/src/main/java/org/jline/reader/impl/completer/FileNameCompleter.java
index 4a94798a9..e74df3ead 100644
--- a/reader/src/main/java/org/jline/reader/impl/completer/FileNameCompleter.java
+++ b/reader/src/main/java/org/jline/reader/impl/completer/FileNameCompleter.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2002-2016, the original author or authors.
+ * Copyright (c) 2002-2018, the original author or authors.
  *
  * This software is distributable under the BSD license. See the terms of the
  * BSD license in the documentation provided with this software.
@@ -8,7 +8,6 @@
  */
 package org.jline.reader.impl.completer;
 
-import java.io.File;
 import java.io.IOException;
 import java.nio.file.Files;
 import java.nio.file.Path;
@@ -27,11 +26,10 @@
 /**
  * A file name completer takes the buffer and issues a list of
  * potential completions.
- * <p/>
+ * <p>
  * This completer tries to behave as similar as possible to
  * <i>bash</i>'s file name completion (using GNU readline)
  * with the following exceptions:
- * <p/>
  * <ul>
  * <li>Candidates that are directories will end with "/"</li>
  * <li>Wildcard regular expressions are not evaluated or replaced</li>
@@ -43,8 +41,7 @@
  * @author <a href="mailto:mwp1@cornell.edu">Marc Prud'hommeaux</a>
  * @author <a href="mailto:jason@planet57.com">Jason Dillon</a>
  * @since 2.3
- * @deprecated use org.jline.builtins.Completers$FileNameCompleter instead
- * @see org.jline.builtins.Completers$FileNameCompleter
+ * @deprecated use <code>org.jline.builtins.Completers$FileNameCompleter</code> instead
  */
 @Deprecated
 public class FileNameCompleter implements Completer
diff --git a/reader/src/main/java/org/jline/reader/impl/history/DefaultHistory.java b/reader/src/main/java/org/jline/reader/impl/history/DefaultHistory.java
index 6cea4644b..c04b48f54 100644
--- a/reader/src/main/java/org/jline/reader/impl/history/DefaultHistory.java
+++ b/reader/src/main/java/org/jline/reader/impl/history/DefaultHistory.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2002-2016, the original author or authors.
+ * Copyright (c) 2002-2018, the original author or authors.
  *
  * This software is distributable under the BSD license. See the terms of the
  * BSD license in the documentation provided with this software.
@@ -22,9 +22,10 @@
 
 /**
  * {@link History} using a file for persistent backing.
- * <p/>
+ * <p>
  * Implementers should install shutdown hook to call {@link DefaultHistory#save}
  * to save history to disk.
+ * </p>
  */
 public class DefaultHistory implements History {
 
diff --git a/remote-telnet/src/main/java/org/jline/builtins/telnet/Connection.java b/remote-telnet/src/main/java/org/jline/builtins/telnet/Connection.java
index 788f9876c..522e570bc 100644
--- a/remote-telnet/src/main/java/org/jline/builtins/telnet/Connection.java
+++ b/remote-telnet/src/main/java/org/jline/builtins/telnet/Connection.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2002-2017, the original author or authors.
+ * Copyright (c) 2002-2018, the original author or authors.
  *
  * This software is distributable under the BSD license. See the terms of the
  * BSD license in the documentation provided with this software.
@@ -46,18 +46,20 @@
 import java.util.logging.Logger;
 
 /**
- * Class that implements a connection with this telnet daemon.<br>
+ * Class that implements a connection with this telnet daemon.
+ * <p>
  * It is derived from java.lang.Thread, which reflects the architecture
  * constraint of one thread per connection. This might seem a waste of
  * resources, but as a matter of fact sharing threads would require a
  * far more complex imlementation, due to the fact that telnet is not a
  * stateless protocol (i.e. alive throughout a session of multiple requests
- * and responses).<br>
+ * and responses).
+ * <p>
  * Each Connection instance is created by the listeners ConnectionManager
  * instance, making it part of a threadgroup and passing in an associated
  * ConnectionData instance, that holds vital information about the connection.
- * Be sure to take a look at their documention.<br>
- * <p/>
+ * Be sure to take a look at their documention.
+ * <p>
  * Once the thread has started and is running, it will get a login
  * shell instance from the ShellManager and run passing its own reference.
  *
diff --git a/remote-telnet/src/main/java/org/jline/builtins/telnet/ConnectionData.java b/remote-telnet/src/main/java/org/jline/builtins/telnet/ConnectionData.java
index b955bab67..cfc0569d6 100644
--- a/remote-telnet/src/main/java/org/jline/builtins/telnet/ConnectionData.java
+++ b/remote-telnet/src/main/java/org/jline/builtins/telnet/ConnectionData.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2002-2017, the original author or authors.
+ * Copyright (c) 2002-2018, the original author or authors.
  *
  * This software is distributable under the BSD license. See the terms of the
  * BSD license in the documentation provided with this software.
@@ -80,6 +80,7 @@ public class ConnectionData {
      * information about a connection.
      *
      * @param sock Socket of the inbound connection.
+     * @param cm the connection manager
      */
     public ConnectionData(Socket sock, ConnectionManager cm) {
         socket = sock;
@@ -314,10 +315,10 @@ public String getNegotiatedTerminalType() {
     /**
      * Sets the terminal type that has been negotiated
      * between telnet client and telnet server, in form of
-     * a String.<br>
-     * <p/>
+     * a String.
+     * <p>
      * <em>This method should not be called explicitly
-     * by the application (i.e. the its here for the io subsystem).</em><br>
+     * by the application (i.e. the its here for the io subsystem).</em>
      *
      * @param termtype the negotiated terminal type as String.
      */
diff --git a/remote-telnet/src/main/java/org/jline/builtins/telnet/ConnectionEvent.java b/remote-telnet/src/main/java/org/jline/builtins/telnet/ConnectionEvent.java
index 65e07ff9f..ca089abd7 100644
--- a/remote-telnet/src/main/java/org/jline/builtins/telnet/ConnectionEvent.java
+++ b/remote-telnet/src/main/java/org/jline/builtins/telnet/ConnectionEvent.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2002-2017, the original author or authors.
+ * Copyright (c) 2002-2018, the original author or authors.
  *
  * This software is distributable under the BSD license. See the terms of the
  * BSD license in the documentation provided with this software.
@@ -104,9 +104,10 @@ public enum Type {
         CONNECTION_TIMEDOUT,
 
         /**
-         * Defines the connection requested logout event type.<br>
+         * Defines the connection requested logout event type.
+         * <p>
          * It occurs if a connection requested disgraceful logout by
-         * sending a <Ctrl>-<D> key combination.
+         * sending a <code>&lt;Ctrl&gt;-&lt;D&gt;</code> key combination.
          */
         CONNECTION_LOGOUTREQUEST,
 
diff --git a/remote-telnet/src/main/java/org/jline/builtins/telnet/ConnectionManager.java b/remote-telnet/src/main/java/org/jline/builtins/telnet/ConnectionManager.java
index 3eb71424e..ca7534ac8 100644
--- a/remote-telnet/src/main/java/org/jline/builtins/telnet/ConnectionManager.java
+++ b/remote-telnet/src/main/java/org/jline/builtins/telnet/ConnectionManager.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2002-2017, the original author or authors.
+ * Copyright (c) 2002-2018, the original author or authors.
  *
  * This software is distributable under the BSD license. See the terms of the
  * BSD license in the documentation provided with this software.
@@ -123,8 +123,8 @@ public int openConnectionCount() {
 
     /**
      * Returns the {@link Connection} at the given index.
-     * @param idx
-     * @return
+     * @param idx the index
+     * @return the connection
      */
     public Connection getConnection(int idx) {
         synchronized (openConnections) {
@@ -136,6 +136,7 @@ public Connection getConnection(int idx) {
      * Get all {@link Connection} instances with the given
      * <tt>InetAddress</tt>.
      *
+     * @param addr the address
      * @return all {@link Connection} instances with the given
      *         <tt>InetAddress</tt>.
      */
diff --git a/remote-telnet/src/main/java/org/jline/builtins/telnet/PortListener.java b/remote-telnet/src/main/java/org/jline/builtins/telnet/PortListener.java
index a514036fe..95bb7e296 100644
--- a/remote-telnet/src/main/java/org/jline/builtins/telnet/PortListener.java
+++ b/remote-telnet/src/main/java/org/jline/builtins/telnet/PortListener.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2002-2017, the original author or authors.
+ * Copyright (c) 2002-2018, the original author or authors.
  *
  * This software is distributable under the BSD license. See the terms of the
  * BSD license in the documentation provided with this software.
@@ -75,6 +75,7 @@ public class PortListener
     /**
      * Constructs a PortListener instance.<br>
      *
+     * @param name      the name
      * @param port      int that specifies the port number of the server socket.
      * @param floodprot that specifies the server socket queue size.
      */
diff --git a/remote-telnet/src/main/java/org/jline/builtins/telnet/TelnetIO.java b/remote-telnet/src/main/java/org/jline/builtins/telnet/TelnetIO.java
index a5751cfef..61b91b068 100644
--- a/remote-telnet/src/main/java/org/jline/builtins/telnet/TelnetIO.java
+++ b/remote-telnet/src/main/java/org/jline/builtins/telnet/TelnetIO.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2002-2017, the original author or authors.
+ * Copyright (c) 2002-2018, the original author or authors.
  *
  * This software is distributable under the BSD license. See the terms of the
  * BSD license in the documentation provided with this software.
@@ -52,12 +52,12 @@
  * Class that represents the TelnetIO implementation. It contains
  * an inner IACHandler class to handle the telnet protocol level
  * communication.
- * <p/>
+ * <p>
  * Although supposed to work full-duplex, we only process the telnet protocol
  * layer communication in case of reading requests from the higher levels.
  * This is the only way to meet the one thread per connection requirement.
  * </p>
- * <p/>
+ * <p>
  * The output is done via byte-oriented streams, definately suitable for the
  * telnet protocol. The format of the  output is UTF-8 (Unicode), which is a
  * standard and supported by any telnet client, including the ones included
@@ -199,7 +199,7 @@ public class TelnetIO {
     protected static final int LOGOUT = 18;
     /**
      * Telnet Option: Linemode
-     * <p/>
+     * <p>
      * The infamous line mode option.
      */
     protected static final int LINEMODE = 34;
@@ -334,6 +334,7 @@ public void setConnection(Connection con) {
      * alone,but CRLF(\r\n), which is a rule of the telnet protocol.
      *
      * @param b Byte to be written.
+     * @throws IOException if an error occurs
      */
     public void write(byte b) throws IOException {
         //ensure CRLF(\r\n) is written for LF(\n) to adhere
@@ -355,6 +356,7 @@ public void write(byte b) throws IOException {
      * Method to output an int.
      *
      * @param i Integer to be written.
+     * @throws IOException if an error occurs
      */
     public void write(int i)
             throws IOException {
@@ -365,6 +367,7 @@ public void write(int i)
      * Method to write an array of bytes.
      *
      * @param sequence byte[] to be written.
+     * @throws IOException if an error occurs
      */
     public void write(byte[] sequence) throws IOException {
         for (byte b : sequence) {
@@ -376,6 +379,7 @@ public void write(byte[] sequence) throws IOException {
      * Method to output an array of int' s.
      *
      * @param sequence int [] to write
+     * @throws IOException if an error occurs
      */
     public void write(int[] sequence) throws IOException {
         for (int i : sequence) {
@@ -387,6 +391,7 @@ public void write(int[] sequence) throws IOException {
      * Method to write a char.
      *
      * @param ch char to be written.
+     * @throws IOException if an error occurs
      */
     public void write(char ch) throws IOException {
         write((byte) ch);
@@ -396,6 +401,7 @@ public void write(char ch) throws IOException {
      * Method to output a string.
      *
      * @param str String to be written.
+     * @throws IOException if an error occurs
      */
     public void write(String str) throws IOException {
         write(str.getBytes());
@@ -403,6 +409,8 @@ public void write(String str) throws IOException {
 
     /**
      * Method to flush all buffered output.
+     *
+     * @throws IOException if an error occurs
      */
     public void flush() throws IOException {
         out.flush();
@@ -438,6 +446,7 @@ private void rawWrite(int i) throws IOException {
      * Invokes the IACHandler upon IAC (Byte=255).
      *
      * @return int read from stream.
+     * @throws IOException if an error occurs
      */
     public int read() throws IOException {
         int c = rawread();
@@ -475,13 +484,15 @@ public void closeInput() {
     /**
      * This method reads an unsigned 16bit Integer from the stream,
      * its here for getting the NAWS Data Values for height and width.
+     *
+     * @throws IOException if an error occurs
      */
     private int read16int() throws IOException {
         int c = in.readUnsignedShort();
         return c;
     }//read16int
 
-    /**
+    /*
      * The following options are options which might be of interest, but are not
      * yet implemented or in use.
      */
@@ -491,6 +502,7 @@ private int read16int() throws IOException {
      * Telnet protocol layer communication is filtered and processed here.
      *
      * @return int read from stream.
+     * @throws IOException if an error occurs
      */
     private int rawread() throws IOException {
         int b = 0;
@@ -505,6 +517,8 @@ private int rawread() throws IOException {
      * Checks for the telnet protocol specified  CR followed by NULL or LF<BR>
      * Subsequently reads for the next byte and forwards
      * only a ENTER represented by LF internally.
+     *
+     * @throws IOException if an error occurs
      */
     private int stripCRSeq(int input) throws IOException {
         if (input == 13) {
@@ -605,12 +619,13 @@ public void setEcho(boolean b) {
      * <LI><A HREF="ftp://ds.internic.net/rfc/rfc1073.txt">1073 Telnet Window Size Option</A>
      * <LI><A HREF="ftp://ds.internic.net/rfc/rfc1091.txt">1091 Telnet Terminal-Type Option</A>
      * </OL>
-     * <p/>
+     * <p>
      * Furthermore there are some more, which helped to solve problems, or might be important
      * for future enhancements:<BR>
      * <A HREF="ftp://ds.internic.net/rfc/rfc1143.txt">1143 The Q Method of Implementing Option Negotiation</A><BR>
      * <A HREF="ftp://ds.internic.net/rfc/rfc1416.txt">1416 Telnet Authentication Option</A><BR>
-     * <p/>
+     * </p>
+     * <p>
      * After an intense study of the available material (mainly cryptical written RFCs,
      * a telnet client implementation for the macintosh based upon NCSA telnet, and a server side
      * implementation called key, a mud-like system completely written in Java) I realized
@@ -623,14 +638,12 @@ public void setEcho(boolean b) {
      * a BBS is intended to be a single process the user is interacting with.
      * <LI> The <B>LAMER</B> has to be expected to log in with the standard Microsoft telnet
      * implementation. This means forget every nice feature and most of the almost-standards.
-     * <p/>
      * </OL>
-     * <BR>
      *
      * @author Dieter Wimberger
      * @version 1.1 16/06/1998
-     * <p/>
-     * <p/>
+     *
+     * <p>
      * <B>To-Do</B>:<UL>
      * <LI>UNIX conform new style TTYPE negotiation. Setting a list and selecting from it...
      * </UL>
diff --git a/style/src/main/java/org/jline/style/StyleExpression.java b/style/src/main/java/org/jline/style/StyleExpression.java
index ceb1607f4..2b9ee212f 100644
--- a/style/src/main/java/org/jline/style/StyleExpression.java
+++ b/style/src/main/java/org/jline/style/StyleExpression.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2002-2017, the original author or authors.
+ * Copyright (c) 2002-2018, the original author or authors.
  *
  * This software is distributable under the BSD license. See the terms of the
  * BSD license in the documentation provided with this software.
@@ -35,6 +35,9 @@ public StyleExpression(final StyleResolver resolver) {
 
     /**
      * Evaluate expression and append to buffer.
+     *
+     * @param buff the buffer to append to
+     * @param expression the expression to evaluate
      */
     public void evaluate(final AttributedStringBuilder buff, final String expression) {
         requireNonNull(buff);
@@ -57,6 +60,9 @@ private String style(String key) {
 
     /**
      * Evaluate expression.
+     *
+     * @param expression the expression to evaluate
+     * @return the result string
      */
     public AttributedString evaluate(final String expression) {
         AttributedStringBuilder buff = new AttributedStringBuilder();
diff --git a/style/src/main/java/org/jline/style/StyleFactory.java b/style/src/main/java/org/jline/style/StyleFactory.java
index 56e60a9ee..bdd5b429e 100644
--- a/style/src/main/java/org/jline/style/StyleFactory.java
+++ b/style/src/main/java/org/jline/style/StyleFactory.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2002-2017, the original author or authors.
+ * Copyright (c) 2002-2018, the original author or authors.
  *
  * This software is distributable under the BSD license. See the terms of the
  * BSD license in the documentation provided with this software.
@@ -27,6 +27,10 @@ public StyleFactory(final StyleResolver resolver) {
 
     /**
      * Encode string with style applying value.
+     *
+     * @param style the style
+     * @param value the value
+     * @return the result string
      */
     public AttributedString style(final String style, final String value) {
         requireNonNull(value);
@@ -37,6 +41,10 @@ public AttributedString style(final String style, final String value) {
     /**
      * Encode string with style formatted value.
      *
+     * @param style the style
+     * @param format the format
+     * @param params the parameters
+     * @return the result string
      * @see #style(String, String)
      */
     public AttributedString style(final String style, final String format, final Object... params) {
@@ -48,6 +56,9 @@ public AttributedString style(final String style, final String format, final Obj
 
     /**
      * Evaluate a style expression.
+     *
+     * @param expression the expression to evaluate
+     * @return the result string
      */
     public AttributedString evaluate(final String expression) {
         requireNonNull(expression);
@@ -57,6 +68,9 @@ public AttributedString evaluate(final String expression) {
     /**
      * Evaluate a style expression with format.
      *
+     * @param format the format
+     * @param params the parameters
+     * @return the result string
      * @see #evaluate(String)
      */
     public AttributedString evaluate(final String format, final Object... params) {
diff --git a/style/src/main/java/org/jline/style/StyleSource.java b/style/src/main/java/org/jline/style/StyleSource.java
index b6e6b6189..a6f28877a 100644
--- a/style/src/main/java/org/jline/style/StyleSource.java
+++ b/style/src/main/java/org/jline/style/StyleSource.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2002-2017, the original author or authors.
+ * Copyright (c) 2002-2018, the original author or authors.
  *
  * This software is distributable under the BSD license. See the terms of the
  * BSD license in the documentation provided with this software.
@@ -19,22 +19,35 @@
 public interface StyleSource {
     /**
      * Returns the appropriate style for the given style-group and style-name, or {@code null} if missing.
+     *
+     * @param group the group
+     * @param name the style name
+     * @return the style
      */
     @Nullable
     String get(String group, String name);
 
     /**
      * Set a specific style in a style-group.
+     *
+     * @param group the group
+     * @param name the style name
+     * @param style the style to set
      */
     void set(String group, String name, String style);
 
     /**
      * Remove all styles for given style-group.
+     *
+     * @param group the group
      */
     void remove(String group);
 
     /**
      * Remove a specific style from style-group.
+     *
+     * @param group the group
+     * @param name the style name to remove
      */
     void remove(String group, String name);
 
@@ -53,6 +66,7 @@ public interface StyleSource {
     /**
      * Returns configured styles for given style-group.
      *
+     * @param group  the style group
      * @return Immutable map.
      */
     Map<String, String> styles(String group);
diff --git a/style/src/main/java/org/jline/style/Styler.java b/style/src/main/java/org/jline/style/Styler.java
index a59472f6e..9023af4e1 100644
--- a/style/src/main/java/org/jline/style/Styler.java
+++ b/style/src/main/java/org/jline/style/Styler.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2002-2017, the original author or authors.
+ * Copyright (c) 2002-2018, the original author or authors.
  *
  * This software is distributable under the BSD license. See the terms of the
  * BSD license in the documentation provided with this software.
@@ -34,6 +34,8 @@ private Styler() {
 
     /**
      * Returns global {@link StyleSource}.
+     *
+     * @return the global style source
      */
     public static StyleSource getSource() {
         return source;
@@ -41,6 +43,8 @@ public static StyleSource getSource() {
 
     /**
      * Install global {@link StyleSource}.
+     *
+     * @param source the new global style source
      */
     public static void setSource(final StyleSource source) {
         Styler.source = requireNonNull(source);
@@ -52,6 +56,9 @@ public static void setSource(final StyleSource source) {
 
     /**
      * Create a resolver for the given style-group.
+     *
+     * @param group the group
+     * @return the resolver
      */
     public static StyleResolver resolver(final String group) {
         return new StyleResolver(source, group);
@@ -59,6 +66,9 @@ public static StyleResolver resolver(final String group) {
 
     /**
      * Create a factory for the given style-group.
+     *
+     * @param group the group
+     * @return the factory
      */
     public static StyleFactory factory(final String group) {
         return new StyleFactory(resolver(group));
@@ -68,6 +78,10 @@ public static StyleFactory factory(final String group) {
      * Create a {@link StyleBundle} proxy.
      * <p>
      * Target class must be annotated with {@link StyleGroup}.
+     *
+     * @param <T> the interface to proxy
+     * @param type the interface to proxy
+     * @return the proxy
      */
     public static <T extends StyleBundle> T bundle(final Class<T> type) {
         return StyleBundleInvocationHandler.create(source, type);
@@ -75,6 +89,11 @@ public static <T extends StyleBundle> T bundle(final Class<T> type) {
 
     /**
      * Create a {@link StyleBundle} proxy with explicit style-group.
+     *
+     * @param <T> the interface to proxy
+     * @param group the group
+     * @param type the interface to proxy
+     * @return the proxy
      */
     public static <T extends StyleBundle> T bundle(final String group, final Class<T> type) {
         return StyleBundleInvocationHandler.create(resolver(group), type);
diff --git a/terminal-jansi/src/main/java/org/jline/terminal/impl/jansi/win/WindowsAnsiWriter.java b/terminal-jansi/src/main/java/org/jline/terminal/impl/jansi/win/WindowsAnsiWriter.java
index 8c9e1e4d0..bd9820990 100644
--- a/terminal-jansi/src/main/java/org/jline/terminal/impl/jansi/win/WindowsAnsiWriter.java
+++ b/terminal-jansi/src/main/java/org/jline/terminal/impl/jansi/win/WindowsAnsiWriter.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2009-2017 the original author(s).
+ * Copyright (C) 2009-2018 the original author(s).
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -388,7 +388,7 @@ protected void processDeleteLine(int optionInt) throws IOException {
     }
 
     @Override
-    protected void processChangeWindowTitle(String label) {
-        SetConsoleTitle(label);
+    protected void processChangeWindowTitle(String title) {
+        SetConsoleTitle(title);
     }
 }
diff --git a/terminal/src/main/java/org/jline/terminal/Size.java b/terminal/src/main/java/org/jline/terminal/Size.java
index 7db931ad0..2886b5f37 100644
--- a/terminal/src/main/java/org/jline/terminal/Size.java
+++ b/terminal/src/main/java/org/jline/terminal/Size.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2002-2016, the original author or authors.
+ * Copyright (c) 2002-2018, the original author or authors.
  *
  * This software is distributable under the BSD license. See the terms of the
  * BSD license in the documentation provided with this software.
@@ -38,9 +38,16 @@ public void setRows(int rows) {
         this.rows = (short) rows;
     }
 
-    /** A cursor position combines a row number with a column position.
+    /**
+     * A cursor position combines a row number with a column position.
+     * <p>
      * Note each row has {@code col+1} different column positions,
      * including the right margin.
+     * </p>
+     *
+     * @param col the new column
+     * @param row the new row
+     * @return the cursor position
      */
     public int cursorPos(int row, int col) {
         return row * (cols+1) + col;
diff --git a/terminal/src/main/java/org/jline/terminal/Terminal.java b/terminal/src/main/java/org/jline/terminal/Terminal.java
index 94cdbbe17..9f3fdda3f 100644
--- a/terminal/src/main/java/org/jline/terminal/Terminal.java
+++ b/terminal/src/main/java/org/jline/terminal/Terminal.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2002-2016, the original author or authors.
+ * Copyright (c) 2002-2018, the original author or authors.
  *
  * This software is distributable under the BSD license. See the terms of the
  * BSD license in the documentation provided with this software.
@@ -105,8 +105,8 @@ interface SignalHandler {
 
     /**
      * Stop reading the input stream and optionally wait for the underlying threads to finish.
-     * @param wait
-     * @throws InterruptedException
+     * @param wait <code>true</code> to wait until the terminal is actually paused
+     * @throws InterruptedException if the call has been interrupted
      */
     void pause(boolean wait) throws InterruptedException;
 
@@ -186,7 +186,7 @@ default int getHeight() {
      * As the response is read from the input stream, some
      * characters may be read before the cursor position is actually
      * read. Those characters can be given back using
-     * {@link org.jline.keymap.BindingReader#runMacro(String)}.
+     * <code>org.jline.keymap.BindingReader#runMacro(String)</code>
      *
      * @param discarded a consumer receiving discarded characters
      * @return <code>null</code> if cursor position reporting
diff --git a/terminal/src/main/java/org/jline/terminal/TerminalBuilder.java b/terminal/src/main/java/org/jline/terminal/TerminalBuilder.java
index bf2bd4d65..41c2d4f24 100644
--- a/terminal/src/main/java/org/jline/terminal/TerminalBuilder.java
+++ b/terminal/src/main/java/org/jline/terminal/TerminalBuilder.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2002-2016, the original author or authors.
+ * Copyright (c) 2002-2018, the original author or authors.
  *
  * This software is distributable under the BSD license. See the terms of the
  * BSD license in the documentation provided with this software.
@@ -66,8 +66,13 @@ public final class TerminalBuilder {
      * Terminals should be closed properly using the {@link Terminal#close()}
      * method in order to restore the original terminal state.
      *
+     * <p>
      * This call is equivalent to:
      * <code>builder().build()</code>
+     * </p>
+     *
+     * @return the default system terminal
+     * @throws IOException if an error occurs
      */
     public static Terminal terminal() throws IOException {
         return builder().build();
@@ -75,6 +80,8 @@ public static Terminal terminal() throws IOException {
 
     /**
      * Creates a new terminal builder instance.
+     *
+     * @return a builder
      */
     public static TerminalBuilder builder() {
         return new TerminalBuilder();
@@ -180,6 +187,8 @@ public TerminalBuilder encoding(Charset encoding) {
     }
 
     /**
+     * @param codepage the codepage
+     * @return The builder
      * @deprecated JLine now writes Unicode output independently from the selected
      *   code page. Using this option will only make it emulate the selected code
      *   page for {@link Terminal#input()} and {@link Terminal#output()}.
@@ -197,6 +206,8 @@ public TerminalBuilder codepage(int codepage) {
      * or when {@link #system(boolean)} has been explicitely called with
      * <code>false</code>.
      *
+     * @param attributes the attributes to use
+     * @return The builder
      * @see #size(Size)
      * @see #system(boolean)
      */
@@ -212,6 +223,8 @@ public TerminalBuilder attributes(Attributes attributes) {
      * or when {@link #system(boolean)} has been explicitely called with
      * <code>false</code>.
      *
+     * @param size the initial size
+     * @return The builder
      * @see #attributes(Attributes)
      * @see #system(boolean)
      */
@@ -236,7 +249,8 @@ public TerminalBuilder signalHandler(Terminal.SignalHandler signalHandler) {
      * one might want to make sure the input stream is not consumed
      * before needed, in which case the terminal needs to be created
      * in a paused state.
-     * @param paused
+     * @param paused the initial paused state
+     * @return The builder
      * @see Terminal#pause()
      */
     public TerminalBuilder paused(boolean paused) {
diff --git a/terminal/src/main/java/org/jline/terminal/impl/AbstractWindowsTerminal.java b/terminal/src/main/java/org/jline/terminal/impl/AbstractWindowsTerminal.java
index 6cad99af4..5a70170c5 100644
--- a/terminal/src/main/java/org/jline/terminal/impl/AbstractWindowsTerminal.java
+++ b/terminal/src/main/java/org/jline/terminal/impl/AbstractWindowsTerminal.java
@@ -521,6 +521,7 @@ public boolean trackMouse(MouseTracking tracking) {
      * Read a single input event from the input buffer and process it.
      *
      * @return true if new input was generated from the event
+     * @throws IOException if anything wrong happens
      */
     protected abstract boolean processConsoleInput() throws IOException;
 
diff --git a/terminal/src/main/java/org/jline/terminal/impl/LineDisciplineTerminal.java b/terminal/src/main/java/org/jline/terminal/impl/LineDisciplineTerminal.java
index 271d56c7a..1efef78f8 100644
--- a/terminal/src/main/java/org/jline/terminal/impl/LineDisciplineTerminal.java
+++ b/terminal/src/main/java/org/jline/terminal/impl/LineDisciplineTerminal.java
@@ -174,7 +174,7 @@ public void raise(Signal signal) {
      * using this method.
      *
      * @param c the input byte
-     * @throws IOException
+     * @throws IOException if anything wrong happens
      */
     public void processInputByte(int c) throws IOException {
         if (attributes.getLocalFlag(LocalFlag.ISIG)) {
@@ -214,7 +214,7 @@ public void processInputByte(int c) throws IOException {
      * All data going to the master should be provided by this method.
      *
      * @param c the output byte
-     * @throws IOException
+     * @throws IOException if anything wrong happens
      */
     protected void processOutputByte(int c) throws IOException {
         if (attributes.getOutputFlag(OutputFlag.OPOST)) {
diff --git a/terminal/src/main/java/org/jline/utils/AnsiWriter.java b/terminal/src/main/java/org/jline/utils/AnsiWriter.java
index f92c7c794..e5865d5c7 100644
--- a/terminal/src/main/java/org/jline/utils/AnsiWriter.java
+++ b/terminal/src/main/java/org/jline/utils/AnsiWriter.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2009-2017 the original author(s).
+ * Copyright (C) 2009-2018 the original author(s).
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -131,7 +131,7 @@ public synchronized void write(int data) throws IOException {
                 buffer[pos++] = (char) data;
                 if (!('0' <= data && data <= '9')) {
                     String strValue = new String(buffer, startOfValue, (pos - 1) - startOfValue);
-                    Integer value = new Integer(strValue);
+                    Integer value = Integer.valueOf(strValue);
                     options.add(value);
                     if (data == ';') {
                         state = LOOKING_FOR_NEXT_ARG;
@@ -173,7 +173,7 @@ public synchronized void write(int data) throws IOException {
                 buffer[pos++] = (char) data;
                 if (';' == data) {
                     String strValue = new String(buffer, startOfValue, (pos - 1) - startOfValue);
-                    Integer value = new Integer(strValue);
+                    Integer value = Integer.valueOf(strValue);
                     options.add(value);
                     startOfValue = pos;
                     state = LOOKING_FOR_OSC_PARAM;
@@ -234,7 +234,7 @@ public synchronized void write(int data) throws IOException {
     /**
      * Resets all state to continue with regular parsing
      * @param skipBuffer if current buffer should be skipped or written to out
-     * @throws IOException
+     * @throws IOException if an error occurs
      */
     private void reset(boolean skipBuffer) throws IOException {
         if (!skipBuffer) {
@@ -262,9 +262,10 @@ private int getNextOptionInt(Iterator<Object> optionsIterator) throws IOExceptio
     }
 
     /**
-     *
-     * @param options
-     * @param command
+     * Process escape command
+     * @param options the list of options
+     * @param command the command
+     * @throws IOException if an error occurs
      * @return true if the escape command was processed.
      */
     private boolean processEscapeCommand(ArrayList<Object> options, int command) throws IOException {
@@ -413,8 +414,8 @@ else if (arg2or5 == 5) {
     }
 
     /**
-     *
-     * @param options
+     * Process operating system command.
+     * @param options the options list
      * @return true if the operating system command was processed.
      */
     private boolean processOperatingSystemCommand(ArrayList<Object> options) throws IOException {
@@ -446,42 +447,46 @@ private boolean processOperatingSystemCommand(ArrayList<Object> options) throws
 
     /**
      * Process <code>CSI u</code> ANSI code, corresponding to <code>RCP – Restore Cursor Position</code>
-     * @throws IOException
+     * @throws IOException if an error occurs
      */
     protected void processRestoreCursorPosition() throws IOException {
     }
 
     /**
      * Process <code>CSI s</code> ANSI code, corresponding to <code>SCP – Save Cursor Position</code>
-     * @throws IOException
+     * @throws IOException if an error occurs
      */
     protected void processSaveCursorPosition() throws IOException {
     }
 
     /**
      * Process <code>CSI s</code> ANSI code, corresponding to <code>IL – Insert Line</code>
-     * @throws IOException
+     * @param optionInt the option
+     * @throws IOException if an error occurs
      */
     protected void processInsertLine(int optionInt) throws IOException {
     }
 
     /**
      * Process <code>CSI s</code> ANSI code, corresponding to <code>DL – Delete Line</code>
-     * @throws IOException
+     * @param optionInt the option
+     * @throws IOException if an error occurs
      */
     protected void processDeleteLine(int optionInt) throws IOException {
     }
 
     /**
      * Process <code>CSI n T</code> ANSI code, corresponding to <code>SD – Scroll Down</code>
-     * @throws IOException
+     * @param optionInt the option
+     * @throws IOException if an error occurs
      */
     protected void processScrollDown(int optionInt) throws IOException {
     }
 
     /**
      * Process <code>CSI n U</code> ANSI code, corresponding to <code>SU – Scroll Up</code>
-     * @throws IOException
+     * @param optionInt the option
+     * @throws IOException if an error occurs
      */
     protected void processScrollUp(int optionInt) throws IOException {
     }
@@ -492,7 +497,8 @@ protected void processScrollUp(int optionInt) throws IOException {
 
     /**
      * Process <code>CSI n J</code> ANSI code, corresponding to <code>ED – Erase in Display</code>
-     * @throws IOException
+     * @param eraseOption the erase option
+     * @throws IOException if an error occurs
      */
     protected void processEraseScreen(int eraseOption) throws IOException {
     }
@@ -503,7 +509,8 @@ protected void processEraseScreen(int eraseOption) throws IOException {
 
     /**
      * Process <code>CSI n K</code> ANSI code, corresponding to <code>ED – Erase in Line</code>
-     * @throws IOException
+     * @param eraseOption the erase option
+     * @throws IOException if an error occurs
      */
     protected void processEraseLine(int eraseOption) throws IOException {
     }
@@ -529,8 +536,8 @@ protected void processEraseLine(int eraseOption) throws IOException {
      * process <code>SGR</code> other than <code>0</code> (reset), <code>30-39</code> (foreground),
      * <code>40-49</code> (background), <code>90-97</code> (foreground high intensity) or
      * <code>100-107</code> (background high intensity)
-     * @param attribute
-     * @throws IOException
+     * @param attribute the attribute to set
+     * @throws IOException if an error occurs
      * @see #processAttributeRest()
      * @see #processSetForegroundColor(int)
      * @see #processSetForegroundColor(int, boolean)
@@ -554,7 +561,7 @@ protected void processSetAttribute(int attribute) throws IOException {
     /**
      * process <code>SGR 30-37</code> corresponding to <code>Set text color (foreground)</code>.
      * @param color the text color
-     * @throws IOException
+     * @throws IOException if an error occurs
      */
     protected void processSetForegroundColor(int color) throws IOException {
         processSetForegroundColor(color, false);
@@ -565,7 +572,7 @@ protected void processSetForegroundColor(int color) throws IOException {
      * <code>Set text color (foreground)</code> either in normal mode or high intensity.
      * @param color the text color
      * @param bright is high intensity?
-     * @throws IOException
+     * @throws IOException if an error occurs
      */
     protected void processSetForegroundColor(int color, boolean bright) throws IOException {
         processSetForegroundColorExt(bright ? color + 8 : color);
@@ -575,7 +582,7 @@ protected void processSetForegroundColor(int color, boolean bright) throws IOExc
      * process <code>SGR 38</code> corresponding to <code>extended set text color (foreground)</code>
      * with a palette of 255 colors.
      * @param paletteIndex the text color in the palette
-     * @throws IOException
+     * @throws IOException if an error occurs
      */
     protected void processSetForegroundColorExt(int paletteIndex) throws IOException {
     }
@@ -586,7 +593,7 @@ protected void processSetForegroundColorExt(int paletteIndex) throws IOException
      * @param r red
      * @param g green
      * @param b blue
-     * @throws IOException
+     * @throws IOException if an error occurs
      */
     protected void processSetForegroundColorExt(int r, int g, int b) throws IOException {
         processSetForegroundColorExt(Colors.roundRgbColor(r, g, b, 16));
@@ -595,7 +602,7 @@ protected void processSetForegroundColorExt(int r, int g, int b) throws IOExcept
     /**
      * process <code>SGR 40-47</code> corresponding to <code>Set background color</code>.
      * @param color the background color
-     * @throws IOException
+     * @throws IOException if an error occurs
      */
     protected void processSetBackgroundColor(int color) throws IOException {
         processSetBackgroundColor(color, false);
@@ -606,7 +613,7 @@ protected void processSetBackgroundColor(int color) throws IOException {
      * <code>Set background color</code> either in normal mode or high intensity.
      * @param color the background color
      * @param bright is high intensity?
-     * @throws IOException
+     * @throws IOException if an error occurs
      */
     protected void processSetBackgroundColor(int color, boolean bright) throws IOException {
         processSetBackgroundColorExt(bright ? color + 8 : color);
@@ -616,7 +623,7 @@ protected void processSetBackgroundColor(int color, boolean bright) throws IOExc
      * process <code>SGR 48</code> corresponding to <code>extended set background color</code>
      * with a palette of 255 colors.
      * @param paletteIndex the background color in the palette
-     * @throws IOException
+     * @throws IOException if an error occurs
      */
     protected void processSetBackgroundColorExt(int paletteIndex) throws IOException {
     }
@@ -627,7 +634,7 @@ protected void processSetBackgroundColorExt(int paletteIndex) throws IOException
      * @param r red
      * @param g green
      * @param b blue
-     * @throws IOException
+     * @throws IOException if an error occurs
      */
     protected void processSetBackgroundColorExt(int r, int g, int b) throws IOException {
         processSetBackgroundColorExt(Colors.roundRgbColor(r, g, b, 16));
@@ -635,21 +642,21 @@ protected void processSetBackgroundColorExt(int r, int g, int b) throws IOExcept
 
     /**
      * process <code>SGR 39</code> corresponding to <code>Default text color (foreground)</code>
-     * @throws IOException
+     * @throws IOException if an error occurs
      */
     protected void processDefaultTextColor() throws IOException {
     }
 
     /**
      * process <code>SGR 49</code> corresponding to <code>Default background color</code>
-     * @throws IOException
+     * @throws IOException if an error occurs
      */
     protected void processDefaultBackgroundColor() throws IOException {
     }
 
     /**
      * process <code>SGR 0</code> corresponding to <code>Reset / Normal</code>
-     * @throws IOException
+     * @throws IOException if an error occurs
      */
     protected void processAttributeRest() throws IOException {
     }
@@ -657,9 +664,9 @@ protected void processAttributeRest() throws IOException {
     /**
      * process <code>CSI n ; m H</code> corresponding to <code>CUP – Cursor Position</code> or
      * <code>CSI n ; m f</code> corresponding to <code>HVP – Horizontal and Vertical Position</code>
-     * @param row
-     * @param col
-     * @throws IOException
+     * @param row the row
+     * @param col the column
+     * @throws IOException if an error occurs
      */
     protected void processCursorTo(int row, int col) throws IOException {
     }
@@ -667,7 +674,7 @@ protected void processCursorTo(int row, int col) throws IOException {
     /**
      * process <code>CSI n G</code> corresponding to <code>CHA – Cursor Horizontal Absolute</code>
      * @param x the column
-     * @throws IOException
+     * @throws IOException if an error occurs
      */
     protected void processCursorToColumn(int x) throws IOException {
     }
@@ -675,7 +682,7 @@ protected void processCursorToColumn(int x) throws IOException {
     /**
      * process <code>CSI n F</code> corresponding to <code>CPL – Cursor Previous Line</code>
      * @param count line count
-     * @throws IOException
+     * @throws IOException if an error occurs
      */
     protected void processCursorUpLine(int count) throws IOException {
     }
@@ -683,7 +690,7 @@ protected void processCursorUpLine(int count) throws IOException {
     /**
      * process <code>CSI n E</code> corresponding to <code>CNL – Cursor Next Line</code>
      * @param count line count
-     * @throws IOException
+     * @throws IOException if an error occurs
      */
     protected void processCursorDownLine(int count) throws IOException {
         // Poor mans impl..
@@ -694,16 +701,16 @@ protected void processCursorDownLine(int count) throws IOException {
 
     /**
      * process <code>CSI n D</code> corresponding to <code>CUB – Cursor Back</code>
-     * @param count
-     * @throws IOException
+     * @param count the count
+     * @throws IOException if an error occurs
      */
     protected void processCursorLeft(int count) throws IOException {
     }
 
     /**
      * process <code>CSI n C</code> corresponding to <code>CUF – Cursor Forward</code>
-     * @param count
-     * @throws IOException
+     * @param count the count
+     * @throws IOException if an error occurs
      */
     protected void processCursorRight(int count) throws IOException {
         // Poor mans impl..
@@ -714,16 +721,16 @@ protected void processCursorRight(int count) throws IOException {
 
     /**
      * process <code>CSI n B</code> corresponding to <code>CUD – Cursor Down</code>
-     * @param count
-     * @throws IOException
+     * @param count the count
+     * @throws IOException if an error occurs
      */
     protected void processCursorDown(int count) throws IOException {
     }
 
     /**
      * process <code>CSI n A</code> corresponding to <code>CUU – Cursor Up</code>
-     * @param count
-     * @throws IOException
+     * @param count the count
+     * @throws IOException if an error occurs
      */
     protected void processCursorUp(int count) throws IOException {
     }
@@ -733,8 +740,7 @@ protected void processUnknownExtension(ArrayList<Object> options, int command) {
 
     /**
      * process <code>OSC 0;text BEL</code> corresponding to <code>Change Window and Icon label</code>
-     * @param label
-     * @throws IOException
+     * @param label the label
      */
     protected void processChangeIconNameAndWindowTitle(String label) {
         processChangeIconName(label);
@@ -743,24 +749,22 @@ protected void processChangeIconNameAndWindowTitle(String label) {
 
     /**
      * process <code>OSC 1;text BEL</code> corresponding to <code>Change Icon label</code>
-     * @param label
-     * @throws IOException
+     * @param name the icon name
      */
-    protected void processChangeIconName(String label) {
+    protected void processChangeIconName(String name) {
     }
 
     /**
      * process <code>OSC 2;text BEL</code> corresponding to <code>Change Window title</code>
-     * @param label
-     * @throws IOException
+     * @param title the title
      */
-    protected void processChangeWindowTitle(String label) {
+    protected void processChangeWindowTitle(String title) {
     }
 
     /**
      * Process unknown <code>OSC</code> command.
-     * @param command
-     * @param param
+     * @param command the command
+     * @param param the param
      */
     protected void processUnknownOperatingSystemCommand(int command, String param) {
     }
diff --git a/terminal/src/main/java/org/jline/utils/AttributedStringBuilder.java b/terminal/src/main/java/org/jline/utils/AttributedStringBuilder.java
index 1bd96a4c8..024943be9 100644
--- a/terminal/src/main/java/org/jline/utils/AttributedStringBuilder.java
+++ b/terminal/src/main/java/org/jline/utils/AttributedStringBuilder.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2002-2016, the original author or authors.
+ * Copyright (c) 2002-2018, the original author or authors.
  *
  * This software is distributable under the BSD license. See the terms of the
  * BSD license in the documentation provided with this software.
@@ -11,7 +11,6 @@
 import java.util.Arrays;
 import java.util.function.Consumer;
 import java.util.function.Function;
-import java.util.function.Supplier;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 
@@ -371,7 +370,7 @@ public void setLength(int l) {
      *
      * If tab size is set to 0, tabs are not expanded (the default).
      * @param tabsize Spaces per tab or 0 for no tab expansion. Must be non-negative
-     * @return
+     * @return this
      */
     public AttributedStringBuilder tabs(int tabsize) {
         if (length > 0) {
diff --git a/terminal/src/main/java/org/jline/utils/AttributedStyle.java b/terminal/src/main/java/org/jline/utils/AttributedStyle.java
index 37b538273..62a6fd583 100644
--- a/terminal/src/main/java/org/jline/utils/AttributedStyle.java
+++ b/terminal/src/main/java/org/jline/utils/AttributedStyle.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2002-2016, the original author or authors.
+ * Copyright (c) 2002-2018, the original author or authors.
  *
  * This software is distributable under the BSD license. See the terms of the
  * BSD license in the documentation provided with this software.
@@ -199,6 +199,8 @@ public AttributedStyle backgroundDefault() {
      * The hidden flag can be used to embed custom escape sequences.
      * The characters are considered being 0-column long and will be printed as-is.
      * The user is responsible for ensuring that those sequences do not move the cursor.
+     *
+     * @return the new style
      */
     public AttributedStyle hidden() {
         return new AttributedStyle(style | F_HIDDEN, mask | F_HIDDEN);
diff --git a/terminal/src/main/java/org/jline/utils/Curses.java b/terminal/src/main/java/org/jline/utils/Curses.java
index c2ea7839d..f668c3f72 100644
--- a/terminal/src/main/java/org/jline/utils/Curses.java
+++ b/terminal/src/main/java/org/jline/utils/Curses.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2002-2016, the original author or authors.
+ * Copyright (c) 2002-2018, the original author or authors.
  *
  * This software is distributable under the BSD license. See the terms of the
  * BSD license in the documentation provided with this software.
@@ -37,6 +37,7 @@ private Curses() {
      *
      * @param cap the capability to output
      * @param params optional parameters
+     * @return the result string
      */
     public static String tputs(String cap, Object... params) {
         if (cap != null) {
diff --git a/terminal/src/main/java/org/jline/utils/Display.java b/terminal/src/main/java/org/jline/utils/Display.java
index 9bde0ae4a..a03f22da0 100644
--- a/terminal/src/main/java/org/jline/utils/Display.java
+++ b/terminal/src/main/java/org/jline/utils/Display.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2002-2016, the original author or authors.
+ * Copyright (c) 2002-2018, the original author or authors.
  *
  * This software is distributable under the BSD license. See the terms of the
  * BSD license in the documentation provided with this software.
@@ -53,8 +53,10 @@ public Display(Terminal terminal, boolean fullscreen) {
         this.cursorDownIsNewLine = "\n".equals(Curses.tputs(terminal.getStringCapability(Capability.cursor_down)));
     }
 
-    /** If cursor is at right margin, don't wrap immediately.
-     * See {@link org.jline.reader.LineReader.Option#DELAY_LINE_WRAP}.
+    /**
+     * If cursor is at right margin, don't wrap immediately.
+     * See <code>org.jline.reader.LineReader.Option#DELAY_LINE_WRAP</code>.
+     * @return <code>true</code> if line wrap is delayed, <code>false</code> otherwise
      */
     public boolean delayLineWrap() {
         return delayLineWrap;
@@ -90,6 +92,7 @@ public void updateAnsi(List<String> newLines, int targetCursorPos) {
 
     /**
      * Update the display according to the new lines and flushes the output.
+     * @param newLines the lines to display
      * @param targetCursorPos desired cursor position - see Size.cursorPos.
      */
     public void update(List<AttributedString> newLines, int targetCursorPos) {
@@ -98,6 +101,7 @@ public void update(List<AttributedString> newLines, int targetCursorPos) {
 
     /**
      * Update the display according to the new lines.
+     * @param newLines the lines to display
      * @param targetCursorPos desired cursor position - see Size.cursorPos.
      * @param flush whether the output should be flushed or not
      */
@@ -395,7 +399,8 @@ private static int[] longestCommon(List<AttributedString> l1, List<AttributedStr
         return max != 0 ? new int[] { start1, start2, max } : null;
     }
 
-    /** Move cursor from cursorPos to argument, updating cursorPos
+    /*
+     * Move cursor from cursorPos to argument, updating cursorPos
      * We're at the right margin if {@code (cursorPos % columns1) == columns}.
      * This method knows how to move both *from* and *to* the right margin.
      */
@@ -419,7 +424,8 @@ protected void moveVisualCursorTo(int targetPos,
         }
     }
 
-    /** Move cursor from cursorPos to argument, updating cursorPos
+    /*
+     * Move cursor from cursorPos to argument, updating cursorPos
      * We're at the right margin if {@code (cursorPos % columns1) == columns}.
      * This method knows how to move *from* the right margin,
      * but does not know how to move *to* the right margin.
diff --git a/terminal/src/main/java/org/jline/utils/NonBlockingInputStream.java b/terminal/src/main/java/org/jline/utils/NonBlockingInputStream.java
index 59f768fb5..a5a0d96f0 100644
--- a/terminal/src/main/java/org/jline/utils/NonBlockingInputStream.java
+++ b/terminal/src/main/java/org/jline/utils/NonBlockingInputStream.java
@@ -1,3 +1,11 @@
+/*
+ * Copyright (c) 2002-2018, the original author or authors.
+ *
+ * This software is distributable under the BSD license. See the terms of the
+ * BSD license in the documentation provided with this software.
+ *
+ * http://www.opensource.org/licenses/bsd-license.php
+ */
 package org.jline.utils;
 
 import java.io.IOException;
@@ -32,9 +40,10 @@ public int read() throws IOException {
      * Peeks to see if there is a byte waiting in the input stream without
      * actually consuming the byte.
      *
-     * @param timeout The amount of time to wait, 0 == forever
-     * @return -1 on eof, -2 if the timeout expired with no available input
-     *   or the character that was read (without consuming it).
+     * @param      timeout The amount of time to wait, 0 == forever
+     * @return     -1 on eof, -2 if the timeout expired with no available input
+     *             or the character that was read (without consuming it).
+     * @exception  IOException  if an I/O error occurs.
      */
     public int peek(long timeout) throws IOException {
         return read(timeout, true);
@@ -44,9 +53,10 @@ public int peek(long timeout) throws IOException {
      * Attempts to read a character from the input stream for a specific
      * period of time.
      *
-     * @param timeout The amount of time to wait for the character
-     * @return The character read, -1 if EOF is reached, or -2 if the
-     * read timed out.
+     * @param      timeout      The amount of time to wait for the character
+     * @return     The character read, -1 if EOF is reached,
+     *             or -2 if the read timed out.
+     * @exception  IOException  if an I/O error occurs.
      */
     public int read(long timeout) throws IOException {
         return read(timeout, false);
diff --git a/terminal/src/main/java/org/jline/utils/NonBlockingInputStreamImpl.java b/terminal/src/main/java/org/jline/utils/NonBlockingInputStreamImpl.java
index acfa9dac3..c50ecbc60 100644
--- a/terminal/src/main/java/org/jline/utils/NonBlockingInputStreamImpl.java
+++ b/terminal/src/main/java/org/jline/utils/NonBlockingInputStreamImpl.java
@@ -43,6 +43,7 @@ public class NonBlockingInputStreamImpl
      * reader. Note that this call also spawn a separate thread to perform the
      * blocking I/O on behalf of the thread that is using this class. The
      * {@link #shutdown()} method must be called in order to shut this thread down.
+     * @param name The stream name
      * @param in The reader to wrap
      */
     public NonBlockingInputStreamImpl(String name, InputStream in) {
@@ -84,8 +85,10 @@ public void close() throws IOException {
      * Attempts to read a byte from the input stream for a specific
      * period of time.
      * @param timeout The amount of time to wait for the character
+     * @param isPeek <code>true</code>if the byte read must not be consumed
      * @return The byte read, -1 if EOF is reached, or -2 if the
      *   read timed out.
+     * @throws IOException if anything wrong happens
      */
     public synchronized int read(long timeout, boolean isPeek) throws IOException {
         /*
diff --git a/terminal/src/main/java/org/jline/utils/NonBlockingReader.java b/terminal/src/main/java/org/jline/utils/NonBlockingReader.java
index a592b61e2..52a9bdeaa 100644
--- a/terminal/src/main/java/org/jline/utils/NonBlockingReader.java
+++ b/terminal/src/main/java/org/jline/utils/NonBlockingReader.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2002-2016, the original author or authors.
+ * Copyright (c) 2002-2018, the original author or authors.
  *
  * This software is distributable under the BSD license. See the terms of the
  * BSD license in the documentation provided with this software.
@@ -38,6 +38,7 @@ public int read() throws IOException {
      * @param timeout The amount of time to wait, 0 == forever
      * @return -1 on eof, -2 if the timeout expired with no available input
      * or the character that was read (without consuming it).
+     * @throws IOException if anything wrong happens
      */
     public int peek(long timeout) throws IOException {
         return read(timeout, true);
@@ -50,6 +51,7 @@ public int peek(long timeout) throws IOException {
      * @param timeout The amount of time to wait for the character
      * @return The character read, -1 if EOF is reached, or -2 if the
      * read timed out.
+     * @throws IOException if anything wrong happens
      */
     public int read(long timeout) throws IOException {
         return read(timeout, false);
@@ -59,6 +61,10 @@ public int read(long timeout) throws IOException {
      * This version of read() is very specific to jline's purposes, it
      * will always always return a single byte at a time, rather than filling
      * the entire buffer.
+     * @param b the buffer
+     * @param off the offset in the buffer
+     * @param len the maximum number of chars to read
+     * @throws IOException if anything wrong happens
      */
     @Override
     public int read(char[] b, int off, int len) throws IOException {
@@ -87,8 +93,10 @@ public int available() {
      * Attempts to read a character from the input stream for a specific
      * period of time.
      * @param timeout The amount of time to wait for the character
+     * @param isPeek <code>true</code>if the character read must not be consumed
      * @return The character read, -1 if EOF is reached, or -2 if the
      *   read timed out.
+     * @throws IOException if anything wrong happens
      */
     protected abstract int read(long timeout, boolean isPeek) throws IOException;
 
diff --git a/terminal/src/main/java/org/jline/utils/NonBlockingReaderImpl.java b/terminal/src/main/java/org/jline/utils/NonBlockingReaderImpl.java
index 022be4cee..481cdee39 100644
--- a/terminal/src/main/java/org/jline/utils/NonBlockingReaderImpl.java
+++ b/terminal/src/main/java/org/jline/utils/NonBlockingReaderImpl.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2002-2016, the original author or authors.
+ * Copyright (c) 2002-2018, the original author or authors.
  *
  * This software is distributable under the BSD license. See the terms of the
  * BSD license in the documentation provided with this software.
@@ -26,7 +26,7 @@
  *          the thread that handles blocking I/O.
  * </ul>
  * @since 2.7
- * @author Scott C. Gray <scottgray1@gmail.com>
+ * @author Scott C. Gray &lt;scottgray1@gmail.com&gt;
  */
 public class NonBlockingReaderImpl
     extends NonBlockingReader
@@ -47,6 +47,7 @@ public class NonBlockingReaderImpl
      * reader. Note that this call also spawn a separate thread to perform the
      * blocking I/O on behalf of the thread that is using this class. The
      * {@link #shutdown()} method must be called in order to shut this thread down.
+     * @param name The reader name
      * @param in The reader to wrap
      */
     public NonBlockingReaderImpl(String name, Reader in) {
diff --git a/terminal/src/main/java/org/jline/utils/StyleResolver.java b/terminal/src/main/java/org/jline/utils/StyleResolver.java
index de0eed66a..08f1a611c 100644
--- a/terminal/src/main/java/org/jline/utils/StyleResolver.java
+++ b/terminal/src/main/java/org/jline/utils/StyleResolver.java
@@ -39,6 +39,7 @@ public StyleResolver(final Function<String, String> source) {
      * <p>
      * Full xterm256 color can be specified with: {@code ~<color>}.
      *
+     * @param name the name of the color
      * @return color code, or {@code null} if unable to determine.
      */
     private static Integer color(String name) {
@@ -108,6 +109,9 @@ private static Integer color(String name) {
      * Resolve the given style specification.
      * <p>
      * If for some reason the specification is invalid, then {@link AttributedStyle#DEFAULT} will be used.
+     *
+     * @param spec the specification
+     * @return the style
      */
     public AttributedStyle resolve(final String spec) {
         requireNonNull(spec);
@@ -129,6 +133,10 @@ public AttributedStyle resolve(final String spec) {
      * Resolve the given style specification.
      * <p>
      * If this resolves to {@link AttributedStyle#DEFAULT} then given default specification is used if non-null.
+     *
+     * @param spec the specification
+     * @param defaultSpec the default specifiaction
+     * @return the style
      */
     public AttributedStyle resolve(final String spec, final String defaultSpec) {
         requireNonNull(spec);
@@ -146,6 +154,10 @@ public AttributedStyle resolve(final String spec, final String defaultSpec) {
 
     /**
      * Apply style specification.
+     *
+     * @param style the style to apply to
+     * @param spec the specification
+     * @return the new style
      */
     private AttributedStyle apply(AttributedStyle style, final String spec) {
         if (log.isLoggable(Level.FINEST)) {
@@ -185,6 +197,10 @@ private AttributedStyle applyAnsi(final AttributedStyle style, final String spec
 
     /**
      * Apply source-referenced named style.
+     *
+     * @param style the style to apply to
+     * @param spec the specification
+     * @return the new style
      */
     private AttributedStyle applyReference(final AttributedStyle style, final String spec) {
         if (log.isLoggable(Level.FINEST)) {
@@ -207,6 +223,10 @@ private AttributedStyle applyReference(final AttributedStyle style, final String
 
     /**
      * Apply default named styles.
+     *
+     * @param style the style to apply to
+     * @param name the named style
+     * @return the new style
      */
     private AttributedStyle applyNamed(final AttributedStyle style, final String name) {
         if (log.isLoggable(Level.FINEST)) {
@@ -262,7 +282,9 @@ private AttributedStyle applyNamed(final AttributedStyle style, final String nam
     /**
      * Apply color styles specification.
      *
-     * @param spec Color specification: {@code <color-mode>:<color-name>}
+     * @param style The style to apply to
+     * @param spec  Color specification: {@code <color-mode>:<color-name>}
+     * @return      The new style
      */
     private AttributedStyle applyColor(final AttributedStyle style, final String spec) {
         if (log.isLoggable(Level.FINEST)) {