doc: document all internal/ exported variables/functions

Signed-off-by: Maxime Soulé <btik-git@scoubidou.com>

Author: maxatome

internal/color/color.go

@@ -16,24 +16,48 @@ import (
 )
 
 const (
-	EnvColor         = "TESTDEEP_COLOR"
+	// EnvColor is the name of the environment variable allowing to
+	// enable/disable coloring feature.
+	EnvColor = "TESTDEEP_COLOR"
+	// EnvColorTestName is the name of the environment variable
+	// containing the color of test names in error reports.
 	EnvColorTestName = "TESTDEEP_COLOR_TEST_NAME"
-	EnvColorTitle    = "TESTDEEP_COLOR_TITLE"
-	EnvColorOK       = "TESTDEEP_COLOR_OK"
-	EnvColorBad      = "TESTDEEP_COLOR_BAD"
+	// EnvColorTitle is the name of the environment variable
+	// containing the color of failure reason in error reports.
+	EnvColorTitle = "TESTDEEP_COLOR_TITLE"
+	// EnvColorOK is the name of the environment variable
+	// containing the color of "expected" in error reports.
+	EnvColorOK = "TESTDEEP_COLOR_OK"
+	// EnvColorBad is the name of the environment variable
+	// containing the color of "got" in error reports.
+	EnvColorBad = "TESTDEEP_COLOR_BAD"
 )
 
 var (
-	TestNameOn  string
+	// TestNameOn contains the ANSI color escape sequence to turn test
+	// name color on.
+	TestNameOn string
+	// TestNameOff contains the ANSI color escape sequence to turn test
+	// name color off.
 	TestNameOff string
-	TitleOn     string
-	TitleOff    string
-	OKOn        string
-	OKOnBold    string
-	OKOff       string
-	BadOn       string
-	BadOnBold   string
-	BadOff      string
+	// TitleOn contains the ANSI color escape sequence to turn title color on.
+	TitleOn string
+	// TitleOff contains the ANSI color escape sequence to turn title color off.
+	TitleOff string
+	// OKOn contains the ANSI color escape sequence to turn "expected" color on.
+	OKOn string
+	// OKOnBold contains the ANSI color escape sequence to turn
+	// "expected" color and bold on.
+	OKOnBold string
+	// OKOff contains the ANSI color escape sequence to turn "expected" color off.
+	OKOff string
+	// BadOn contains the ANSI color escape sequence to turn "got" color on.
+	BadOn string
+	// BadOnBold contains the ANSI color escape sequence to turn "got"
+	// color and bold on.
+	BadOnBold string
+	// BadOff contains the ANSI color escape sequence to turn "got" color off.
+	BadOff string
 )
 
 var initOnce sync.Once

internal/flat/slice.go

@@ -10,8 +10,9 @@ import (
 	"reflect"
 )
 
-var SliceType = reflect.TypeOf(Slice{})
+var sliceType = reflect.TypeOf(Slice{})
 
+// Slice allows to flatten any slice.
 type Slice struct {
 	Slice interface{}
 }
@@ -20,7 +21,7 @@ type Slice struct {
 // f.Slice, so this Slice is already flattened.
 func (f Slice) isFlat() bool {
 	t := reflect.TypeOf(f.Slice).Elem()
-	return t != SliceType && t.Kind() != reflect.Interface
+	return t != sliceType && t.Kind() != reflect.Interface
 }
 
 func (f Slice) len() int {
@@ -87,6 +88,9 @@ func (f Slice) appendTo(si []interface{}) []interface{} {
 	return si
 }
 
+// Len returns the number of items contained in items. Nested Slice
+// items are counted as if they are flattened. It returns true if at
+// least one Slice item is found, false otherwise.
 func Len(items []interface{}) (int, bool) {
 	l := len(items)
 	flattened := true
@@ -100,6 +104,8 @@ func Len(items []interface{}) (int, bool) {
 	return l, flattened
 }
 
+// Values returns the items values as a slice of reflect.Value. Nested
+// Slice items are flattened.
 func Values(items []interface{}) []reflect.Value {
 	l, flattened := Len(items)
 	if flattened {
@@ -121,6 +127,8 @@ func Values(items []interface{}) []reflect.Value {
 	return sv
 }
 
+// Values returns the items values as a slice of interface{}. Nested
+// Slice items are flattened.
 func Interfaces(items ...interface{}) []interface{} {
 	l, flattened := Len(items)
 	if flattened {

td/t_struct.go

@@ -610,6 +610,8 @@ func (t *T) RunAssertRequire(name string, f func(assert *T, require *T)) bool {
 	return ret[0].Bool()
 }
 
+// RunT runs "f" as a subtest of t called "name".
+//
 // Deprecated: RunT has been superseded by Run() method. It is kept
 // for compatibility.
 func (t *T) RunT(name string, f func(t *T)) bool {