stig-gradle-plugin/com.stigway.gradle.support.report

Package-level declarations

Types

data class ModelAliasCandidate(val entityId: String, val declaration: ModelDeclaration?, val runtimeType: ModelDeclaration)

ModelContent

data class ModelContent(val kind: ModelContentKind, val children: List<ModelContent> = emptyList(), val declarations: Set<ModelDeclaration> = emptySet(), val styles: Set<ModelContentStyle> = emptySet(), val attributes: Map<String, String> = emptyMap(), val text: String = "", val html: Boolean = false, val headingLevel: Int = 0, val tableHeader: List<ModelContent> = emptyList(), val declarationLink: ModelDeclaration? = null, val pageLink: ModelPageLink? = null, val symbolAnchor: String? = null)

A value-only document tree: no compiled entities, reflective fields, classloaders or Dokka objects.

ModelContentKind

enum ModelContentKind : Enum<ModelContentKind>

ModelContentStyle

enum ModelContentStyle : Enum<ModelContentStyle>

ModelDeclaration

data class ModelDeclaration(val packageName: String? = null, val classNames: String? = null, val property: String? = null)

Only declaration coordinates cross the preparation boundary; Dokka binds them to real source sets.

ModelPageLink

data class ModelPageLink(val sourceModule: String, val sourcePackage: String, val targetModule: String, val targetPackage: String, val rootName: String, val anchor: String)

ModelReportPreparation

class ModelReportPreparation

Shared indexes live only inside the owning compiled-model session, before immutable files are emitted.

PreparedModelInsertion

data class PreparedModelInsertion(val source: String, val kind: String, val headingLevel: Int, val content: List<ModelContent>)

PreparedModelModule

data class PreparedModelModule(val formatVersion: Int = FORMAT_VERSION, val modulePath: String, val navigation: PreparedModelNavigation, val contextPackages: Set<String>, val roots: List<PreparedModelRoot>, val insertions: List<PreparedModelInsertion>)

PreparedModelNavigation

data class PreparedModelNavigation(val projectPath: String, val group: String, val level: Int, val visible: Boolean = true, val groupName: String = group)

PreparedModelRoot

data class PreparedModelRoot(val name: String, val entityId: String, val packageName: String, val declaration: ModelDeclaration, val sourceDeclaration: ModelDeclaration?, val aliasCandidates: List<ModelAliasCandidate>, val content: ModelContent)

StigModelReportConfiguration

data class StigModelReportConfiguration(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 logicalOwnerProjects: Map<String, String> = emptyMap(), val publishedModules: Set<String> = emptySet(), val sourceRoots: List<String> = emptyList(), val documentationFiles: List<String> = emptyList(), val generatedSourceRoots: List<String> = emptyList(), val viewSourceLinks: Boolean = true, val editSourceLinks: Boolean = false, val ideaSourceLinks: Boolean = true, val moduleViewpointPathPrefix: String = "", val repos: List<StigModelReportRepoConfiguration> = emptyList())

Rendering inputs independent of Dokka's worker and its plugin configuration types.

StigModelReportRepoConfiguration

data class StigModelReportRepoConfiguration(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 = "")

StigPreparedModelPages

object StigPreparedModelPages

Projects a shared live model into immutable module documents without loading it again.