From ca1ebe5de7d926bf3ce4a6db5e3624bf814ab182 Mon Sep 17 00:00:00 2001
From: mishamyrt <misha@myrt.co>
Date: Wed, 19 Jul 2023 22:48:22 +0300
Subject: [PATCH] Fix code style problems

---
 app/internal/nuga/app.go          | 2 +-
 lib/examples/describe/main.go     | 2 +-
 lib/pkg/bit/mask.go               | 1 +
 lib/pkg/device/device.go          | 7 +++++++
 lib/pkg/device/errors.go          | 2 ++
 lib/pkg/device/simulation.go      | 1 +
 lib/pkg/device/supported.go       | 1 +
 lib/pkg/light/controller-k916.go  | 1 +
 lib/pkg/light/effect/domain.go    | 2 +-
 lib/pkg/light/effect/halolight.go | 2 +-
 lib/pkg/light/effect/sidelight.go | 1 +
 11 files changed, 18 insertions(+), 4 deletions(-)

diff --git a/app/internal/nuga/app.go b/app/internal/nuga/app.go
index 6e8a5439..173a0525 100644
--- a/app/internal/nuga/app.go
+++ b/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
 }
diff --git a/lib/examples/describe/main.go b/lib/examples/describe/main.go
index 68dbbd8b..f386d12f 100644
--- a/lib/examples/describe/main.go
+++ b/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)
 	}
diff --git a/lib/pkg/bit/mask.go b/lib/pkg/bit/mask.go
index 6356c003..179daae5 100644
--- a/lib/pkg/bit/mask.go
+++ b/lib/pkg/bit/mask.go
@@ -1,3 +1,4 @@
+// Package bit contains utils for bit masks
 package bit
 
 // Mask represents bit mask entity
diff --git a/lib/pkg/device/device.go b/lib/pkg/device/device.go
index 57240604..2ade089e 100644
--- a/lib/pkg/device/device.go
+++ b/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 {
diff --git a/lib/pkg/device/errors.go b/lib/pkg/device/errors.go
index 81d1cee8..23927b38 100644
--- a/lib/pkg/device/errors.go
+++ b/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")
diff --git a/lib/pkg/device/simulation.go b/lib/pkg/device/simulation.go
index 6e8886e3..14c9d62c 100644
--- a/lib/pkg/device/simulation.go
+++ b/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 {
diff --git a/lib/pkg/device/supported.go b/lib/pkg/device/supported.go
index 5a736f63..f459427e 100644
--- a/lib/pkg/device/supported.go
+++ b/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",
diff --git a/lib/pkg/light/controller-k916.go b/lib/pkg/light/controller-k916.go
index cea3f6f4..66419948 100644
--- a/lib/pkg/light/controller-k916.go
+++ b/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,
diff --git a/lib/pkg/light/effect/domain.go b/lib/pkg/light/effect/domain.go
index 0b641ac7..63de1b67 100644
--- a/lib/pkg/light/effect/domain.go
+++ b/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
diff --git a/lib/pkg/light/effect/halolight.go b/lib/pkg/light/effect/halolight.go
index 52a259cb..82821dd8 100644
--- a/lib/pkg/light/effect/halolight.go
+++ b/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{
diff --git a/lib/pkg/light/effect/sidelight.go b/lib/pkg/light/effect/sidelight.go
index 0d1cdff3..c434309b 100644
--- a/lib/pkg/light/effect/sidelight.go
+++ b/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{