entities

Documentation

Index

• func QueryDocument(d Documentable, name ...string) documents.Section
• func RenderDocument(s documents.Section, level int) template.HTML
• type Class
  • func (e *Class) ElementType() rbxapijson.Type
  • func (e *Class) GetDocStatus() DocStatus
  • func (e *Class) GetDocument() Document
  • func (e *Class) Identifier() string
  • func (e *Class) IsRemoved() bool
• type DocStatus
  • func (s DocStatus) ProgressString() string
  • func (s DocStatus) StatusString(status int) string
• type Document
• type Documentable
• type ElementTyper
• type Entities
  • func GenerateEntities(patches []builds.Patch) (entities *Entities)
  • func (entities *Entities) AddClass(action *builds.Action, info builds.Info)
  • func (entities *Entities) AddEnum(action *builds.Action, info builds.Info)
  • func (entities *Entities) AddEnumItem(action *builds.Action, info builds.Info)
  • func (entities *Entities) AddMember(action *builds.Action, info builds.Info)
  • func (e *Entities) CoverageString() string
  • func (e *Entities) ElementStatusClasses(suffix bool, v ...interface{}) string
  • func (e *Entities) Icon(v ...interface{}) template.HTML
  • func (entities *Entities) ListAll() []interface{}
• type Entity
• type Enum
  • func (e *Enum) ElementType() rbxapijson.Type
  • func (e *Enum) GetDocStatus() DocStatus
  • func (e *Enum) GetDocument() Document
  • func (e *Enum) Identifier() string
  • func (e *Enum) IsRemoved() bool
• type EnumItem
  • func (e *EnumItem) GetDocStatus() DocStatus
  • func (e *EnumItem) GetDocument() Document
  • func (e *EnumItem) IsRemoved() bool
• type Member
  • func (e *Member) GetDocStatus() DocStatus
  • func (e *Member) GetDocument() Document
  • func (e *Member) IsRemoved() bool
• type Metadata
  • func (m Metadata) GetInt(prop string) (i int)
• type Referrer
• type Type
  • func (e *Type) ElementType() rbxapijson.Type
  • func (e *Type) GetDocStatus() DocStatus
  • func (e *Type) GetDocument() Document
  • func (e *Type) Identifier() string
  • func (e *Type) IsRemoved() bool
• type TypeCategory

Functions

func QueryDocument

func QueryDocument(d Documentable, name ...string) documents.Section

func RenderDocument

func RenderDocument(s documents.Section, level int) template.HTML

Types

type Class

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
}

func (*Class) ElementType

func (e *Class) ElementType() rbxapijson.Type

func (*Class) GetDocStatus

func (e *Class) GetDocStatus() DocStatus

func (*Class) GetDocument

func (e *Class) GetDocument() Document

func (*Class) Identifier

func (e *Class) Identifier() string

func (*Class) IsRemoved

func (e *Class) IsRemoved() bool

type DocStatus

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
}

func (DocStatus) ProgressString

func (s DocStatus) ProgressString() string

func (DocStatus) StatusString

func (s DocStatus) StatusString(status int) string

type Document

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

type Documentable

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

type ElementTyper

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

ElementTyper is implemented by an entity that can be referred to by an rbxapijson.Type.

type Entities

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
}

func GenerateEntities

func GenerateEntities(patches []builds.Patch) (entities *Entities)

func (*Entities) AddClass

func (entities *Entities) AddClass(action *builds.Action, info builds.Info)

func (*Entities) AddEnum

func (entities *Entities) AddEnum(action *builds.Action, info builds.Info)

func (*Entities) AddEnumItem

func (entities *Entities) AddEnumItem(action *builds.Action, info builds.Info)

func (*Entities) AddMember

func (entities *Entities) AddMember(action *builds.Action, info builds.Info)

func (*Entities) CoverageString

func (e *Entities) CoverageString() string

func (*Entities) ElementStatusClasses

func (e *Entities) ElementStatusClasses(suffix bool, v ...interface{}) string

func (*Entities) Icon

func (e *Entities) Icon(v ...interface{}) template.HTML

func (*Entities) ListAll

func (entities *Entities) ListAll() []interface{}

type Entity

type Entity interface {
	IsRemoved() bool
}

type Enum

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
}

func (*Enum) ElementType

func (e *Enum) ElementType() rbxapijson.Type

func (*Enum) GetDocStatus

func (e *Enum) GetDocStatus() DocStatus

func (*Enum) GetDocument

func (e *Enum) GetDocument() Document

func (*Enum) Identifier

func (e *Enum) Identifier() string

func (*Enum) IsRemoved

func (e *Enum) IsRemoved() bool

type EnumItem

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

	Parent *Enum

	Document  Document
	DocStatus DocStatus
	Metadata  Metadata
}

func (*EnumItem) GetDocStatus

func (e *EnumItem) GetDocStatus() DocStatus

func (*EnumItem) GetDocument

func (e *EnumItem) GetDocument() Document

func (*EnumItem) IsRemoved

func (e *EnumItem) IsRemoved() bool

type Member

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
}

func (*Member) GetDocStatus

func (e *Member) GetDocStatus() DocStatus

func (*Member) GetDocument

func (e *Member) GetDocument() Document

func (*Member) IsRemoved

func (e *Member) IsRemoved() bool

type Metadata

type Metadata struct {
	*rbxfile.Instance
}

func (Metadata) GetInt

func (m Metadata) GetInt(prop string) (i int)

type Referrer

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

type Type

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
}

func (*Type) ElementType

func (e *Type) ElementType() rbxapijson.Type

func (*Type) GetDocStatus

func (e *Type) GetDocStatus() DocStatus

func (*Type) GetDocument

func (e *Type) GetDocument() Document

func (*Type) Identifier

func (e *Type) Identifier() string

func (*Type) IsRemoved

func (e *Type) IsRemoved() bool

type TypeCategory

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