stig-gradle-plugin/com.stigway.gradle.tasks.docs/StigGenerateHtmlTask

StigGenerateHtmlTask

@DisableCachingByDefault(because = "Validates another task's Dokka output and may manage a local server process.")

abstract class StigGenerateHtmlTask : DefaultTask

Finite HTML-generation lifecycle task with an optional managed background preview server.

Constructors

constructor()

Types

Companion

object Companion

Properties

actions

open var actions: List<Action<in Task?>?>?

ant

open val ant: AntBuilder?

asDynamicObject

@get:Internal

open val asDynamicObject: DynamicObject

bindAddress

@get:Input

abstract val bindAddress: Property<String>

configuredPort

@get:Input

abstract val configuredPort: Property<Int>

continuousMode

@get:Internal

abstract val continuousMode: Property<Boolean>

dependsOn

open val dependsOn: Set<Any?>?

description

open var description: @Nullable String?

destroyables

open val destroyables: TaskDestroyables?

didWork

open var didWork: Boolean

enabled

open var enabled: Boolean

excludedModules

@get:Input

abstract val excludedModules: ListProperty<String>

extensions

open val extensions: ExtensionContainer?

finalizedBy

open val finalizedBy: TaskDependency?

group

open var group: @Nullable String?

htmlDirectory

@get:InputDirectory

@get:PathSensitive(value = PathSensitivity.RELATIVE)

abstract val htmlDirectory: DirectoryProperty

identityPath

open val identityPath: Path?

impliesSubProjects

open var impliesSubProjects: Boolean

inlineIssues

@get:Input

abstract val inlineIssues: Property<Boolean>

Show issue summaries and viewer links in module and project pages; otherwise link to the Issues page.

inputs

open val inputs: TaskInputsInternal?

isCompatibleWithConfigurationCache

open val isCompatibleWithConfigurationCache: Boolean

isEnabled

@get:Internal

open var isEnabled: Boolean

isHasCustomActions

open val isHasCustomActions: Boolean

lifecycleDependencies

@get:Internal

open val lifecycleDependencies: TaskDependencyInternal?

localState

open val localState: TaskLocalState?

logger

open val logger: Logger?

logging

open val logging: LoggingManager?

loggingManager

open val loggingManager: @Nullable LoggingManagerInternal?

mustRunAfter

open val mustRunAfter: TaskDependency?

name

open val name: String?

onlyIf

open val onlyIf: Spec<in TaskInternal?>?

outputManifestFile

@get:OutputFile

abstract val outputManifestFile: RegularFileProperty

Exact hashed inventory consumed by StigPublishHtmlTask.

outputs

open val outputs: TaskOutputsInternal?

path

open val path: String?

previewServerEnabled

@get:Input

abstract val previewServerEnabled: Property<Boolean>

project

open val project: Project?

reasonNotToTrackState

open val reasonNotToTrackState: Optional<String?>?

reasonsNotToTrackState

open val reasonsNotToTrackState: Set<String?>?

reasonTaskIsIncompatibleWithConfigurationCache

open val reasonTaskIsIncompatibleWithConfigurationCache: Optional<String?>?

requiredServices

open val requiredServices: TaskRequiredServices?

serve

@get:Input

abstract val serve: Property<Boolean>

servePortOverride

@get:Input

@get:Optional

abstract val servePortOverride: Property<Int>

serverStateDirectory

@get:Internal

abstract val serverStateDirectory: DirectoryProperty

sharedResources

open val sharedResources: List<ResourceLock?>?

shouldRunAfter

open val shouldRunAfter: TaskDependency?

standardOutputCapture

open val standardOutputCapture: StandardOutputCapture?

state

open val state: TaskStateInternal?

stopTaskPath

@get:Internal

abstract val stopTaskPath: Property<String>

taskActions

open val taskActions: List<InputChangesAwareTaskAction?>?

taskDependencies

open val taskDependencies: TaskDependencyInternal?

taskIdentity

open val taskIdentity: TaskIdentity<*>?

temporaryDir

open val temporaryDir: File?

temporaryDirFactory

open val temporaryDirFactory: Factory<File?>?

timeout

open val timeout: Property<Duration?>?

Functions

acceptServiceReferences

open fun acceptServiceReferences(serviceReferences: Set<ServiceReferenceSpec?>?)

appendParallelSafeAction

open fun appendParallelSafeAction(action: Action<in Task?>?)

compareTo

open operator fun compareTo(otherTask: Task?): Int

configure

open fun configure(closure: Closure<*>?): Task?

dependsOn

open fun dependsOn(vararg paths: Any?): Task?

doFirst

open fun doFirst(action: Closure<*>?): Task?

open fun doFirst(action: Action<in Task?>?): Task?

open fun doFirst(actionName: String?, action: Action<in Task?>?): Task?

doLast

open fun doLast(action: Closure<*>?): Task?

open fun doLast(action: Action<in Task?>?): Task?

open fun doLast(actionName: String?, action: Action<in Task?>?): Task?

doNotTrackState

open fun doNotTrackState(reasonNotToTrackState: String?)

doNotTrackStateIf

open fun doNotTrackStateIf(reason: String?, spec: Spec<in TaskInternal?>?)

enableServing

fun enableServing()

finalizedBy

open fun finalizedBy(vararg paths: Any?): Task?

hasProperty

open fun hasProperty(propertyName: String?): Boolean

hasTaskActions

open fun hasTaskActions(): Boolean

mustRunAfter

open fun mustRunAfter(vararg paths: Any?): Task?

notCompatibleWithConfigurationCache

open fun notCompatibleWithConfigurationCache(reason: String?)

onlyIf

open fun onlyIf(onlyIfClosure: Closure<*>?)

open fun onlyIf(spec: Spec<in Task?>?)

open fun onlyIf(onlyIfReason: String?, spec: Spec<in Task?>?)

prependParallelSafeAction

open fun prependParallelSafeAction(action: Action<in Task?>?)

property

open fun property(propertyName: String?): Any?

restoreOnlyIf

open fun restoreOnlyIf(onlyIf: Spec<in TaskInternal?>?)

restoreTaskActions

open fun restoreTaskActions(taskActions: List<InputChangesAwareTaskAction?>?)

setDependsOn

open fun setDependsOn(dependsOn: Iterable<*>?)

setFinalizedBy

open fun setFinalizedBy(finalizedByTasks: Iterable<*>?)

setMustRunAfter

open fun setMustRunAfter(mustRunAfterTasks: Iterable<*>?)

setOnlyIf

open fun setOnlyIf(onlyIfClosure: Closure<*>?)

open fun setOnlyIf(spec: Spec<in Task?>?)

open fun setOnlyIf(onlyIfReason: String?, spec: Spec<in Task?>?)

setProperty

open fun setProperty(name: String?, value: Any?)

setServePort

fun setServePort(value: String)

setShouldRunAfter

open fun setShouldRunAfter(shouldRunAfterTasks: Iterable<*>?)

shouldRunAfter

open fun shouldRunAfter(vararg paths: Any?): TaskDependency?

usesService

open fun usesService(service: Provider<out BuildService<*>?>?)