diff --git a/jansi/src/main/java/org/fusesource/jansi/Ansi.java b/jansi/src/main/java/org/fusesource/jansi/Ansi.java index 9f595e7a..01f0ef46 100644 --- 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 + * ANSI escape sequences. * * @author Hiram Chirino * @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 = '['; + /** + * ANSI 8 colors for fluent API + */ public enum Color { BLACK(0, "BLACK"), RED(1, "RED"), @@ -74,6 +78,11 @@ public int bgBright() { } } + /** + * Display attributes, also know as + * SGR + * (Select Graphic Rendition) parameters. + */ 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 + * CSI sequence J and K) + * @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 index 62297b44..cdf12bbf 100644 --- 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 - * Jansi native isatty(int)). + * Jansi native + * CLibrary isatty(int)). * * @author Hiram Chirino * @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 index dfc164e2..f3971315 100644 --- 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 {