stig-gradle-plugin/com.stigway.gradle.settings/GenerateHtmlDsl

GenerateHtmlDsl

Local HTML generation and preview configuration.

stigGenerateHtml remains a finite batch task. Gradle's global --continuous option controls whether it watches inputs and rebuilds. Its --serve task option starts or reuses the managed background preview server.

Constructors

GenerateHtmlDsl

constructor()

Properties

analysisInterfaceGrouping

var analysisInterfaceGrouping: InterfaceGrouping

Optional four presentation groups around interface analyses, including a message in empty groups.

enableModelListings

var enableModelListings: Boolean

Generate Markdown pages that reproduce the Kotlin viewpoint source files.

enableProjectWideFindings

var enableProjectWideFindings: Boolean

Include the merged findings table and per-viewpoint rule summaries in the project report.

markdownFormat

var markdownFormat: DocsFormat

Default stigGenerateMarkdown --format when the CLI option isn't given. Only affects stigGenerateMarkdown; stigGenerateHtml's own Dokka HTML output is unaffected by this switch.

modelTocLabels

var modelTocLabels: ModelLabelMode

Model table-of-contents labels in Dokka; the default displays short declaration identifiers.

navigationGroupNames

var navigationGroupNames: Map<ElementType, String>

Report navigation group names by element kind, for example COMPONENT to "nodes".

Functions

jwebserver

fun jwebserver(configure: JWebServerDsl.() -> Unit)

sourceLinks

fun sourceLinks(configure: SourceLinksDsl.() -> Unit)