Browse Source

Add doc comment to Config struct

ayntgl 4 years ago
parent
commit
c545b4071a
1 changed files with 2 additions and 0 deletions
  1. 2 0
      util/config.go

+ 2 - 0
util/config.go

@@ -21,6 +21,7 @@ type keybindings struct {
 	MessageInputFieldFocus string
 }
 
+// Config consists of fields that can be customized by the user using the configuration file.
 type Config struct {
 	Token            string
 	Mouse            bool
@@ -31,6 +32,7 @@ type Config struct {
 	Keybindings      keybindings
 }
 
+// LoadConfig createsa new configuration file (if does not exist) and returns the default configuration or reads the existing configuration file from the default path.
 func LoadConfig() *Config {
 	u, err := os.UserHomeDir()
 	if err != nil {