docsgenerator

type Comment struct {
	Name        string    `yaml:"name"`
	Description string    `yaml:"description"`
	Note        string    `yaml:"note"`
	Default     string    `yaml:"default"`
	Examples    []Example `yaml:"examples"`
	Example     Example   `yaml:"example"`
	Values      []string  `yaml:"values"`
	// Makes item param if specified param is defined
	OptionalIf  string `yaml:"optional_if"`
	RequiredlIf string `yaml:"required_if"`
}

type Example struct {
	Name  string `yaml:"name"`
	Value string `yaml:"value"`
	Type  string `yaml:"type"`
}

type FieldDoc struct {
	// Name represents struct name or field name.
	Name string
	// Type represents struct name or field type.
	Type string
	// Description represents the full description for the item.
	Description string
	// Note is rendered as a note for the example in markdown file.
	Note string

	Optional   bool
	OptionalIf string
	RequiredIf string
	Default    string

	// Examples: List of example values for the item.
	Examples []Example
	// Values is only used to render valid values listed in the documentation.
	Values []string

	// Options renders extra options for this field.
	Options []string
	// contains filtered or unexported fields
}

type FileDoc struct {
	// Description: File description, supports markdown.
	Description string
	// Types structs defined in the file.
	Types   []*TypeDoc
	Anchors map[string]string
	// contains filtered or unexported fields
}

type TypeDoc struct {
	// Name represents struct name or field name.
	Name string
	// Type represents struct name or field type.
	Type string
	// Description represents the full description for the item.
	Description string
	// Note is rendered as a note for the example in markdown file.
	Note string
	// Fields contains fields documentation if related item is a struct.
	Fields []FieldDoc
	// Example values for the type.
	Example Example
}

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