Added godoc for all publics

teris-io · Nov 8, 2017 · 8b27d93 · 8b27d93
1 parent 57b8b70
commit 8b27d93
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 0 deletions.
diff --git a/apex/factory.go b/apex/factory.go
@@ -8,10 +8,14 @@ import (
 	"github.com/teris-io/log"
 )
 
+// NewFactory creates a new log Factory instance for the implementation based
+// on apex/log.
 func NewFactory(root *alog.Logger) log.Factory {
 	return &factory{root: root, min: log.UnsetLevel}
 }
 
+// Use activates the logger implementation (based on apex/log) to be
+// used for static logging via the log package static functions.
 func Use(root *alog.Logger) log.Factory {
 	factory := NewFactory(root)
 	log.SetFactory(factory)

diff --git a/std/factory.go b/std/factory.go
@@ -10,10 +10,14 @@ import (
 	"github.com/teris-io/log"
 )
 
+// NewFactory creates a new log Factory instance for the implementation based
+// on the Go standard log.
 func NewFactory(std *stdlog.Logger, min log.LoggerLevel, fmt FmtFun) log.Factory {
 	return &factory{std: std, min: min, fmt: fmt}
 }
 
+// Use activates the logger implementation (based on the Go standard log) to be
+// used for static logging via the log package static functions.
 func Use(out io.Writer, min log.LoggerLevel, fmt FmtFun) {
 	std := stdlog.New(out, "", 0)
 	log.SetFactory(NewFactory(std, min, fmt))

diff --git a/std/formatter.go b/std/formatter.go
@@ -11,8 +11,10 @@ import (
 	"github.com/teris-io/log"
 )
 
+// FmtFun defines the log formatter type for the logger implementation based on the Go standard log.
 type FmtFun func(start time.Time, level log.LoggerLevel, msg string, fields []Field) string
 
+// DefaultFmtFun defines the default formatter.
 var DefaultFmtFun = func(start time.Time, lvl log.LoggerLevel, msg string, fields []Field) string {
 	timestr := color.CyanString(start.Format("02 15:04:05.000000"))
 	lvlstr := ""

diff --git a/std/logger.go b/std/logger.go
@@ -13,6 +13,7 @@ import (
 	"github.com/teris-io/log"
 )
 
+// Field defines a name-value placeholder for field information passed to the formatter.
 type Field struct {
 	Name  string
 	Value interface{}