quarkdown-quarkdoc/com.quarkdown.quarkdoc.dokka.util

Package-level declarations

Properties

The paths to the source files of a documentable object.

fun Iterable<DPackage>.difference(others: Iterable<DPackage>): List<DPackage>

fun DokkaContext.documentableContentBuilder(documentable: Documentable, dri: Set<DRI>): PageContentBuilder.DocumentableContentBuilder

Creates a PageContentBuilder.DocumentableContentBuilder for the given Documentable.

inline fun <T> Documentable.extractAnnotation(): Annotations.Annotation?

inline fun <T> WithChildren<*>.findDeep(crossinline predicate: (T) -> Boolean = { true }): T?

Finds the first child of type T in the documentation tree, starting from this root.

inline fun <T> Documentable.hasAnnotation(): Boolean

inline fun <T> DRI.isOfType(): Boolean

fun DRI.isOfType(packageName: String, className: String): Boolean

fun <E : Enum<*>> Annotations.Annotation.parameterToEnumArray(paramName: String, valueOf: (String) -> E): List<E>

Converts the parameter of an annotation to a list of enums of type E using the provided valueOf function.

Creates an anchor element at documentation level for scraping purposes, which marks a specific section of documentation.

fun PageContentBuilder.DocumentableContentBuilder.scrapingAnchor(anchor: String)

Creates an anchor element at rendering level for scraping purposes, which marks a specific section of documentation.

fun <E : Enum<*>> EnumValue.toEnum(valueOf: (String) -> E): E

Converts an EnumValue to an enum of type E using the provided valueOf function.

fun <T : WithChildren<*>> T.tryCopy(newChildren: List<DocTag>): T

Attempts to copy the current instance of this with the new children provided.

fun <T : Any, W : WithExtraProperties<T>> W.withAddedExtra(vararg extra: ExtraProperty<T>): T

Appends the given extra property to the given object.