abstract const class compilerDoc::Doc

sys::Obj
  compilerDoc::Doc

Source

Doc is the base class for document types. All Docs are organized under a DocSpace for a two level namespace of "spaceName/docName".

Subclasses include:

• DocPodIndex: pod index
• DocType: type API
• DocChapter: chapter in manual
• DocRes: resource file
• DocSrc: source file

breadcrumb

virtual Str breadcrumb()

Source

String to use for this document in the breadcrumb. By default this is the docName.

docName

abstract Str docName()

Source

Name which uniquely identifies this document under its space.

heading

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

Source

Get a chapter heading for this document by its anchor id

isCode

virtual Bool isCode()

Source

Should links to this document be formatted as code identifier

isSpaceIndex

virtual Bool isSpaceIndex()

Source

Return if this is the index document of the space.

isTopIndex

virtual Bool isTopIndex()

Source

Convenience to check if this is top-level index document. Top index often requires a bit of special handling since it lives a level above the standard two level namespace.

onCrawl

virtual Void onCrawl(DocCrawler crawler)

Source

Callback to handle a search engine crawl over this document. Call one of the addX methods on the crawler for each chunk of text in the document to be indexed.

renderer

abstract Type renderer()

Source

Get the default DocRenderer type to use for renderering this document.

space

abstract DocSpace space()

Source

Space which contains this document

title

abstract Str title()

Source

Default title for the document

toStr

virtual override Str toStr()

Source

Return docName by default