Merge pull request #94 from maxatome/fix-comments

Fix comments

Author: maxatome

helpers/tdhttp/test_api.go

@@ -24,6 +24,8 @@ import (
 	"github.com/maxatome/go-testdeep/td"
 )
 
+// TestAPI allows to test one HTTP API. See NewTestAPI function to
+// create a new instance and get some examples of use.
 type TestAPI struct {
 	t       *td.T
 	handler http.Handler
@@ -644,7 +646,7 @@ func (t *TestAPI) CmpXMLBody(expectedBody interface{}) *TestAPI {
 	return t.CmpMarshaledBody(xml.Unmarshal, expectedBody)
 }
 
-// CmpNoBody tests that the last request response body is empty.
+// NoBody tests that the last request response body is empty.
 //
 // It fails if no request has been sent yet.
 func (t *TestAPI) NoBody() *TestAPI {

internal/anchors/anchor.go

@@ -18,19 +18,23 @@ type anchor struct {
 	Operator reflect.Value // Operator is a td.TestDeep behind
 }
 
+// Info gathers all anchors information.
 type Info struct {
 	sync.Mutex
 	index   int
 	persist bool
 	anchors map[interface{}]anchor
 }
 
+// NewInfo returns a new instance of *Info.
 func NewInfo() *Info {
 	return &Info{
 		anchors: map[interface{}]anchor{},
 	}
 }
 
+// AddAnchor anchors a new operator op, with type typ then returns the
+// anchor value.
 func (i *Info) AddAnchor(typ reflect.Type, op reflect.Value) reflect.Value {
 	i.Lock()
 	defer i.Unlock()
@@ -49,18 +53,22 @@ func (i *Info) AddAnchor(typ reflect.Type, op reflect.Value) reflect.Value {
 	return anc
 }
 
+// DoAnchorsPersist returns true if anchors are persistent across tests.
 func (i *Info) DoAnchorsPersist() bool {
 	i.Lock()
 	defer i.Unlock()
 	return i.persist
 }
 
+// SetAnchorsPersist enables or disables anchors persistence.
 func (i *Info) SetAnchorsPersist(persist bool) {
 	i.Lock()
 	defer i.Unlock()
 	i.persist = persist
 }
 
+// ResetAnchors removes all anchors if persistence is disabled or
+// force is true.
 func (i *Info) ResetAnchors(force bool) {
 	i.Lock()
 	defer i.Unlock()

internal/anchors/types.go

@@ -21,6 +21,8 @@ type anchorableType struct {
 	builder reflect.Value
 }
 
+// AnchorableTypes contains all non-native types that can be
+// anchorable. See AddAnchorableStructType to add a new type to it.
 var AnchorableTypes []anchorableType
 
 func init() {

internal/ctxerr/context.go

@@ -107,7 +107,7 @@ func (c Context) MergeErrors() *Error {
 	return (*c.Errors)[0]
 }
 
-// CannotCompare returns a generic error used when the access of
+// CannotCompareError returns a generic error used when the access of
 // unexported fields cannot be overridden.
 func (c Context) CannotCompareError() *Error {
 	if c.BooleanError {

internal/test/types.go

@@ -19,6 +19,7 @@ type TestingT struct {
 	HasFailed   bool
 }
 
+// NewTestingT returns a new instance of *TestingT.
 func NewTestingT() *TestingT {
 	return &TestingT{}
 }
@@ -49,6 +50,7 @@ type TestingFT struct {
 	name string
 }
 
+// NewTestingFT returns a new instance of *TestingFT.
 func NewTestingFT(name string) *TestingFT {
 	return &TestingFT{name: name}
 }

internal/util/tag.go

@@ -12,10 +12,13 @@ import (
 )
 
 var (
-	ErrTagEmpty   = errors.New("A tag cannot be empty")
+	// ErrTagEmpty is the error returned by CheckTag for an empty tag.
+	ErrTagEmpty = errors.New("A tag cannot be empty")
+	// ErrTagInvalid is the error returned by CheckTag for an invalid tag.
 	ErrTagInvalid = errors.New("Invalid tag, should match (Letter|_)(Letter|_|Number)*")
 )
 
+// CheckTag checks that tag is a valid tag (see operator Tag) or not.
 func CheckTag(tag string) error {
 	if tag == "" {
 		return ErrTagEmpty

td/config.go

@@ -60,6 +60,8 @@ type ContextConfig struct {
 	BeLax bool
 }
 
+// Equal returns true if both ContextConfig are equal. Only public
+// fields are taken into account to check equality.
 func (c ContextConfig) Equal(o ContextConfig) bool {
 	return c.RootName == o.RootName &&
 		c.MaxErrors == o.MaxErrors &&