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.

Constructors

Link copied to clipboard
constructor(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)

Types

Link copied to clipboard
object Companion

Functions

Link copied to clipboard
fun componentIndex(root: Analysis, headingLevel: Int): String

Module folders provide the grouping; assessment arguments remain model-owned.

Link copied to clipboard
fun render(roots: List<MetamodelEntity>, rootHeadingLevel: Int = 2, includeChildAnalyses: Boolean = true): String
Generated with STIG