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

Package-level declarations

Types

data class PreparedModelReportModule(val check: ModelCheckModule, val reportConfiguration: String, val contextModules: List<String>, val sourceRoots: List<String>, val remediationReference: String, val viewpoints: List<String>, val checks: ModelCheckMode, val reportFormat: String) : Serializable

Captured module settings; preparing a report does not retain Gradle projects or task instances.

StigAggregateProblemsSarifTask

@DisableCachingByDefault(because = "Canonical problem aggregation is fast and must reflect the current report run.")

abstract class StigAggregateProblemsSarifTask : DefaultTask

Root IDE SARIF view derived from every registered task-owned canonical problem file.

StigCollectAnalysisStatisticsTask

@DisableCachingByDefault(because = "Aggregates local measurement provenance and partial execution records.")

abstract class StigCollectAnalysisStatisticsTask : DefaultTask

Collects explicit producer outputs; deliberately has no dependency that launches native analysis.

StigGenerateDiagramAppendixTask

@CacheableTask

abstract class StigGenerateDiagramAppendixTask : DefaultTask, StigProblemProducerTask

Emits a supplementary markdown file (diagrams.md) listing every diagram produced by com.stigway.gradle.tasks.analysis.StigAnalysisP7GenerateDiagramsTask, with headings that mirror the 5-axis directory structure 1-to-1 (analysis_type / depth / merge_mode / diagram_type / summary_type).

StigGenerateHtmlPipelineStartTask

@DisableCachingByDefault(because = "Reads live Git worktree state and logs invocation timing.")

abstract class StigGenerateHtmlPipelineStartTask : DefaultTask

Invocation-start logging owner and opt-in source-cleanliness gate for HTML generation and publication.

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.

StigGenerateMarkdownTask

@DisableCachingByDefault(because = "Generates documentation in place; not audited for cache correctness.")

abstract class StigGenerateMarkdownTask : DefaultTask

Generates Markdown documentation for a single element (viewpoint pages, metric tables, direct P7 diagram links, and known-gap sections).

StigListProblemsTask

@DisableCachingByDefault(because = "A listing task must print current results on every invocation.")

abstract class StigListProblemsTask : DefaultTask

StigPrepareModelReportTask

@DisableCachingByDefault(because = "Prepared reports contain checkout-specific source and review links.")

abstract class StigPrepareModelReportTask : DefaultTask

Loads the selected compiled model once for checks, Markdown indices, and Dokka model content.

StigPreparePublishedHtmlVersionsTask

@DisableCachingByDefault(because = "Reads mutable Git remote state; a cached archive could omit a published version.")

abstract class StigPreparePublishedHtmlVersionsTask : DefaultTask

Reads the Pages branch and prepares the flat release archive consumed by Dokka versioning.

StigPrepareReviewAssetsTask

@CacheableTask

abstract class StigPrepareReviewAssetsTask : DefaultTask

Generates non-secret browser settings as part of HTML generation. Reviewing itself is a browser operation.

StigPublishHtmlTask

@DisableCachingByDefault(because = "Interacts with Git state and remote pushes; not cacheable.")

abstract class StigPublishHtmlTask : DefaultTask

Publishes one current Dokka report plus every retained release through a single-commit Pages branch.

StigStopHtmlServerTask

@DisableCachingByDefault(because = "Stops a local server process; there is no cacheable output.")

abstract class StigStopHtmlServerTask : DefaultTask

Stops the managed background preview server for this project, if one is running.