Function NewMacroDoc

common/doc.go:151–158

NewMacroDoc creates a new Doc struct for documenting a macro.

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

// NewMacroDoc creates a new Doc struct for documenting a macro.
func NewMacroDoc(name, description string, examples ...*Doc) *Doc {
	return &Doc{
		Kind:        DocMacro,
		Name:        name,
		Description: ParseDescription(description),
		Children:    examples,
	}
}

// NewExampleDoc creates a new Doc struct specifically for holding an example.
func NewExampleDoc(ex string) *Doc {