From 95ed603de79c66ff76bfe7e42986a2fc8c7a1fa4 Mon Sep 17 00:00:00 2001 From: Matthew Holt Date: Mon, 23 Dec 2019 12:45:35 -0700 Subject: Improve godocs all around These will be used in the new automated documentation system --- modules/caddyhttp/encode/brotli/brotli.go | 4 +++- modules/caddyhttp/encode/encode.go | 12 ++++++++---- 2 files changed, 11 insertions(+), 5 deletions(-) (limited to 'modules/caddyhttp/encode') diff --git a/modules/caddyhttp/encode/brotli/brotli.go b/modules/caddyhttp/encode/brotli/brotli.go index 52bb205..fababd3 100644 --- a/modules/caddyhttp/encode/brotli/brotli.go +++ b/modules/caddyhttp/encode/brotli/brotli.go @@ -29,7 +29,9 @@ func init() { } // Brotli can create brotli encoders. Note that brotli -// is not known for great encoding performance. +// is not known for great encoding performance, and +// its use during requests is discouraged; instead, +// pre-compress the content instead. type Brotli struct { Quality *int `json:"quality,omitempty"` } diff --git a/modules/caddyhttp/encode/encode.go b/modules/caddyhttp/encode/encode.go index c68f507..c3a1c23 100644 --- a/modules/caddyhttp/encode/encode.go +++ b/modules/caddyhttp/encode/encode.go @@ -39,9 +39,15 @@ func init() { // Encode is a middleware which can encode responses. type Encode struct { + // Selection of compression algorithms to choose from. The best one + // will be chosen based on the client's Accept-Encoding header. EncodingsRaw caddy.ModuleMap `json:"encodings,omitempty" caddy:"namespace=http.encoders"` - Prefer []string `json:"prefer,omitempty"` - MinLength int `json:"minimum_length,omitempty"` + + // If the client has no strong preference, choose this encoding. TODO: Not yet implemented + // Prefer []string `json:"prefer,omitempty"` + + // Only encode responses that are at least this many bytes long. + MinLength int `json:"minimum_length,omitempty"` writerPools map[string]*sync.Pool // TODO: these pools do not get reused through config reloads... } @@ -66,11 +72,9 @@ func (enc *Encode) Provision(ctx caddy.Context) error { return fmt.Errorf("adding encoding %s: %v", modName, err) } } - if enc.MinLength == 0 { enc.MinLength = defaultMinLength } - return nil } -- cgit v1.2.3