Fantom

 

mixin

docCompiler::DocCompilerSupport

sys::Obj
  docCompiler::DocCompilerSupport

DocCompilerSupport provides lots of convenience methods for classes used during the documentation compiler pipeline.

Slots

bombIfErrSource

Void bombIfErr()

If any errors are accumulated, then throw the last one

compilerSource

abstract DocCompiler compiler()

Parent compiler instance

docsrcSource

Bool docsrc()

Return if we should be generating source code documentation.

errSource

virtual CompilerErr err(Str msg, Loc loc)

Create, log, and return a CompilerErr.

errReportSource

CompilerErr errReport(CompilerErr e)

Log, store, and return the specified CompilerErr.

logSource

CompilerLog log()

Convenience for compiler.log

showByDefaultSource

Bool showByDefault(Type t, Slot s)

showSlotSource

Bool showSlot(Type t, Slot s)

showTypeSource

Bool showType(Type t)

warnSource

CompilerErr warn(Str msg, Loc loc)

Create, log, and return a warning CompilerErr.