diff options
author | Matthew Holt <mholt@users.noreply.github.com> | 2019-12-23 12:45:35 -0700 |
---|---|---|
committer | Matthew Holt <mholt@users.noreply.github.com> | 2019-12-23 12:45:35 -0700 |
commit | 95ed603de79c66ff76bfe7e42986a2fc8c7a1fa4 (patch) | |
tree | 1a788b8eba98f0c2e69e5816bac9c7cc09aca96f /modules/caddyhttp/vars.go | |
parent | cbb405f6aaee046c9de9ffb4f07ca824d9eedeb1 (diff) |
Improve godocs all around
These will be used in the new automated documentation system
Diffstat (limited to 'modules/caddyhttp/vars.go')
-rw-r--r-- | modules/caddyhttp/vars.go | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/modules/caddyhttp/vars.go b/modules/caddyhttp/vars.go index 791203b..6299dcf 100644 --- a/modules/caddyhttp/vars.go +++ b/modules/caddyhttp/vars.go @@ -26,7 +26,8 @@ func init() { } // VarsMiddleware is an HTTP middleware which sets variables -// in the context, mainly for use by placeholders. +// in the context, mainly for use by placeholders. The +// placeholders have the form: `{http.vars.variable_name}` type VarsMiddleware map[string]string // CaddyModule returns the Caddy module information. |