avail/avail.stacks

Package avail.stacks

Types

class CommentGroup

A grouping of AvailComments from an Avail module.

class LinkingFileMap

A holder for all categories in stacks

StacksDescription

class StacksDescription(descriptionTokens: List<AbstractStacksToken>)

A collection of tokens that make up a comment description.

class StacksErrorLog(outputPath: Path)

A Stacks log file that contains errors from processing comments in Avail modules.

class StacksFilename(val pathName: String, val leafFilename: String)

A Stacks file name and relative path

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.

StacksOutputFile

class StacksOutputFile constructor( val outputPath: Path, val synchronizer: StacksSynchronizer, fileName: String, runtime: AvailRuntime, val name: String)

The way a file is created.

class StacksParser

Parses a List of stacks tokens.

StacksSynchronizer

class StacksSynchronizer(workUnits: Int)

A way of abstracting out and passing around Asynchronous Continuations.