pod compilerDoc

Compiler to model and generate API docs

Classes

DocChapter	DocChapter models a fandoc "chapter" in a manual like docLang
DocEnv	DocEnv is the centralized glue class for managing documentation modeling and rendering:
DocErrHandler	DocErrHandler is responsible for handling errors encountered during doc compilation including broken links and fandoc format errors.
DocFacet	DocFacet models the documentation of a `sys::Facet` on a type or slot.
DocFandoc	Fandoc string for a type or slot
DocField	DocField models the documentation of a `sys::Field`.
DocFlags	DocFlags models the flags used to annotate types and slots
DocHeading	DocHeader models a heading in a table of contents for pod/chapter.
DocLink	DocLink models a resolved URI - it is the result of `DocLinker`.
DocLinker	DocLinker is responsible for mapping shortcut URI syntax to the actual URI for their HTML page.
DocLoader	DocLoader is responsible for lazy loading:
DocLoc	DocLoc models a filename / linenumber
DocMethod	DocMethod models the documentation of a `sys::Method`.
DocParam	DocParam models the documentation of a `sys::Param`
DocPod	DocPod models the documentation of a `sys::Pod`.
DocRenderer	DocRenderer is base class for renders for various documentation pages for indices, types, etc.
DocSlot	DocSlot models the documentation of a `sys::Slot`.
DocType	DocType models the documentation of a `sys::Type`.
DocTypeRef	DocTypeRef models a type reference in a type or slot signature.
DocUtil	Utility functions useful for working with documentation
FileDocWriter	FileDocWriter
IndexRenderer	IndexRenderer renders main doc index.
Main	Main
ManualRenderer	ManualRenderer renders DocPod chapter content.
PageRenderer	PageRenderer renders complete HTML pages for doc models.
PodRenderer	PodRenderer renders the overview of pod contents.
TypeRenderer	TypeRenderer renders the API of a Fantom type modeled via `DocType`.

Errs

DocErr

DocErr models errors and their locations during doc compilation.