Function Docs

dsl/api.go:203–222

Docs provides external documentation URLs. It is used by the generated OpenAPI specification. Docs must appear in an API, Service, Method or Attribute expr. Docs takes a single argument which is the defining DSL. Example: var _ = API("cellar", func() { Docs(func() { Description("A

(fn func())

//	    })
//	})
func Docs(fn func()) {
	docs := new(expr.DocsExpr)
	if !eval.Execute(fn, docs) {
		return
	}
	switch e := eval.Current().(type) {
	case *expr.APIExpr:
		e.Docs = docs
	case *expr.ServiceExpr:
		e.Docs = docs
	case *expr.MethodExpr:
		e.Docs = docs
	case *expr.AttributeExpr:
		e.Docs = docs
	case *expr.HTTPFileServerExpr:
		e.Docs = docs
	default:
		eval.IncompatibleDSL()
	}
}

// TermsOfService describes the API terms of services or links to them.
//