stig-engine/com.stigway.engine.docs/GeneratedDocsLinkValidator

GeneratedDocsLinkValidator

object GeneratedDocsLinkValidator

Types

BrokenReference

data class BrokenReference(val source: Path, val kind: String, val url: String, val reason: String, val resolved: Path? = null)

data class Result(val checkedFiles: Int, val checkedReferences: Int, val brokenReferences: List<GeneratedDocsLinkValidator.BrokenReference>)

Functions

validateGeneratedMarkdown

fun validateGeneratedMarkdown(markdownFiles: Iterable<Path>, generatedResourceRoots: Iterable<Path> = emptyList()): GeneratedDocsLinkValidator.Result

validateHtmlSite

fun validateHtmlSite(siteRoot: Path): GeneratedDocsLinkValidator.Result