Add API docs

Author: repejota

fmt_logger.go

@@ -22,12 +22,13 @@ import (
 	"io"
 )
 
-// FmtLogger ...
+// FmtLogger represents a log.Logger that encodes keyvals to a io.Writer in
+// logfmt format.
 type FmtLogger struct {
 	output io.Writer
 }
 
-// NewFmtLogger ...
+// NewFmtLogger creates a new log.Logger.
 func NewFmtLogger(w io.Writer) Logger {
 	logger := &FmtLogger{
 		output: w,
@@ -36,7 +37,7 @@ func NewFmtLogger(w io.Writer) Logger {
 	return logger
 }
 
-// Log ...
+// Log encodes encodes keyvals to a io.Writer in logfmt format.
 func (l FmtLogger) Log(keyvals ...interface{}) error {
 	for _, keyval := range keyvals {
 		_, err := fmt.Fprintf(l.output, "%v ", keyval)

log.go

@@ -17,11 +17,12 @@
 
 package log
 
-// Logger is the fundamental interface for all log operations. Log creates a
-// log event from keyvals, a variadic sequence of alternating keys and values.
-// Implementations must be safe for concurrent use by multiple goroutines. In
-// particular, any implementation of Logger that appends to keyvals or
-// modifies or retains any of its elements must make a copy first.
+/*
+Logger is the fundamental interface for all log operations.
+
+Log creates a log event from keyvals, a variadic sequence of alternating
+keys and values.
+*/
 type Logger interface {
 	Log(keyvals ...interface{}) error
 }

nop_logger.go

@@ -17,17 +17,17 @@
 
 package log
 
-// NopLogger is a log.Logger that does nothing.
+// NopLogger represents a log.Logger that does nothing.
 type NopLogger struct{}
 
-// NewNopLogger ...
+// NewNopLogger creates a new log.Logger.
 func NewNopLogger() Logger {
 	logger := &NopLogger{}
 
 	return logger
 }
 
-// Log ...
+// Log ignores all keyvals received as arguments and does nothing.
 func (l NopLogger) Log(keyvals ...interface{}) error {
 	// Do nothing.