Function NewExampleDoc

common/doc.go:161–166

NewExampleDoc creates a new Doc struct specifically for holding an example.

(ex string)

// NewExampleDoc creates a new Doc struct specifically for holding an example.
func NewExampleDoc(ex string) *Doc {
	return &Doc{
		Kind:        DocExample,
		Description: ex,
	}
}

// NewFieldDoc creates a new Doc struct for documenting a struct field.
func NewFieldDoc(name, celType, description string, examples ...*Doc) *Doc {