chore: comments

internal/pkg/core/notifier/providers/bark/bark.go

@@ -11,7 +11,10 @@ import (
 )
 
 type BarkNotifierConfig struct {
+	// Bark 服务地址。
+	// 零值时默认使用官方服务器。
 	ServerUrl string `json:"serverUrl"`
+	// Bark 设备密钥。
 	DeviceKey string `json:"deviceKey"`
 }
 

internal/pkg/core/notifier/providers/dingtalk/dingtalk.go

@@ -10,8 +10,10 @@ import (
 )
 
 type DingTalkNotifierConfig struct {
+	// 钉钉机器人的 Token。
 	AccessToken string `json:"accessToken"`
-	Secret      string `json:"secret"`
+	// 钉钉机器人的 Secret。
+	Secret string `json:"secret"`
 }
 
 type DingTalkNotifier struct {

internal/pkg/core/notifier/providers/email/email.go

@@ -13,12 +13,20 @@ import (
 )
 
 type EmailNotifierConfig struct {
-	SmtpHost        string `json:"smtpHost"`
-	SmtpPort        int32  `json:"smtpPort"`
-	SmtpTLS         bool   `json:"smtpTLS"`
-	Username        string `json:"username"`
-	Password        string `json:"password"`
-	SenderAddress   string `json:"senderAddress"`
+	// SMTP 服务器地址。
+	SmtpHost string `json:"smtpHost"`
+	// SMTP 服务器端口。
+	// 零值时根据是否启用 TLS 决定。
+	SmtpPort int32 `json:"smtpPort"`
+	// 是否启用 TLS。
+	SmtpTLS bool `json:"smtpTLS"`
+	// 用户名。
+	Username string `json:"username"`
+	// 密码。
+	Password string `json:"password"`
+	// 发件人邮箱。
+	SenderAddress string `json:"senderAddress"`
+	// 收件人邮箱。
 	ReceiverAddress string `json:"receiverAddress"`
 }
 

internal/pkg/core/notifier/providers/lark/lark.go

@@ -10,6 +10,7 @@ import (
 )
 
 type LarkNotifierConfig struct {
+	// 飞书 Webhook 地址。
 	WebhookUrl string `json:"webhookUrl"`
 }
 

internal/pkg/core/notifier/providers/serverchan/serverchan.go

@@ -11,6 +11,7 @@ import (
 )
 
 type ServerChanNotifierConfig struct {
+	// ServerChan 服务地址。
 	Url string `json:"url"`
 }
 

internal/pkg/core/notifier/providers/telegram/telegram.go

@@ -10,8 +10,10 @@ import (
 )
 
 type TelegramNotifierConfig struct {
+	// Telegram API Token。
 	ApiToken string `json:"apiToken"`
-	ChatId   int64  `json:"chatId"`
+	// Telegram Chat ID。
+	ChatId int64 `json:"chatId"`
 }
 
 type TelegramNotifier struct {

internal/pkg/core/notifier/providers/webhook/webhook.go

@@ -10,6 +10,7 @@ import (
 )
 
 type WebhookNotifierConfig struct {
+	// Webhook URL。
 	Url string `json:"url"`
 }
 

internal/pkg/core/uploader/providers/aliyun-cas/aliyun_cas.go

@@ -17,9 +17,12 @@ import (
 )
 
 type AliyunCASUploaderConfig struct {
-	AccessKeyId     string `json:"accessKeyId"`
+	// 阿里云 AccessKeyId。
+	AccessKeyId string `json:"accessKeyId"`
+	// 阿里云 AccessKeySecret。
 	AccessKeySecret string `json:"accessKeySecret"`
-	Region          string `json:"region"`
+	// 阿里云地域。
+	Region string `json:"region"`
 }
 
 type AliyunCASUploader struct {

internal/pkg/core/uploader/providers/aliyun-slb/aliyun_slb.go

@@ -20,9 +20,12 @@ import (
 )
 
 type AliyunSLBUploaderConfig struct {
-	AccessKeyId     string `json:"accessKeyId"`
+	// 阿里云 AccessKeyId。
+	AccessKeyId string `json:"accessKeyId"`
+	// 阿里云 AccessKeySecret。
 	AccessKeySecret string `json:"accessKeySecret"`
-	Region          string `json:"region"`
+	// 阿里云地域。
+	Region string `json:"region"`
 }
 
 type AliyunSLBUploader struct {

internal/pkg/core/uploader/providers/byteplus-cdn/byteplus_cdn.go

@@ -19,7 +19,9 @@ import (
 )
 
 type ByteplusCDNUploaderConfig struct {
+	// BytePlus AccessKey。
 	AccessKey string `json:"accessKey"`
+	// BytePlus SecretKey。
 	SecretKey string `json:"secretKey"`
 }
 

internal/pkg/core/uploader/providers/dogecloud/dogecloud.go

@@ -13,7 +13,9 @@ import (
 )
 
 type DogeCloudUploaderConfig struct {
+	// 多吉云 AccessKey。
 	AccessKey string `json:"accessKey"`
+	// 多吉云 SecretKey。
 	SecretKey string `json:"secretKey"`
 }
 

internal/pkg/core/uploader/providers/huaweicloud-elb/huaweicloud_elb.go

@@ -22,9 +22,12 @@ import (
 )
 
 type HuaweiCloudELBUploaderConfig struct {
-	AccessKeyId     string `json:"accessKeyId"`
+	// 华为云 AccessKeyId。
+	AccessKeyId string `json:"accessKeyId"`
+	// 华为云 SecretAccessKey。
 	SecretAccessKey string `json:"secretAccessKey"`
-	Region          string `json:"region"`
+	// 华为云地域。
+	Region string `json:"region"`
 }
 
 type HuaweiCloudELBUploader struct {

internal/pkg/core/uploader/providers/huaweicloud-scm/huaweicloud_scm.go

@@ -18,9 +18,12 @@ import (
 )
 
 type HuaweiCloudSCMUploaderConfig struct {
-	AccessKeyId     string `json:"accessKeyId"`
+	// 华为云 AccessKeyId。
+	AccessKeyId string `json:"accessKeyId"`
+	// 华为云 SecretAccessKey。
 	SecretAccessKey string `json:"secretAccessKey"`
-	Region          string `json:"region"`
+	// 华为云地域。
+	Region string `json:"region"`
 }
 
 type HuaweiCloudSCMUploader struct {

internal/pkg/core/uploader/providers/qiniu-sslcert/qiniu_sslcert.go

@@ -15,7 +15,9 @@ import (
 )
 
 type QiniuSSLCertUploaderConfig struct {
+	// 七牛云 AccessKey。
 	AccessKey string `json:"accessKey"`
+	// 七牛云 SecretKey。
 	SecretKey string `json:"secretKey"`
 }
 

internal/pkg/core/uploader/providers/tencentcloud-ssl/tencentcloud_ssl.go

@@ -13,7 +13,9 @@ import (
 )
 
 type TencentCloudSSLUploaderConfig struct {
-	SecretId  string `json:"secretId"`
+	// 腾讯云 SecretId。
+	SecretId string `json:"secretId"`
+	// 腾讯云 SecretKey。
 	SecretKey string `json:"secretKey"`
 }
 

internal/pkg/core/uploader/providers/volcengine-cdn/volcengine_cdn.go

@@ -19,7 +19,9 @@ import (
 )
 
 type VolcEngineCDNUploaderConfig struct {
-	AccessKeyId     string `json:"accessKeyId"`
+	// 火山引擎 AccessKeyId。
+	AccessKeyId string `json:"accessKeyId"`
+	// 火山引擎 AccessKeySecret。
 	AccessKeySecret string `json:"accessKeySecret"`
 }
 

internal/pkg/core/uploader/providers/volcengine-live/volcengine_live.go

@@ -16,7 +16,9 @@ import (
 )
 
 type VolcEngineLiveUploaderConfig struct {
-	AccessKeyId     string `json:"accessKeyId"`
+	// 火山引擎 AccessKeyId。
+	AccessKeyId string `json:"accessKeyId"`
+	// 火山引擎 AccessKeySecret。
 	AccessKeySecret string `json:"accessKeySecret"`
 }