Function NewOverloadDoc

common/doc.go:141–148

NewOverloadDoc creates a new Doc struct for a function example.

(id, signature string, examples ...*Doc)

// NewOverloadDoc creates a new Doc struct for a function example.
func NewOverloadDoc(id, signature string, examples ...*Doc) *Doc {
	return &Doc{
		Kind:      DocOverload,
		Name:      id,
		Signature: signature,
		Children:  examples,
	}
}

// NewMacroDoc creates a new Doc struct for documenting a macro.
func NewMacroDoc(name, description string, examples ...*Doc) *Doc {