summaryrefslogtreecommitdiff
path: root/modules/caddyhttp
diff options
context:
space:
mode:
authorMatthew Holt <mholt@users.noreply.github.com>2020-04-11 09:01:40 -0600
committerMatthew Holt <mholt@users.noreply.github.com>2020-04-11 09:01:40 -0600
commit68cebb28d063a7a71705ce022f118b5e1205fa3f (patch)
tree6160f51ecb9b17720cf373a389765fa923995583 /modules/caddyhttp
parenta3bdc22234b75e9420f8810918072fa34732ffb7 (diff)
Fix some godocs
Diffstat (limited to 'modules/caddyhttp')
-rw-r--r--modules/caddyhttp/celmatcher.go4
-rw-r--r--modules/caddyhttp/staticerror.go6
2 files changed, 7 insertions, 3 deletions
diff --git a/modules/caddyhttp/celmatcher.go b/modules/caddyhttp/celmatcher.go
index 8d183c1..19c7bca 100644
--- a/modules/caddyhttp/celmatcher.go
+++ b/modules/caddyhttp/celmatcher.go
@@ -44,6 +44,10 @@ func init() {
// This enables complex logic to be expressed using a comfortable,
// familiar syntax.
//
+// This matcher's JSON interface is actually a string, not a struct.
+// The generated docs are not correct because this type has custom
+// marshaling logic.
+//
// COMPATIBILITY NOTE: This module is still experimental and is not
// subject to Caddy's compatibility guarantee.
type MatchExpression struct {
diff --git a/modules/caddyhttp/staticerror.go b/modules/caddyhttp/staticerror.go
index 306c3eb..d2d255e 100644
--- a/modules/caddyhttp/staticerror.go
+++ b/modules/caddyhttp/staticerror.go
@@ -34,11 +34,11 @@ func init() {
// Since this handler does not write a response, the error information
// is for use by the server to know how to handle the error.
type StaticError struct {
- // The recommended HTTP status code. Can be either an integer or a
- // string if placeholders are needed. Optional. Default is 500.
+ // The error message. Optional. Default is no error message.
Error string `json:"error,omitempty"`
- // The error message. Optional. Default is no error message.
+ // The recommended HTTP status code. Can be either an integer or a
+ // string if placeholders are needed. Optional. Default is 500.
StatusCode WeakString `json:"status_code,omitempty"`
}