const class compilerDoc::DocPodIndex

sys::Obj
  compilerDoc::Doc
    compilerDoc::DocPodIndex

Source

DocPodIndex represents the index document of a DocPod.

docName

virtual override Str docName()

Source

The document name under space is "index"

isSpaceIndex

virtual override Bool isSpaceIndex()

Source

Return true

onCrawl

virtual override Void onCrawl(DocCrawler crawler)

Source

Index the type summary and all slot docs

pod

const DocPod pod

Source

Parent pod

renderer

virtual override Type renderer()

Source

Default renderer is DocPodIndexRenderer

space

virtual override DocSpace space()

Source

The space for this doc is pod

title

virtual override Str title()

Source

Title is pod name

toc

const Obj[] toc

Source

If this a API pod, this is the Str/DocType where the string indicates groupings such as "Classes", "Mixins", etc. If this is a manual return the list of Str/DocChapter where Str indicates index grouping headers.