fix(pkg/logfile): description of functions

pkg/logfile/interfaces.go

@@ -4,6 +4,7 @@ import (
 	"github.com/go-flucky/flucky/pkg/types"
 )
 
+// Logfile is an interface for various logfiles
 type Logfile interface {
 	Read() ([]*types.MeasuredValue, error)
 	Write(measuredValues []*types.MeasuredValue) error

pkg/logfile/json.go

@@ -26,7 +26,7 @@ func (jl *jsonLogfile) Read() ([]*types.MeasuredValue, error) {
 
 	measuredValues := make([]*types.MeasuredValue, 0)
 
-	if err := json.NewDecoder(f).Decode(measuredValues); err != nil {
+	if err := json.NewDecoder(f).Decode(&measuredValues); err != nil {
 		return nil, fmt.Errorf("%v %v: %v", errorLogfileDecode, jl.logfile, err)
 	}
 

pkg/logfile/logfile.go

@@ -12,6 +12,7 @@ import (
 // var validUUID = regexp.MustCompile("^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[8|9|aA|bB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$")
 var timeFormat = "2006-01-02T15:04:05.999999Z07:00"
 
+// Append adds an array of several measured values to a logfile
 func Append(logfile Logfile, compression bool, round float64, measuredValues []*types.MeasuredValue) error {
 
 	if round != 0 {

pkg/logfile/types.go

@@ -6,11 +6,13 @@ import (
 	"github.com/go-flucky/flucky/pkg/types"
 )
 
+// MeasuredValues is an XML Wrapper for an array of measured values
 type MeasuredValues struct {
 	XMLName        xml.Name         `xml:"measured_values"`
 	MeasuredValues []*MeasuredValue `xml:"measured_value"`
 }
 
+// MeasuredValue is an XML Wrapper for the original measured value struct
 type MeasuredValue struct {
 	XMLName xml.Name `xml:"measured_value"`
 	*types.MeasuredValue