avail/avail.anvil.tasks/DocumentationTask

DocumentationTask

class DocumentationTask(val workbench: AvailWorkbench, targetModuleName: ResolvedModuleName) : AbstractWorkbenchModuleTask

An AbstractWorkbenchModuleTask that initiates and manages documentation generation for the target module.

Parameters

workbench

The owning AvailWorkbench.

targetModuleName

The resolved name of the target module to unload.

Constructors

DocumentationTask

constructor(workbench: AvailWorkbench, targetModuleName: ResolvedModuleName)

Construct a new DocumentationTask.

Properties

var progress: Int

propertyChangeSupport

val propertyChangeSupport: PropertyChangeSupport

val state: SwingWorker.StateValue

val workbench: AvailWorkbench

The owning AvailWorkbench.

Functions

addPropertyChangeListener

fun addPropertyChangeListener(p0: PropertyChangeListener)

fun cancel()

Cancel the current task.

override fun cancel(p0: Boolean): Boolean

firePropertyChange

fun firePropertyChange(p0: String, p1: Any, p2: Any)

override fun get(): Void

operator override fun get(p0: Long, p1: TimeUnit): Void

override fun isCancelled(): Boolean

override fun isDone(): Boolean

removePropertyChangeListener

fun removePropertyChangeListener(p0: PropertyChangeListener)

override fun run()