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

Package-level declarations

Types

class StigDocumentableToPageTranslator(context: DokkaContext) : DocumentableToPageTranslator

Creates executable model pages at the declaration boundary, before Dokka resolves links or renders HTML.

data class StigDokkaConfiguration(val enabled: Boolean = false, val modelLibrary: Boolean = false, val modelTocLabels: ModelLabelMode = ModelLabelMode.ID, val analysisInterfaceGrouping: InterfaceGrouping = InterfaceGrouping.NONE, val navigationGroupNames: Map<ElementType, String> = emptyMap(), val modelDocumentationMode: String = "FULL", val modelDocumentationMaxTextLength: Int = -1, val modelDocumentationModes: Map<String, String> = emptyMap(), val modelDocumentationTextLimits: Map<String, Int> = emptyMap(), val review: ReviewConfig = ReviewConfig(), val reviewModuleId: String = "", val elementId: String = "", val preparedModelReportFile: String = "", val modelClasspath: List<String> = emptyList(), val modelOutputClasspath: List<String> = emptyList(), val modelModuleDirectories: Map<String, String> = emptyMap(), val logicalOwnerProjects: Map<String, String> = emptyMap(), val explicitContextModules: List<String> = emptyList(), val sourceRoots: List<String> = emptyList(), val documentationFiles: List<String> = emptyList(), val documentationModules: Map<String, String> = emptyMap(), val includeOrigins: Map<String, String> = emptyMap(), val moduleIntroSources: Map<String, String> = emptyMap(), val issuesFiles: List<String> = emptyList(), val modelCheckTable: String = "", val modelCheckDiagnostics: String = "", val inlineIssues: Boolean = true, val generatedSourceRoots: List<String> = emptyList(), val projectRoot: String = "", val elementDirectory: String = "", val viewSourceLinks: Boolean = true, val editSourceLinks: Boolean = false, val ideaSourceLinks: Boolean = true, val moduleQuickLinksEnabled: Boolean = false, val modulePackagePrefix: String = "", val moduleImagesPrefix: String = "", val moduleViewpointPathPrefix: String = "", val repos: List<StigDokkaRepoConfiguration> = emptyList()) : ConfigurableBlock

StigDokkaPlugin

class StigDokkaPlugin : DokkaPlugin

Dokka engine extension shipped inside the existing ai.exida.stig plugin artifact.

StigDokkaPluginParameters

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

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

StigDokkaRepoConfiguration

data class StigDokkaRepoConfiguration(val root: String = "", val remoteUrl: String = "", val remotePath: String = "", val commit: String = "", val sourceCommit: String = "", val codeBrowser: String = "AUTO", val editRef: String = "", val ideaOrigin: String = "")

StigModelPageTransformer

class StigModelPageTransformer(configuration: StigDokkaConfiguration, logger: DokkaLogger) : PageTransformer

Attaches prepared model trees to Kotlin declarations without loading executable models in Dokka workers.

StigReviewHtmlRenderer

class StigReviewHtmlRenderer(context: DokkaContext) : HtmlRenderer

Sanitizes model/document content before templating and emits the inventory of reviewable Kotlin targets.