improved javadoc

fusesource · Apr 28, 2018 · 49e8293 · 49e8293
1 parent 3302b8f
commit 49e8293
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 2 deletions.
diff --git a/jansi/src/main/java/org/fusesource/jansi/Ansi.java b/jansi/src/main/java/org/fusesource/jansi/Ansi.java
@@ -19,7 +19,8 @@
 import java.util.concurrent.Callable;
 
 /**
- * Provides a fluent API for generating ANSI escape sequences.
+ * Provides a fluent API for generating
+ * <a href="https://en.wikipedia.org/wiki/ANSI_escape_code#CSI_sequences">ANSI escape sequences</a>.
  *
  * @author <a href="http://hiramchirino.com">Hiram Chirino</a>
  * @since 1.0
@@ -29,6 +30,9 @@ public class Ansi {
     private static final char FIRST_ESC_CHAR = 27;
     private static final char SECOND_ESC_CHAR = '[';
 
+    /**
+     * <a href="https://en.wikipedia.org/wiki/ANSI_escape_code#Colors">ANSI 8 colors</a> for fluent API
+     */
     public enum Color {
         BLACK(0, "BLACK"),
         RED(1, "RED"),
@@ -74,6 +78,11 @@ public int bgBright() {
         }
     }
 
+    /**
+     * Display attributes, also know as
+     * <a href="https://en.wikipedia.org/wiki/ANSI_escape_code#SGR_(Select_Graphic_Rendition)_parameters">SGR
+     * (Select Graphic Rendition) parameters</a>.
+     */
     public enum Attribute {
         RESET(0, "RESET"),
         INTENSITY_BOLD(1, "INTENSITY_BOLD"),
@@ -113,6 +122,12 @@ public int value() {
 
     }
 
+    /**
+     * ED (Erase in Display) / EL (Erase in Line) parameter (see
+     * <a href="https://en.wikipedia.org/wiki/ANSI_escape_code#CSI_sequences">CSI sequence J and K</a>)
+     * @see Ansi#eraseScreen(Erase)
+     * @see Ansi#eraseLine(Erase)
+     */
     public enum Erase {
         FORWARD(0, "FORWARD"),
         BACKWARD(1, "BACKWARD"),

diff --git a/jansi/src/main/java/org/fusesource/jansi/AnsiConsole.java b/jansi/src/main/java/org/fusesource/jansi/AnsiConsole.java
@@ -28,7 +28,8 @@
 /**
  * Provides consistent access to an ANSI aware console PrintStream or an ANSI codes stripping PrintStream
  * if not on a terminal (see 
- * <a href="http://fusesource.github.io/jansi/documentation/native-api/index.html?org/fusesource/jansi/internal/CLibrary.html">Jansi native isatty(int)</a>).
+ * <a href="http://fusesource.github.io/jansi/documentation/native-api/index.html?org/fusesource/jansi/internal/CLibrary.html">Jansi native
+ * CLibrary isatty(int)</a>).
  *
  * @author <a href="http://hiramchirino.com">Hiram Chirino</a>
  * @since 1.0

diff --git a/jansi/src/main/java/org/fusesource/jansi/FilterPrintStream.java b/jansi/src/main/java/org/fusesource/jansi/FilterPrintStream.java
@@ -24,6 +24,7 @@
  * 
  * @author Hervé Boutemy
  * @since 1.17
+ * @see #filter(int)
  */
 public class FilterPrintStream extends PrintStream
 {