quarkdown-quarkdoc-reader/com.quarkdown.quarkdoc.reader/DocsWalker

DocsWalker

interface DocsWalker<E : DocsContentExtractor>

A scanner of documentation resources.

Type Parameters

E

the type of DocsContentExtractor for each scanned resource

See also

com.quarkdown.quarkdoc.reader.dokka.DokkaHtmlWalker

Inheritors

DocsIndexWalker

Types

data class Result<E : DocsContentExtractor>(val name: String, val moduleName: String?, val extractor: () -> E)

Represents a scanned documentation resource.

Functions

abstract fun walk(): Sequence<DocsWalker.Result<E>>

Scans documentation resources.