1.9.2

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

Result

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

Represents a scanned documentation resource.

Parameters

E

the type of DocsContentExtractor for the resource

Constructors

constructor(name: String, moduleName: String?, extractor: () -> E)

Properties

val extractor: () -> E

a supplier of a corresponding content extractor that can process the resource

val isInModule: Boolean

Whether this resource is part of a Quarkdown module of a user library.

val moduleName: String?

the name of the Quarkdown module containing the resource (e.g., "String"), if part of a module

val name: String

the name of the resource (e.g., "lowercase")