docs

type Class struct {
	Category string `json:",omitempty"`
	Doc
}

type Constant struct {
	Name string
	Type string
	Tags []string `json:",omitempty"`
	Doc
}

type Constructor struct {
	Name       string
	Parameters []Parameter
	Tags       []string `json:",omitempty"`
	Doc
}

type Context struct {
	// Base URL for external doc website.
	BaseURL url.URL
	// Path within base corresponding to renderer object.
	Path string
	// Base URL for external image CDN.
	BaseImageURL url.URL

	// Heading level to use.
	Level int
	// Heading levels for summary section.
	SummaryLevel int
	// Heading levels for description section.
	DescriptionLevel int
}

type Doc struct {
	Summary            string   `json:",omitempty"`
	Description        string   `json:",omitempty"`
	DeprecationMessage string   `json:",omitempty"`
	CodeSamples        []string `json:",omitempty"`
}

type Enum struct {
	Doc
}

type EnumItem struct {
	Doc
}

type Function struct {
	Name       string
	Parameters []Parameter
	Returns    []Return
	Tags       []string `json:",omitempty"`
	Doc
}

type Member struct {
	Doc
}

type Method struct {
	Name       string
	Parameters []Parameter
	Returns    []Return
	Tags       []string `json:",omitempty"`
	Doc
}

type Operation struct {
	Operation  string
	TypeA      string
	TypeB      string
	ReturnType string
	Tags       []string `json:",omitempty"`
	Doc
}

type Parameter struct {
	Name    string
	Type    string
	Default any
	Summary string `json:",omitempty"`
}

type Property struct {
	Name string
	Type string
	Tags []string `json:",omitempty"`
	Doc
}

type Renderer interface {
	// Recursively replace markdown fields with rendered HTML.
	RenderHTML(ctx Context) error
}

type Return struct {
	Type    string
	Summary string `json:",omitempty"`
}

type Root struct {
	Class    map[id.Class]*Class
	Member   map[id.Class]map[id.Member]*Member
	Enum     map[id.Enum]*Enum
	EnumItem map[id.Enum]map[id.EnumItem]*EnumItem
	Type     map[id.Type]*Type
}

type Transformer struct {
	Method XFM
	Path   []string
}

type Type struct {
	Constants      []Constant    `json:",omitempty"`
	Constructors   []Constructor `json:",omitempty"`
	Functions      []Function    `json:",omitempty"`
	Properties     []Property    `json:",omitempty"`
	Methods        []Method      `json:",omitempty"`
	MathOperations []Operation   `json:",omitempty"`
	Tags           []string      `json:",omitempty"`
	Doc
}

type XFM func(outer any, key string) error