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

DocsWalker

interface DocsWalker<E : DocsContentExtractor>

A scanner of documentation resources.

Parameters

E

the type of DocsContentExtractor for each scanned resource

See also

Inheritors

Types

Link copied to clipboard
data class Result<E : DocsContentExtractor>(val name: String, val moduleName: String, val extractor: () -> E)

Represents a scanned documentation resource.

Functions

Link copied to clipboard
abstract fun walk(): Sequence<DocsWalker.Result<E>>

Scans documentation resources.