Fix javadoc a bit

jline · Jan 8, 2018 · b7af708 · b7af708
1 parent 857076e
commit b7af708
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 5 deletions.
diff --git a/reader/src/main/java/org/jline/reader/Completer.java b/reader/src/main/java/org/jline/reader/Completer.java
@@ -21,7 +21,7 @@
 public interface Completer
 {
     /**
-     * Populates <i>candidates</i> with a list of possible completions for the <i>buffer</i>.
+     * Populates <i>candidates</i> with a list of possible completions for the <i>command line</i>.
      *
      * The list of candidates will be sorted and filtered by the LineReader, so that
      * the list of candidates displayed to the user will usually be smaller than

diff --git a/reader/src/main/java/org/jline/reader/LineReader.java b/reader/src/main/java/org/jline/reader/LineReader.java
@@ -364,6 +364,10 @@ 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
+         *  instead of completing.  This is mainly useful when {@link #BRACKETED_PASTE} is
+         *  disabled, so that copy/paste of indented text does not trigger completion.
+         */
         INSERT_TAB(true),
         MOUSE,
         DISABLE_HIGHLIGHTER,

diff --git a/reader/src/main/java/org/jline/reader/impl/completer/AggregateCompleter.java b/reader/src/main/java/org/jline/reader/impl/completer/AggregateCompleter.java
@@ -62,15 +62,15 @@ public Collection<Completer> getCompleters() {
     /**
      * Perform a completion operation across all aggregated completers.
      *
+     * The effect is similar to the following code:
+     * <blockquote><pre>{@code completers.forEach(c -> c.complete(reader, line, candidates));}</pre></blockquote>
+     *
      * @see Completer#complete(LineReader, ParsedLine, List)
      */
     public void complete(LineReader reader, final ParsedLine line, final List<Candidate> candidates) {
         Objects.requireNonNull(line);
         Objects.requireNonNull(candidates);
-
-        for (Completer completer : completers) {
-            completer.complete(reader, line, candidates);
-        }
+        completers.forEach(c -> c.complete(reader, line, candidates));
     }
 
     /**

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
@@ -43,7 +43,10 @@
  * @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
 public class FileNameCompleter implements Completer
 {