doc: add and improve comments

This commit is contained in:
Sebastian Mark 2024-10-30 11:03:18 +01:00
parent 6187122b81
commit f19ab81dc8
11 changed files with 31 additions and 8 deletions

View file

@ -2,7 +2,7 @@ package models
import "github.com/gorilla/websocket"
// Represents a websocket client
// Represents a GoTomato client
type GoTomatoClient struct {
Conn *websocket.Conn // The websocket connection of the client
Password string // Pomodoro password

View file

@ -2,8 +2,9 @@ package models
import GoTomato "git.smsvc.net/pomodoro/GoTomato/pkg/models"
// Represents a ChronoTomato Config
type Config struct {
URL string `yaml:"url"`
Password string `yaml:"password"`
PomodoroConfig GoTomato.PomodoroConfig `yaml:"config"`
URL string `yaml:"url"` // URL to GoTomato server
Password string `yaml:"password"` // Pomodoro Password
PomodoroConfig GoTomato.PomodoroConfig `yaml:"config"` // Pomodoro Config
}