abstract const class compilerDoc::DocSpace

sys::Obj
  compilerDoc::DocSpace

Source

DocSpace manages a namespace of documents. All documentation is organized into a two level namespace of "spaceName/docName".

breadcrumb

virtual Str breadcrumb()

Source

String to use for this space in the breadcrumb. By default this is the spaceName.

doc

abstract Doc? doc(Str docName, Bool checked := true)

Source

Lookup the document in this space. If not found raise UnknownDocErr or return null based on checked flag.

eachDoc

abstract Void eachDoc(|Doc| f)

Source

Iterate all the documents in this space.

spaceName

abstract Str spaceName()

Source

Get the name of this space which is unique with the environment.

toStr

virtual override Str toStr()

Source

Return spaceName by default