Browse Source

Fix some godocs

master
Matthew Holt 5 years ago
parent
commit
68cebb28d0
No known key found for this signature in database GPG Key ID: 2A349DD577D586A5
  1. 4
      modules/caddyhttp/celmatcher.go
  2. 6
      modules/caddyhttp/staticerror.go

4
modules/caddyhttp/celmatcher.go

@ -44,6 +44,10 @@ func init() {
// This enables complex logic to be expressed using a comfortable, // This enables complex logic to be expressed using a comfortable,
// familiar syntax. // 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 // COMPATIBILITY NOTE: This module is still experimental and is not
// subject to Caddy's compatibility guarantee. // subject to Caddy's compatibility guarantee.
type MatchExpression struct { type MatchExpression struct {

6
modules/caddyhttp/staticerror.go

@ -34,11 +34,11 @@ func init() {
// Since this handler does not write a response, the error information // Since this handler does not write a response, the error information
// is for use by the server to know how to handle the error. // is for use by the server to know how to handle the error.
type StaticError struct { type StaticError struct {
// The recommended HTTP status code. Can be either an integer or a // The error message. Optional. Default is no error message.
// string if placeholders are needed. Optional. Default is 500.
Error string `json:"error,omitempty"` 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"` StatusCode WeakString `json:"status_code,omitempty"`
} }

Loading…
Cancel
Save