stig-engine/com.stigway.engine.commands.generatedocs/GenerateDocsRequest

GenerateDocsRequest

data class GenerateDocsRequest(val projectRoot: Path, val elementDir: Path, val format: DocsFormat, val outputDir: Path, val viewpoints: List<String> = emptyList(), val includeSourceCode: Boolean = false, val updateNavigation: Boolean = true, val navigationFile: Path? = null)

Constructors

GenerateDocsRequest

constructor(projectRoot: Path, elementDir: Path, format: DocsFormat, outputDir: Path, viewpoints: List<String> = emptyList(), includeSourceCode: Boolean = false, updateNavigation: Boolean = true, navigationFile: Path? = null)

Properties

elementDir

val elementDir: Path

format

val format: DocsFormat

includeSourceCode

val includeSourceCode: Boolean

navigationFile

val navigationFile: Path?

outputDir

val outputDir: Path

projectRoot

val projectRoot: Path

updateNavigation

val updateNavigation: Boolean

viewpoints

val viewpoints: List<String>