const class compilerDoc::DocChapter

sys::Obj
  compilerDoc::Doc
    compilerDoc::DocChapter

Source

DocChapter models a fandoc "chapter" in a manual like docLang

breadcrumb

virtual override Str breadcrumb()

Source

Use title for breadcrumb

doc

const DocFandoc doc

Source

Chapter contents as Fandoc string

docName

virtual override Str docName()

Source

Document name under space is same as name

heading

virtual override DocHeading? heading(Str id, Bool checked := true)

Source

Get a chapter heading by its anchor id or raise NameErr/return null.

headings

const DocHeading[] headings

Source

Top-level chapter headings

isPodDoc

Bool isPodDoc()

Source

Return if this chapter is the special "pod-doc" file

loc

const DocLoc loc

Source

Location for chapter file

meta

const Str:Str meta

Source

Fandoc heating metadata

name

const Str name

Source

Simple name of the chapter such as "Overview" or "pod-doc"

next

DocChapter? next()

Source

Next chapter in TOC order or null if last

num

Int num()

Source

Chapter number (one-based)

onCrawl

virtual override Void onCrawl(DocCrawler crawler)

Source

Index the chapter name and body

pod

const DocPod pod

Source

Pod which defines this chapter such as "docLang"

prev

DocChapter? prev()

Source

Previous chapter in TOC order or null if first

qname

const Str qname

Source

Qualified name as "pod::name"

renderer

virtual override Type renderer()

Source

Default renderer is DocChapterRenderer

space

virtual override DocSpace space()

Source

The space for this doc is pod

summary

Str summary()

Source

Summary for TOC

title

virtual override Str title()

Source

Title is meta.title, or qualified name if not specified.

toStr

virtual override Str toStr()

Source

Return qname