stig-gradle-plugin/com.stigway.gradle.dokka/StigDokkaPluginParameters

StigDokkaPluginParameters

abstract class StigDokkaPluginParameters @Inject constructor(name: String) : DokkaPluginParametersBaseSpec

Gradle-side, cacheable parameters passed to StigDokkaPlugin in Dokka's worker.

Constructors

Link copied to clipboard
@Inject
constructor(name: String)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
@get:Input
abstract val analysisInterfaceGrouping: Property<String>
Link copied to clipboard
@get:InputFiles
@get:PathSensitive(value = PathSensitivity.RELATIVE)
abstract val documentationFiles: ConfigurableFileCollection
Link copied to clipboard
@get:Input
abstract val documentationModules: MapProperty<String, String>
Link copied to clipboard
@get:Input
abstract val editSourceLinks: Property<Boolean>
Link copied to clipboard
@get:Input
abstract val elementDirectory: Property<String>
Link copied to clipboard
@get:Input
abstract val elementId: Property<String>
Link copied to clipboard
@get:Input
abstract val enabled: Property<Boolean>
Link copied to clipboard
@get:Input
abstract val explicitContextModules: ListProperty<String>
Link copied to clipboard
@get:Input
abstract val generatedSourceRoots: ListProperty<String>
Link copied to clipboard
@get:Input
abstract val ideaSourceLinks: Property<Boolean>
Link copied to clipboard
@get:Input
abstract val includeOrigins: MapProperty<String, String>
Link copied to clipboard
@get:Input
abstract val inlineIssues: Property<Boolean>
Link copied to clipboard
@get:InputFiles
@get:PathSensitive(value = PathSensitivity.RELATIVE)
abstract val issuesFiles: ConfigurableFileCollection
Link copied to clipboard
@get:Input
abstract val logicalOwnerProjects: MapProperty<String, String>
Link copied to clipboard
@get:Input
abstract val modelCheckDiagnostics: Property<String>
Link copied to clipboard
@get:Input
abstract val modelCheckTable: Property<String>
Link copied to clipboard
@get:Classpath
abstract val modelClasspath: ConfigurableFileCollection
Link copied to clipboard
@get:Input
abstract val modelDocumentationMaxTextLength: Property<Int>
Link copied to clipboard
@get:Input
abstract val modelDocumentationMode: Property<String>
Link copied to clipboard
@get:Input
abstract val modelDocumentationModes: MapProperty<String, String>
Link copied to clipboard
@get:Input
abstract val modelDocumentationTextLimits: MapProperty<String, Int>
Link copied to clipboard
@get:Input
abstract val modelLibrary: Property<Boolean>
Link copied to clipboard
@get:Input
abstract val modelModuleDirectories: MapProperty<String, String>
Link copied to clipboard
@get:Classpath
abstract val modelOutputClasspath: ConfigurableFileCollection
Link copied to clipboard
@get:Input
abstract val modelTocLabels: Property<String>
Link copied to clipboard
@get:Input
abstract val moduleImagesPrefix: Property<String>
Link copied to clipboard
@get:Input
abstract val moduleIntroSources: MapProperty<String, String>
Link copied to clipboard
@get:Input
abstract val modulePackagePrefix: Property<String>
Link copied to clipboard
@get:Input
abstract val moduleQuickLinksEnabled: Property<Boolean>
Link copied to clipboard
@get:Input
abstract val moduleViewpointPathPrefix: Property<String>
Link copied to clipboard
@get:Input
open val name: String
Link copied to clipboard
@get:Input
abstract val navigationGroupNames: MapProperty<String, String>
Link copied to clipboard
@get:Input
open val pluginFqn: String
Link copied to clipboard
@get:InputFile
@get:Optional
@get:PathSensitive(value = PathSensitivity.RELATIVE)
abstract val preparedModelReportFile: RegularFileProperty
Link copied to clipboard
@get:Input
abstract val projectRoot: Property<String>
Link copied to clipboard
@get:Input
abstract val repoCodeBrowsers: ListProperty<String>
Link copied to clipboard
@get:Input
abstract val repoCommits: ListProperty<String>
Link copied to clipboard
@get:Input
abstract val repoEditRefs: ListProperty<String>
Link copied to clipboard
@get:Input
abstract val repoIdeaOrigins: ListProperty<String>
Link copied to clipboard
@get:Input
abstract val repoRemotePaths: ListProperty<String>
Link copied to clipboard
@get:Input
abstract val repoRemoteUrls: ListProperty<String>
Link copied to clipboard
@get:Input
abstract val repoRoots: ListProperty<String>
Link copied to clipboard
@get:Input
abstract val repoSourceCommits: ListProperty<String>
Link copied to clipboard
@get:Input
abstract val reviewConfiguration: Property<String>
Link copied to clipboard
@get:Input
abstract val reviewModuleId: Property<String>
Link copied to clipboard
@get:InputFiles
@get:PathSensitive(value = PathSensitivity.RELATIVE)
abstract val sourceRoots: ConfigurableFileCollection
Link copied to clipboard
@get:Input
abstract val viewSourceLinks: Property<Boolean>

Functions

Link copied to clipboard
@Input
open override fun getName(): String
Link copied to clipboard
open override fun jsonEncode(): String
Generated by Dokka
© 2026 Copyright