Function NewFieldDoc

common/doc.go:169–177

NewFieldDoc creates a new Doc struct for documenting a struct field.

(name, celType, description string, examples ...*Doc)

// NewFieldDoc creates a new Doc struct for documenting a struct field.
func NewFieldDoc(name, celType, description string, examples ...*Doc) *Doc {
	return &Doc{
		Kind:        DocField,
		Name:        name,
		Type:        celType,
		Description: description,
		Children:    examples,
	}
}

// Documentor is an interface for types that can provide their own documentation.
type Documentor interface {