avail/avail.anvil.tasks/DocumentationTask

DocumentationTask

class DocumentationTask(val workbench: AvailWorkbench, targetModuleName: ResolvedModuleName?) : AvailWorkbench.AbstractWorkbenchTask

A DocumentationTask 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

fun DocumentationTask(workbench: AvailWorkbench, targetModuleName: ResolvedModuleName?)

Construct a new DocumentationTask.

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()

Properties

var progress: Int

propertyChangeSupport

val propertyChangeSupport: PropertyChangeSupport

val state: SwingWorker.StateValue

val workbench: AvailWorkbench

The owning AvailWorkbench.