Skip to content

Commit 49e8293

Browse files
committed
improved javadoc
1 parent 3302b8f commit 49e8293

File tree

3 files changed

+19
-2
lines changed

3 files changed

+19
-2
lines changed

jansi/src/main/java/org/fusesource/jansi/Ansi.java

+16-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,8 @@
1919
import java.util.concurrent.Callable;
2020

2121
/**
22-
* Provides a fluent API for generating ANSI escape sequences.
22+
* Provides a fluent API for generating
23+
* <a href="https://en.wikipedia.org/wiki/ANSI_escape_code#CSI_sequences">ANSI escape sequences</a>.
2324
*
2425
* @author <a href="http://hiramchirino.com">Hiram Chirino</a>
2526
* @since 1.0
@@ -29,6 +30,9 @@ public class Ansi {
2930
private static final char FIRST_ESC_CHAR = 27;
3031
private static final char SECOND_ESC_CHAR = '[';
3132

33+
/**
34+
* <a href="https://en.wikipedia.org/wiki/ANSI_escape_code#Colors">ANSI 8 colors</a> for fluent API
35+
*/
3236
public enum Color {
3337
BLACK(0, "BLACK"),
3438
RED(1, "RED"),
@@ -74,6 +78,11 @@ public int bgBright() {
7478
}
7579
}
7680

81+
/**
82+
* Display attributes, also know as
83+
* <a href="https://en.wikipedia.org/wiki/ANSI_escape_code#SGR_(Select_Graphic_Rendition)_parameters">SGR
84+
* (Select Graphic Rendition) parameters</a>.
85+
*/
7786
public enum Attribute {
7887
RESET(0, "RESET"),
7988
INTENSITY_BOLD(1, "INTENSITY_BOLD"),
@@ -113,6 +122,12 @@ public int value() {
113122

114123
}
115124

125+
/**
126+
* ED (Erase in Display) / EL (Erase in Line) parameter (see
127+
* <a href="https://en.wikipedia.org/wiki/ANSI_escape_code#CSI_sequences">CSI sequence J and K</a>)
128+
* @see Ansi#eraseScreen(Erase)
129+
* @see Ansi#eraseLine(Erase)
130+
*/
116131
public enum Erase {
117132
FORWARD(0, "FORWARD"),
118133
BACKWARD(1, "BACKWARD"),

jansi/src/main/java/org/fusesource/jansi/AnsiConsole.java

+2-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,8 @@
2828
/**
2929
* Provides consistent access to an ANSI aware console PrintStream or an ANSI codes stripping PrintStream
3030
* if not on a terminal (see
31-
* <a href="http://fusesource.github.io/jansi/documentation/native-api/index.html?org/fusesource/jansi/internal/CLibrary.html">Jansi native isatty(int)</a>).
31+
* <a href="http://fusesource.github.io/jansi/documentation/native-api/index.html?org/fusesource/jansi/internal/CLibrary.html">Jansi native
32+
* CLibrary isatty(int)</a>).
3233
*
3334
* @author <a href="http://hiramchirino.com">Hiram Chirino</a>
3435
* @since 1.0

jansi/src/main/java/org/fusesource/jansi/FilterPrintStream.java

+1
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@
2424
*
2525
* @author Hervé Boutemy
2626
* @since 1.17
27+
* @see #filter(int)
2728
*/
2829
public class FilterPrintStream extends PrintStream
2930
{

0 commit comments

Comments
 (0)