Fix code style problems

app/internal/nuga/app.go

@@ -99,7 +99,7 @@ func (a *App) GetPath() string {
 	return a.dev.Path
 }
 
-// GetModes returns keyboard modes
+// GetLightDomains returns keyboard light domains
 func (a *App) GetLightDomains() []effect.Domain {
 	return a.dev.LightDomains
 }

lib/examples/describe/main.go

@@ -18,7 +18,7 @@ func describe(d *device.Device) {
 }
 
 func openSimulation(tplPath string) (*device.Device, error) {
-	content, err := os.ReadFile(os.Args[1])
+	content, err := os.ReadFile(tplPath)
 	if err != nil {
 		panic(err)
 	}

lib/pkg/bit/mask.go

@@ -1,3 +1,4 @@
+// Package bit contains utils for bit masks
 package bit
 
 // Mask represents bit mask entity

lib/pkg/device/device.go

@@ -1,3 +1,4 @@
+// Package device is the entrypoint for keyboard device control
 package device
 
 import (
@@ -6,6 +7,7 @@ import (
 	"nuga/pkg/light/effect"
 )
 
+// Device represents keyboard with its controls
 type Device struct {
 	Name         string
 	Layout       int
@@ -14,22 +16,27 @@ type Device struct {
 	LightDomains []effect.Domain
 }
 
+// GetEffects returns keyboard effects.
 func (d *Device) GetEffects() (*light.Effects, error) {
 	return d.Light.GetEffects()
 }
 
+// SetEffects sets keyboard effects.
 func (d *Device) SetEffects(p *light.Effects) error {
 	return d.Light.SetEffects(p)
 }
 
+// GetColors returns keyboard colors state.
 func (d *Device) GetColors() (*light.ColorState, error) {
 	return d.Light.GetColors()
 }
 
+// SetColors sets keyboard color state.
 func (d *Device) SetColors(c *light.ColorState) error {
 	return d.Light.SetColors(c)
 }
 
+// Open real keyboard USB handle
 func Open() (*Device, error) {
 	handle, err := hid.OpenHandle()
 	if err != nil {

lib/pkg/device/errors.go

@@ -2,6 +2,8 @@ package device
 
 import "errors"
 
+// ErrNotSupported is returned when you try to open a keyboard that is not supported by the application
 var ErrNotSupported = errors.New("device is not supported")
 
+// ErrWrongVendor is returned when you try to open a keyboard not from NuPhy
 var ErrWrongVendor = errors.New("device vendor is not NuPhy")

lib/pkg/device/simulation.go

@@ -2,6 +2,7 @@ package device
 
 import "nuga/pkg/light"
 
+// OpenSimulation opens not real keyboard from template (for testing)
 func OpenSimulation(t light.SimulationTemplate) (*Device, error) {
 	d, err := getDevice(t.Name)
 	if err != nil {

lib/pkg/device/supported.go

@@ -5,6 +5,7 @@ import (
 	"strings"
 )
 
+// SupportedDevices contains nuga supported keyboard list with its features
 var SupportedDevices = []Device{
 	{
 		Name:   "Halo75",

lib/pkg/light/controller-k916.go

@@ -105,6 +105,7 @@ func (d *K916Controller) SetEffects(p *Effects) error {
 	return d.Handle.SendWithRetries(paramsRequest)
 }
 
+// OpenK916 opens BYK916 NuPhy keyboard lights.
 func OpenK916(handle *hid.Handle) Controller {
 	var lights Controller = &K916Controller{
 		Handle: handle,

lib/pkg/light/effect/domain.go

@@ -1,6 +1,6 @@
 package effect
 
-// Modes is a list of keyboard mode
+// Domain is a type of keyboard lights with its mode
 type Domain struct {
 	Name  string
 	Modes []Mode

lib/pkg/light/effect/halolight.go

@@ -33,7 +33,7 @@ var (
 	}
 )
 
-// Backlight is a list of backlight effects.
+// Halo is a domain for halolight effects.
 var Halo = Domain{
 	Name: "Halo",
 	Modes: []Mode{

lib/pkg/light/effect/sidelight.go

@@ -39,6 +39,7 @@ var (
 	}
 )
 
+// Sidelight is a domain for sidelight effects.
 var Sidelight = Domain{
 	Name: "Sidelight",
 	Modes: []Mode{