const class compilerDoc::DocType

sys::Obj
  compilerDoc::Doc
    compilerDoc::DocType

Source

DocType models the documentation of a Type.

base

const DocTypeRef[] base

Source

Base class inheritance chain where direct subclass is first and sys::Obj is last. If this type is a mixin or this is sys::Obj itself then this is an empty list.

doc

const DocFandoc doc

Source

Fandoc documentation string

docName

virtual override Str docName()

Source

The document name under space is name

facet

DocFacet? facet(Str qname, Bool checked := true)

Source

Return given facet

facets

const DocFacet[] facets

Source

Facets defined on this type

flags

const Int flags

Source

Flags mask - see DocFlags

hasFacet

Bool hasFacet(Str qname)

Source

Return if given facet is defined on type

isCode

virtual override Bool isCode()

Source

Return true

isEnum

Bool isEnum()

Source

Is an enum type

isErr

const Bool isErr

Source

Is this a subclass of sys::Err

isFacet

Bool isFacet()

Source

Is an facet type

isMixin

Bool isMixin()

Source

Is an mixin type

isNoDoc

const Bool isNoDoc

Source

Return true if annotated as NoDoc

loc

const DocLoc loc

Source

Source code location of this type definition

mixins

const DocTypeRef[] mixins

Source

Mixins directly implemented by this type

name

Str name()

Source

Simple name of the type such as "Str".

onCrawl

virtual override Void onCrawl(DocCrawler crawler)

Source

Index the type summary and all slot docs

pod

const DocPod pod

Source

Pod which defines this type

qname

Str qname()

Source

Qualified name formatted as "pod::name".

ref

const DocTypeRef ref

Source

Representation of this type definition as a reference

renderer

virtual override Type renderer()

Source

Default renderer is DocTypeRenderer

slot

DocSlot? slot(Str name, Bool checked := true)

Source

Get slot by name. If not found return null or raise UknownSlotErr

slots

const DocSlot[] slots

Source

List of the public, documented slots in this type (sorted).

space

virtual override DocSpace space()

Source

The space for this doc is pod

title

virtual override Str title()

Source

Title of the document is the qualified name

toStr

virtual override Str toStr()

Source

return qname