docs: add comments to clarify functions and handlers in config, hub, serial, and update files

Author: dido18

config/config.go

@@ -143,6 +143,11 @@ func SetInstallCertsIni(filename string, value string) error {
 	return nil
 }
 
+// GetConfigPath returns the full path to the Arduino Create Agent configuration file.
+// It will check if the config file exists in the default location
+// and if not, it will generate a new one.
+// It will also check if the ARDUINO_CREATE_AGENT_CONFIG environment variable is set,
+// and if so, it will use that path instead of the default one.
 func GetConfigPath() *paths.Path {
 	// Let's handle the config
 	configDir := GetDefaultConfigDir()

hub.go

@@ -52,6 +52,8 @@ type hub struct {
 	serialPortList *SerialPortList
 }
 
+// NewHub creates a hub that acts as a central hub for handling
+// WebSocket connections, broadcasting messages, and processing commands.
 func NewHub(serialhub *serialhub, serialList *SerialPortList) *hub {
 	hub := &hub{
 		broadcast:      make(chan []byte, 1000),

info.go

@@ -41,7 +41,7 @@ func infoHandler(c *gin.Context) {
 	})
 }
 
-func PauseHandler(h *hub, s *systray.Systray) func(c *gin.Context) {
+func pauseHandler(h *hub, s *systray.Systray) func(c *gin.Context) {
 	return func(c *gin.Context) {
 		go func() {
 			ports, _ := serial.GetPortsList()

main.go

@@ -450,8 +450,8 @@ func loop(stray *systray.Systray, configPath *paths.Path) {
 	r.Handle("WS", "/socket.io/", socketHandler)
 	r.Handle("WSS", "/socket.io/", socketHandler)
 	r.GET("/info", infoHandler)
-	r.POST("/pause", PauseHandler(hub, stray))
-	r.POST("/update", UpdateHandler(stray))
+	r.POST("/pause", pauseHandler(hub, stray))
+	r.POST("/update", updateHandler(stray))
 
 	// Mount goa handlers
 	goa := v2.Server(config.GetDataDir().String(), Index, signaturePubKey)

serial.go

@@ -38,6 +38,8 @@ type serialhub struct {
 	OnUnregister func(port *serport)
 }
 
+// NewSerialHub creates a new serial hub
+// It is used to manage serial ports and their connections.
 func NewSerialHub() *serialhub {
 	return &serialhub{
 		ports: make(map[*serport]bool),
@@ -53,6 +55,7 @@ type SerialPortList struct {
 	OnErr  func(string) `json:"-"`
 }
 
+// NewSerialPortList creates a new serial port list
 func NewSerialPortList() *SerialPortList {
 	return &SerialPortList{}
 }

update.go

@@ -35,7 +35,7 @@ import (
 	"github.com/gin-gonic/gin"
 )
 
-func UpdateHandler(s *systray.Systray) func(c *gin.Context) {
+func updateHandler(s *systray.Systray) func(c *gin.Context) {
 	return func(c *gin.Context) {
 		restartPath, err := updater.CheckForUpdates(version, *updateURL, *appName)
 		if err != nil {