Lint.

udhos · Mar 14, 2017 · a283e25 · a283e25
1 parent 07ea11c
commit a283e25
Show file tree

Hide file tree

Showing 13 changed files with 137 additions and 69 deletions.
diff --git a/conf/conf.go b/conf/conf.go
@@ -8,12 +8,14 @@ import (
 	"github.com/udhos/jazigo/store"
 )
 
+// Change stores info about last config change.
 type Change struct {
 	When time.Time
 	By   string
 	From string
 }
 
+// AppConfig is persistent global configuration.
 type AppConfig struct {
 	MaxConfigFiles    int
 	Holdtime          time.Duration
@@ -24,6 +26,7 @@ type AppConfig struct {
 	Comment           string // free user-defined field
 }
 
+// NewAppConfigFromString creates AppConfig from string.
 func NewAppConfigFromString(str string) (*AppConfig, error) {
 	b := []byte(str)
 	c := &AppConfig{}
@@ -33,6 +36,7 @@ func NewAppConfigFromString(str string) (*AppConfig, error) {
 	return c, nil
 }
 
+// Dump exports AppConfig as YAML.
 func (a *AppConfig) Dump() ([]byte, error) {
 	b, err := yaml.Marshal(a)
 	if err != nil {
@@ -41,6 +45,7 @@ func (a *AppConfig) Dump() ([]byte, error) {
 	return b, nil
 }
 
+// NewDevAttr creates a new set of DevAttributes.
 func NewDevAttr() DevAttributes {
 	a := DevAttributes{
 		ErrlogHistSize: 60, // default max number of lines in errlog history
@@ -49,6 +54,7 @@ func NewDevAttr() DevAttributes {
 	return a
 }
 
+// DevAttributes is per-model set of default attributes for device.
 type DevAttributes struct {
 	NeedLoginChat                bool          // need login chat
 	NeedEnabledMode              bool          // need enabled mode
@@ -83,6 +89,7 @@ type DevAttributes struct {
 	CommandMatchTimeout time.Duration // larger timeout for slow responses (slow show running)
 }
 
+// DevConfig is full set of device properties.
 type DevConfig struct {
 	Debug          bool
 	Deleted        bool
@@ -98,6 +105,7 @@ type DevConfig struct {
 	Attr           DevAttributes
 }
 
+// NewDeviceFromString creates device configuration from string.
 func NewDeviceFromString(str string) (*DevConfig, error) {
 	b := []byte(str)
 	c := &DevConfig{}
@@ -107,6 +115,7 @@ func NewDeviceFromString(str string) (*DevConfig, error) {
 	return c, nil
 }
 
+// Dump exports device properties as YAML.
 func (c *DevConfig) Dump() ([]byte, error) {
 	b, err := yaml.Marshal(c)
 	if err != nil {
@@ -115,11 +124,13 @@ func (c *DevConfig) Dump() ([]byte, error) {
 	return b, nil
 }
 
+// Config is full (global+devices) app configuration.
 type Config struct {
 	Options AppConfig
 	Devices []DevConfig
 }
 
+// New creates new full app configuration.
 func New() *Config {
 	return &Config{
 		Options: AppConfig{
@@ -133,6 +144,7 @@ func New() *Config {
 	}
 }
 
+// Load loads a Config from file.
 func Load(path string, maxSize int64) (*Config, error) {
 	b, readErr := store.FileRead(path, maxSize)
 	if readErr != nil {
@@ -145,6 +157,7 @@ func Load(path string, maxSize int64) (*Config, error) {
 	return c, nil
 }
 
+// Dump exports device properties as YAML.
 func (c *Config) Dump() ([]byte, error) {
 	b, err := yaml.Marshal(c)
 	if err != nil {

diff --git a/conf/options.go b/conf/options.go
@@ -4,22 +4,26 @@ import (
 	"sync"
 )
 
+// Options provides concurrency-safe access to AppConfig.
 type Options struct {
 	options AppConfig
 	lock    sync.RWMutex
 }
 
+// NewOptions creates a new set of options.
 func NewOptions() *Options {
 	return &Options{}
 }
 
+// Get creates a copy of AppConfig.
 func (o *Options) Get() *AppConfig {
 	o.lock.RLock()
 	defer o.lock.RUnlock()
 	opt := o.options // clone
 	return &opt
 }
 
+// Set updates the AppConfig from a copy.
 func (o *Options) Set(c *AppConfig) {
 	o.lock.Lock()
 	defer o.lock.Unlock()

diff --git a/dev/errlog.go b/dev/errlog.go
@@ -9,6 +9,7 @@ import (
 	"time"
 )
 
+// ErrlogPath builds the full pathname for errlog file.
 func ErrlogPath(pathPrefix, id string) string {
 	dir := filepath.Dir(pathPrefix)
 	path := filepath.Join(dir, id) + ".errlog"
@@ -19,7 +20,7 @@ func errlog(logger hasPrintf, result FetchResult, pathPrefix string, debug bool,
 
 	now := time.Now()
 
-	path := ErrlogPath(pathPrefix, result.DevId)
+	path := ErrlogPath(pathPrefix, result.DevID)
 
 	f, openErr := os.OpenFile(path, os.O_CREATE|os.O_RDWR, 0640)
 	if openErr != nil {
@@ -58,7 +59,7 @@ func errlog(logger hasPrintf, result FetchResult, pathPrefix string, debug bool,
 		now.String(),
 		result.Code == fetchErrNone,
 		result.End.Sub(result.Begin),
-		result.Model, result.DevId, result.DevHostPort, result.Transport, result.Code, result.Msg)
+		result.Model, result.DevID, result.DevHostPort, result.Transport, result.Code, result.Msg)
 
 	if debug {
 		logger.Printf("errlog debug: push: '%s': [%s]", path, msg)

diff --git a/dev/filter.go b/dev/filter.go
@@ -5,6 +5,7 @@ import (
 	"strconv"
 )
 
+// FilterTable stores line filters for custom line-by-line processing of configuration.
 type FilterTable struct {
 	table map[string]FilterFunc
 	re1   *regexp.Regexp
@@ -13,8 +14,10 @@ type FilterTable struct {
 	re4   *regexp.Regexp
 }
 
+// FilterFunc is a helper function type for line filters.
 type FilterFunc func(hasPrintf, bool, *FilterTable, []byte, int) []byte
 
+// NewFilterTable creates a filter table.
 func NewFilterTable(logger hasPrintf) *FilterTable {
 	t := &FilterTable{
 		table: map[string]FilterFunc{},