Function NewFunctionDoc

common/doc.go:131–138

NewFunctionDoc creates a new Doc struct for documenting a function.

(name, description string, overloads ...*Doc)

// NewFunctionDoc creates a new Doc struct for documenting a function.
func NewFunctionDoc(name, description string, overloads ...*Doc) *Doc {
	return &Doc{
		Kind:        DocFunction,
		Name:        name,
		Description: ParseDescription(description),
		Children:    overloads,
	}
}

// NewOverloadDoc creates a new Doc struct for a function example.
func NewOverloadDoc(id, signature string, examples ...*Doc) *Doc {