entities

type Class struct {
	ID      string
	Element *rbxapijson.Class
	Patches []builds.Patch
	Removed bool

	Superclasses []*Class
	Subclasses   []*Class

	Members    map[string]*Member
	MemberList []*Member

	References    map[rbxapijson.Type]ElementTyper
	ReferenceList []ElementTyper
	Referrers     map[[2]string]Referrer
	ReferrerList  []Referrer

	Document  Document
	DocStatus DocStatus
	Metadata  Metadata
}

type DocStatus struct {
	HasDocument     bool
	SummaryStatus   int // 0:nofile; 1:nosection; 2:empty; 3:filled
	SummaryOrphaned bool

	DetailsStatus   int // 0:nofile; 1:nosection; 2:empty; 3:filled
	DetailsSections int

	ExamplesStatus int // 0:nofile; 1:nosection; 2:empty; 3:filled
	ExampleCount   int

	AggregateStatus   int // 0:nofile; 1:none; 2:some; 3:all
	AggregateProgress float64
}

type Document interface {
	Query(name ...string) documents.Section
	SetRender(renderer markdown.Renderer)
	Render() template.HTML
}

type Documentable interface {
	GetDocument() Document
	GetDocStatus() DocStatus
}

type ElementTyper interface {
	Entity
	Identifier() string
	ElementType() rbxapijson.Type
}

type Entities struct {
	Classes   map[string]*Class
	ClassList []*Class
	Members   map[[2]string]*Member
	TreeRoots []*Class

	Enums     map[string]*Enum
	EnumList  []*Enum
	EnumItems map[[2]string]*EnumItem

	Types    map[string]*Type
	TypeList []*Type
	TypeCats []TypeCategory

	Coverage float32
}

type Entity interface {
	IsRemoved() bool
}

type Enum struct {
	ID      string
	Element *rbxapijson.Enum
	Patches []builds.Patch
	Removed bool

	Items    map[string]*EnumItem
	ItemList []*EnumItem

	Referrers    map[[2]string]Referrer
	ReferrerList []Referrer

	Document  Document
	DocStatus DocStatus
	Metadata  Metadata
}

type EnumItem struct {
	ID      [2]string
	Element *rbxapijson.EnumItem
	Patches []builds.Patch
	Removed bool

	Parent *Enum

	Document  Document
	DocStatus DocStatus
	Metadata  Metadata
}

type Member struct {
	ID      [2]string
	Element rbxapi.Member
	Patches []builds.Patch
	Removed bool

	Parent *Class

	References    map[rbxapijson.Type]ElementTyper
	ReferenceList []ElementTyper

	Document  Document
	DocStatus DocStatus
	Metadata  Metadata
}

type Metadata struct {
	*rbxfile.Instance
}

type Referrer struct {
	Member    *Member
	Parameter *rbxapijson.Parameter
}

type Type struct {
	ID      string
	Element rbxapijson.Type
	Removed bool

	Referrers    map[[2]string]Referrer
	ReferrerList []Referrer

	RemovedRefs    map[[2]string]Referrer
	RemovedRefList []Referrer

	Document  Document
	DocStatus DocStatus
	Metadata  Metadata
}

type TypeCategory struct {
	Name  string
	Types []*Type
}