quarkdown-core/com.quarkdown.core.function.library.module/QuarkdownModule

QuarkdownModule

class QuarkdownModule(functions: Set<ExportableFunction>) : Set<ExportableFunction>

A subsection of Quarkdown functions that can be exported via a MultiFunctionLibraryLoader.

While this class might seem redundant in place of a typealias, having an actual class makes it easier and more robust on Quarkdoc^1's side to identify modules.

^1: Quarkdoc is Quarkdown's documentation generator, based on Dokka. See the quarkdown-quarkdoc module.

Parameters

functions

the functions to export in the module

Constructors

QuarkdownModule

constructor(functions: Set<ExportableFunction>)

constructor(vararg modules: QuarkdownModule)

Creates a QuarkdownModule that wraps multiple QuarkdownModules, joining their functions into a single module. The identity of the submodules is lost in the process.

Properties

size

open override val size: Int

Functions

contains

open operator override fun contains(element: ExportableFunction): Boolean

containsAll

open override fun containsAll(elements: Collection<ExportableFunction>): Boolean

isEmpty

open override fun isEmpty(): Boolean

iterator

open operator override fun iterator(): Iterator<ExportableFunction>

plus

operator fun plus(other: QuarkdownModule): QuarkdownModule

wrappedAsValue

fun <T : OutputValue<*>> Set<T>.wrappedAsValue(): UnorderedCollectionValue<T>