浏览代码

Add doc comment to Config struct

ayntgl 4 年之前
父节点
当前提交
c545b4071a
共有 1 个文件被更改,包括 2 次插入0 次删除
  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 {