From: Matt Joiner Date: Tue, 23 Jul 2019 01:30:05 +0000 (+1000) Subject: Improve comments on some config fields X-Git-Tag: v1.5.0~3 X-Git-Url: http://www.git.stargrave.org/?a=commitdiff_plain;h=018de2c96c8bd29808c3e59d1af02c82f9b93703;p=btrtrc.git Improve comments on some config fields --- diff --git a/config.go b/config.go index f4c190fb..4ca2ef07 100644 --- a/config.go +++ b/config.go @@ -69,8 +69,10 @@ type ClientConfig struct { DefaultStorage storage.ClientImpl HeaderObfuscationPolicy HeaderObfuscationPolicy - CryptoProvides mse.CryptoMethod - CryptoSelector mse.CryptoSelector + // The crypto methods to offer when initiating connections with header obfuscation. + 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. // Examples: socks5://demo:demo@192.168.99.100:1080 @@ -172,6 +174,6 @@ func NewDefaultClientConfig() *ClientConfig { } type HeaderObfuscationPolicy struct { - RequirePreferred bool // Whether the value of Preferred is a strict requirement - Preferred bool // Whether header obfuscation is preferred + RequirePreferred bool // Whether the value of Preferred is a strict requirement. + Preferred bool // Whether header obfuscation is preferred. }