StacksGenerator

class StacksGenerator constructor(outputPath: Path, val resolver: ModuleNameResolver)

An Avail documentation generator. It takes tokenized method/class comments in .avail files and creates navigable documentation from them.

Richard Arriaga

outputPath

The path to the output directory for documentation and data files.

resolver

If the output path exists but does not specify a directory.

Constructors

constructor(outputPath: Path, resolver: ModuleNameResolver)

Construct a new StacksGenerator.

The error log file for the malformed comments.

fun add(header: ModuleHeader, commentTokens: A_Tuple)

Inform the generator about the documentation and linkage of a module.

fun clear()

Clear all internal data structures and reinitialize this StacksGenerator for subsequent usage.

fun generate(runtime: AvailRuntime, outermostModule: ModuleName)

Generate complete Stacks documentation.