stig-engine/com.stigway.engine.docs

Package-level declarations

Types

data class AnalysisPageModel(val name: String, val description: String?, val interfacePointAnalyses: List<InterfacePointAnalysisPageModel>, val issues: List<String> = emptyList(), val sources: List<String> = emptyList(), val argument: String? = null, val evaluation: String? = null)

Rendering model for an analysis.md.kte page — one per Analysis-viewpoint element.

ContextPageModel

data class ContextPageModel(val name: String, val description: String?, val asil: String?, val includedInDesigns: List<String>, val issues: List<String> = emptyList(), val sources: List<String> = emptyList(), val interfacePoints: List<InterfacePointPageModel> = emptyList())

Rendering model for a context.md.kte page — one per Context-viewpoint element.

DesignPageModel

data class DesignPageModel(val name: String, val description: String?, val children: List<String>, val subDesigns: List<String>, val safetyMeasures: List<SafetyMeasurePageModel>, val issues: List<String> = emptyList(), val sources: List<String> = emptyList())

Rendering model for a design.md.kte page — one per Design-viewpoint element.

FailurePageModel

data class FailurePageModel(val anchor: String, val name: String, val description: String?, val asil: String?, val severity: String?, val multiplicity: String?, val comment: String?, val evaluation: String?, val propagatesTo: List<String>, val propagatedFrom: List<String>, val independentFailures: List<String>, val mitigatedBy: List<String>, val issues: List<String> = emptyList(), val sources: List<String> = emptyList(), val argument: String? = null)

Rendering model for one com.stigway.metamodels.highway.Failure within an analysis page.

GeneratedDocsLinkValidator

object GeneratedDocsLinkValidator

Glossary

data class Glossary(val entries: List<GlossaryEntry>)

GlossaryEntry

data class GlossaryEntry(val term: String, val paragraphs: List<String>)

InterfaceAnalysisGroup

enum InterfaceAnalysisGroup : Enum<InterfaceAnalysisGroup>

Stable presentation categories; unclassified interfaces follow the four directed categories.

InterfaceGrouping

enum InterfaceGrouping : Enum<InterfaceGrouping>

Optional presentation of existing interface-point analyses; model containment stays unchanged.

InterfacePointAnalysisPageModel

data class InterfacePointAnalysisPageModel(val anchor: String, val name: String, val description: String?, val asil: String?, val usedIn: List<String>, val uses: List<String>, val failures: List<FailurePageModel>, val depth: Int = 0, val issues: List<String> = emptyList(), val sources: List<String> = emptyList(), val argument: String? = null, val evaluation: String? = null, val interfacePoint: String? = null)

Rendering model for one com.stigway.metamodels.highway.InterfacePointAnalysis.

InterfacePointPageModel

data class InterfacePointPageModel(val anchor: String, val name: String, val description: String?, val asil: String?, val depth: Int, val analyses: List<String>, val uses: List<String> = emptyList(), val testedBy: List<String> = emptyList())

Declared interface point, including nested members, on its owning Context page.

MarkdownDocument

class MarkdownDocument(val text: String)

Authored page structure and explicit model insertion points, independent of the publishing format.

MarkdownText

object MarkdownText

Renders names as literal text; descriptions retain their authored Markdown.

MkDocsModelRenderer

class MkDocsModelRenderer(anchor: (MetamodelEntity) -> String, reference: (MetamodelEntity, String, MetamodelEntity, String) -> String, incoming: Map<MetamodelEntity, Map<Relation<*, *>, List<MetamodelEntity>>>, childAnalyses: (Analysis) -> List<Analysis> = { emptyList() }, modelTocLabels: ModelLabelMode = ModelLabelMode.ID, analysisModulePath: (Analysis) -> String = { "" }, analysisInterfaceGrouping: InterfaceGrouping = InterfaceGrouping.NONE, modelIndex: ModelIndex? = null)

A direct Markdown rendering of the same model tree and attributes used by Dokka.

ModelAnalysisIndex

class ModelAnalysisIndex(analyses: List<Analysis>, modulePath: (Analysis) -> String)

Enabled assessments follow element ancestry; presentation groups follow their actual module folders.

ModelCheckTableJson

object ModelCheckTableJson

Bounds display data; task-owned problems.jsonl records retain complete evidence.

ModelCheckTextBudget

object ModelCheckTextBudget

The shared text policy for display tables and IDE SARIF.

ModelIssueOccurrence

data class ModelIssueOccurrence(val id: String, val url: String, val entity: ModelReportLocation)

ModelLabelMode

enum ModelLabelMode : Enum<ModelLabelMode>

Visible model navigation labels; neither choice changes model identity or link targets.

ModelReportIndex

class ModelReportIndex

ModelReportLocation

data class ModelReportLocation(val entityId: String, val modulePath: String, val packageName: String, val rootName: String)

Declaration ownership shared by Markdown, issue inventories, and executable model pages.

RequirementPageModel

data class RequirementPageModel(val anchor: String, val name: String, val description: String?, val asil: String?, val verificationCriteria: String?, val allocatedTo: List<String>, val derivedFrom: List<String>, val derivesTo: List<String>, val verifiedBy: List<String>, val issues: List<String> = emptyList(), val sources: List<String> = emptyList())

Rendering model for one com.stigway.metamodels.highway.Requirement.

RequirementsPageModel

data class RequirementsPageModel(val name: String, val description: String?, val requirements: List<RequirementPageModel>, val issues: List<String> = emptyList(), val sources: List<String> = emptyList())

Rendering model for a requirements.md.kte page — one per Requirements-viewpoint container.

SafetyMeasurePageModel

data class SafetyMeasurePageModel(val anchor: String, val name: String, val description: String?, val asil: String?, val comment: String?, val mitigates: List<String>, val issues: List<String> = emptyList(), val sources: List<String> = emptyList())

Rendering model for one com.stigway.metamodels.highway.SafetyMeasure declared in a design.

StigAnalysisInterfaceGroups

object StigAnalysisInterfaceGroups

Presentation wrappers shared by the Markdown and HTML renderers; none are model entities.

StigAsilBadge

object StigAsilBadge

Single HTML representation of an ASIL used throughout generated STIG reports.

StigAttributeBadge

object StigAttributeBadge

Shared attribute HTML for Dokka and exported Markdown/MkDocs; the host can reference its sprite.

StigDocumentBoxKind

enum StigDocumentBoxKind : Enum<StigDocumentBoxKind>

Authored report callouts share their semantic colors and vector artwork across publishing formats.

StigGlossary

object StigGlossary

Authored native Writerside XML supplies both tooltips and the generated Markdown definition list.

StigModelDocumentation

object StigModelDocumentation

Model identity and attribute selection shared by the Dokka and MkDocs renderers.

StigModelLabels

object StigModelLabels

Display-only labels for executable-model documentation.

StigModelRelations

object StigModelRelations

Documentation labels and reverse navigation for the metamodel relation definitions.

TestCasePageModel

data class TestCasePageModel(val anchor: String, val name: String, val description: String?, val asil: String?, val elementsUnderTest: List<String>, val interfacesUnderTest: List<String>, val verifies: List<String>, val issues: List<String> = emptyList(), val sources: List<String> = emptyList())

Rendering model for one com.stigway.metamodels.highway.TestCase.

TestsPageModel

data class TestsPageModel(val name: String, val description: String?, val testCases: List<TestCasePageModel>, val issues: List<String> = emptyList(), val sources: List<String> = emptyList())

Rendering model for a tests.md.kte page — one per Tests-viewpoint container.

Properties

forwardLabel

val Relation<*, *>.forwardLabel: String

reverseLabel

val Relation<*, *>.reverseLabel: String

Functions

renderIssueMarkdown

fun renderIssueMarkdown(occurrences: List<ModelIssueOccurrence>): String

renderReference

fun <N> renderReference(entity: MetamodelEntity, badge: (ASIL) -> N, link: (String) -> N, name: (String) -> N, primary: (List<N>) -> N, inline: (List<N>) -> N): N

Render the linked object's metadata and resolved classification in the same order in every output format.

renderReferenceList

fun <N, L> renderReferenceList(entities: Collection<MetamodelEntity>, reference: (MetamodelEntity) -> N, list: (List<N>, Int) -> L): L

Use the same reference rendering and count for forward and reverse relation lists.