feat: add comments for configuration fields

- add documentation comments for
  - GoTomatoTimerConfig
  - GoTomatoServerConfig

🤖
This commit is contained in:
Sebastian Mark 2024-10-20 20:49:36 +02:00
parent 45c527cc79
commit d0e1162726

View file

@ -1,13 +1,13 @@
package models package models
type GoTomatoTimerConfig struct { type GoTomatoTimerConfig struct {
Work int `json:"work"` Work int `json:"work"` // Length of work sessions in seconds
ShortBreak int `json:"shortBreak"` ShortBreak int `json:"shortBreak"` // Length of short break in seconds
LongBreak int `json:"longBreak"` LongBreak int `json:"longBreak"` // Length if ling break in seconds
Sessions int `json:"sessions"` Sessions int `json:"sessions"` // Number of total sessions
} }
type GoTomatoServerConfig struct { type GoTomatoServerConfig struct {
ListenAddress string `json:"listenAddress"` ListenAddress string `json:"listenAddress"` // Server listen address
ListenPort int `json:"listenPort"` ListenPort int `json:"listenPort"` // Server listen port
} }