StacksOutputFile

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

The way a file is created.

Author

Richard Arriaga

Parameters

outputPath

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

fileName

The name of the new file

synchronizer

The StacksSynchronizer used to control the creation of Stacks documentation

runtime
name

The name of the method the file represents as it is represented from the point of view of the main module being documented.

Throws

Constructors

Link copied to clipboard
fun StacksOutputFile(    outputPath: Path,     synchronizer: StacksSynchronizer,     fileName: String,     runtime: AvailRuntime,     name: String)

Construct a new StacksOutputFile.

Functions

Link copied to clipboard
fun file(): AsynchronousFileChannel
Link copied to clipboard
fun write(outputText: String)

Write text to a file.

Properties

Link copied to clipboard
val name: String

The name of the method the file represents as it is represented from the point of view of the main module being documented.

Link copied to clipboard
val outputPath: Path

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

Link copied to clipboard
val synchronizer: StacksSynchronizer

The StacksSynchronizer used to control the creation of Stacks documentation