update godoc for some functions

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

Author: thaJeztah

aec.go

@@ -42,83 +42,83 @@ var (
 	Report ANSI = newAnsi(esc + "6n")
 )
 
-// Up moves up the cursor.
+// Up moves the cursor up by n positions (CUU).
 func Up(n uint) ANSI {
 	if n == 0 {
 		return empty
 	}
 	return newAnsi(fmt.Sprintf(esc+"%dA", n))
 }
 
-// Down moves down the cursor.
+// Down moves the cursor down by n positions (CUD).
 func Down(n uint) ANSI {
 	if n == 0 {
 		return empty
 	}
 	return newAnsi(fmt.Sprintf(esc+"%dB", n))
 }
 
-// Right moves right the cursor.
+// Right moves the cursor right by n positions (CUF).
 func Right(n uint) ANSI {
 	if n == 0 {
 		return empty
 	}
 	return newAnsi(fmt.Sprintf(esc+"%dC", n))
 }
 
-// Left moves left the cursor.
+// Left moves the cursor left by n positions (CUB).
 func Left(n uint) ANSI {
 	if n == 0 {
 		return empty
 	}
 	return newAnsi(fmt.Sprintf(esc+"%dD", n))
 }
 
-// NextLine moves down the cursor to head of a line.
+// NextLine moves the cursor down n lines and to the beginning of the line (CNL).
 func NextLine(n uint) ANSI {
 	if n == 0 {
 		return empty
 	}
 	return newAnsi(fmt.Sprintf(esc+"%dE", n))
 }
 
-// PreviousLine moves up the cursor to head of a line.
+// PreviousLine moves the cursor up n lines and to the beginning of the line (CPL).
 func PreviousLine(n uint) ANSI {
 	if n == 0 {
 		return empty
 	}
 	return newAnsi(fmt.Sprintf(esc+"%dF", n))
 }
 
-// Column set the cursor position to a given column.
+// Column sets the cursor position to a given column (CHA).
 func Column(col uint) ANSI {
 	return newAnsi(fmt.Sprintf(esc+"%dG", col))
 }
 
-// Position set the cursor position to a given absolute position.
+// Position sets the cursor position to a given absolute position (CUP).
 func Position(row, col uint) ANSI {
 	return newAnsi(fmt.Sprintf(esc+"%d;%dH", row, col))
 }
 
-// EraseDisplay erases display by given EraseMode.
+// EraseDisplay erases the display using the given EraseMode (ED).
 func EraseDisplay(m EraseMode) ANSI {
 	return newAnsi(fmt.Sprintf(esc+"%dJ", m))
 }
 
-// EraseLine erases lines by given EraseMode.
+// EraseLine erases the line using the given EraseMode (EL).
 func EraseLine(m EraseMode) ANSI {
 	return newAnsi(fmt.Sprintf(esc+"%dK", m))
 }
 
-// ScrollUp scrolls up the page.
+// ScrollUp scrolls the display up by n lines (SU).
 func ScrollUp(n int) ANSI {
 	if n == 0 {
 		return empty
 	}
 	return newAnsi(fmt.Sprintf(esc+"%dS", n))
 }
 
-// ScrollDown scrolls down the page.
+// ScrollDown scrolls the display down by n lines (SD).
 func ScrollDown(n int) ANSI {
 	if n == 0 {
 		return empty

ansi.go

@@ -8,7 +8,7 @@ import (
 const esc = "\x1b["
 
 // Reset resets SGR effect.
-const Reset string = "\x1b[0m"
+const Reset = "\x1b[0m"
 
 var empty = newAnsi("")
 
@@ -23,33 +23,38 @@ type ANSI interface {
 	Apply(string) string
 }
 
+// ansiImpl represents an ANSI escape code.
 type ansiImpl string
 
 func newAnsi(s string) *ansiImpl {
 	r := ansiImpl(s)
 	return &r
 }
 
+// With returns a new ANSICode sequence composed of this and the provided ANSI codes.
 func (a *ansiImpl) With(ansi ...ANSI) ANSI {
 	return concat(append([]ANSI{a}, ansi...))
 }
 
+// Apply wraps the given string with the ANSI sequence and a reset code.
 func (a *ansiImpl) Apply(s string) string {
 	return a.String() + s + Reset
 }
 
+// String returns the ANSICode escape code as a string.
 func (a *ansiImpl) String() string {
 	return string(*a)
 }
 
-// Apply wraps given string in ANSIs.
+// Apply wraps the given string with all provided ANSI sequences.
 func Apply(s string, ansi ...ANSI) string {
 	if len(ansi) == 0 {
 		return s
 	}
 	return concat(ansi).Apply(s)
 }
 
+// concat combines multiple ANSI codes into a single ANSI sequence.
 func concat(ansi []ANSI) ANSI {
 	strs := make([]string, 0, len(ansi))
 	for _, p := range ansi {

sgr.go

@@ -49,7 +49,7 @@ func FullColorF(r, g, b uint8) ANSI {
 	return newAnsi(fmt.Sprintf(esc+"38;2;%d;%d;%dm", r, g, b))
 }
 
-// FullColorB set the foreground color of text.
+// FullColorB set the background color of text.
 func FullColorB(r, g, b uint8) ANSI {
 	return newAnsi(fmt.Sprintf(esc+"48;2;%d;%d;%dm", r, g, b))
 }