Improve comments on some config fields

This commit is contained in:
Matt Joiner 2019-07-23 11:30:05 +10:00
parent e9df943d90
commit 018de2c96c
1 changed files with 6 additions and 4 deletions

View File

@ -69,8 +69,10 @@ type ClientConfig struct {
DefaultStorage storage.ClientImpl DefaultStorage storage.ClientImpl
HeaderObfuscationPolicy HeaderObfuscationPolicy HeaderObfuscationPolicy HeaderObfuscationPolicy
CryptoProvides mse.CryptoMethod // The crypto methods to offer when initiating connections with header obfuscation.
CryptoSelector mse.CryptoSelector CryptoProvides mse.CryptoMethod
// Chooses the crypto method to use when receiving connections with header obfuscation.
CryptoSelector mse.CryptoSelector
// Sets usage of Socks5 Proxy. Authentication should be included in the url if needed. // Sets usage of Socks5 Proxy. Authentication should be included in the url if needed.
// Examples: socks5://demo:demo@192.168.99.100:1080 // Examples: socks5://demo:demo@192.168.99.100:1080
@ -172,6 +174,6 @@ func NewDefaultClientConfig() *ClientConfig {
} }
type HeaderObfuscationPolicy struct { type HeaderObfuscationPolicy struct {
RequirePreferred bool // Whether the value of Preferred is a strict requirement RequirePreferred bool // Whether the value of Preferred is a strict requirement.
Preferred bool // Whether header obfuscation is preferred Preferred bool // Whether header obfuscation is preferred.
} }