encoder

type Appearance struct {
	TypeName  string
	FieldName string
}

type CommentsFlags int

type Doc struct {
	// Comments stores foot, line and head comments.
	Comments [3]string
	// Fields contains fields documentation if related item is a struct.
	Fields []Doc
	// Examples list of example values for the item.
	Examples []*Example
	// Values is only used to render valid values list in the documentation.
	Values []string
	// Description represents the full description for the item.
	Description string
	// Name represents struct name or field name.
	Name string
	// Type represents struct name or field type.
	Type string
	// Note is rendered as a note for the example in markdown file.
	Note string
	// AppearsIn describes back references for the type.
	AppearsIn []Appearance
	// Inline indicates that this field is inlined (embedded).
	Inline bool
}

type Documented interface {
	// Doc requests documentation object.
	Doc() *Doc
}

type Encoder struct {
	// contains filtered or unexported fields
}

type Example struct {
	Name string
	// contains filtered or unexported fields
}

type FileDoc struct {
	// Name will be used in md file name pattern.
	Name string
	// Description file description, supports markdown.
	Description string
	// Structs structs defined in the file.
	Structs []*Doc
	// Types is map of all non-trivial types defined in the file.
	Types map[string]*Doc
}

type Option func(*Options)

type Options struct {
	Comments  CommentsFlags
	OmitEmpty bool
}