docgen

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

type FieldArrayDoc struct {
	Type string
}

type FieldDoc struct {
	Name       string
	Type       string // Full type name
	Comment    string
	Tags       string
	FilePath   string
	Line       int
	Nullable   bool
	IsEmbedded bool
	IsMap      *FieldMapDoc
	IsArray    *FieldArrayDoc
}

type FieldMapDoc struct {
	TypeKey   string
	TypeValue string
}

type FunctionDoc struct {
	Package string
	Name    string
	Comment string
	File    string
	Line    int
	Params  []FunctionParamDoc
	Returns []FunctionParamDoc
}

type FunctionParamDoc struct {
	Name string
	Type string
}

type TypeDoc struct {
	Name     string
	Package  string
	File     string
	Line     int
	Comment  string
	Fields   []FieldDoc
	Methods  []FunctionDoc
	IsStruct bool
}

type YAMLDoc struct {
	Checksum  string                `yaml:"checksum"`
	Types     map[string]YAMLType   `yaml:"types"`
	Functions map[string]YAMLMethod `yaml:"functions"`
}

type YAMLField struct {
	Name       string          `yaml:"name"`
	Type       string          `yaml:"type"`
	Comment    string          `yaml:"comment,omitempty"`
	Tags       string          `yaml:"tags,omitempty"`
	Nullable   bool            `yaml:"nullable,omitempty"`
	IsMap      *YAMLFieldMap   `yaml:"is_map,omitempty"`
	IsArray    *YAMLFieldArray `yaml:"is_array,omitempty"`
	IsEmbedded bool            `yaml:"is_embedded,omitempty"`
}

type YAMLFieldArray struct {
	Type string `yaml:"type"`
}

type YAMLFieldMap struct {
	TypeKey   string `yaml:"key"`
	TypeValue string `yaml:"value"`
}

type YAMLMethod struct {
	Comment string            `yaml:"comment,omitempty"`
	File    string            `yaml:"file"`
	Line    int               `yaml:"line"`
	Inputs  []YAMLMethodParam `yaml:"inputs"`
	Outputs []YAMLMethodParam `yaml:"outputs"`
}

type YAMLMethodParam struct {
	Name string `yaml:"name"`
	Type string `yaml:"type"`
}

type YAMLType struct {
	ID       string                `yaml:"id"`
	PkgPath  string                `yaml:"package"`
	Name     string                `yaml:"name"`
	File     string                `yaml:"file"`
	Line     int                   `yaml:"line"`
	Comment  string                `yaml:"comment,omitempty"`
	Fields   []YAMLField           `yaml:"fields,omitempty"`
	Methods  map[string]YAMLMethod `yaml:"methods,omitempty"`
	IsStruct bool                  `yaml:"is_struct"`
}