core/org.jetbrains.dokka.plugability

Package-level declarations

Types

ConfigurableBlock

interface ConfigurableBlock

interface DokkaContext

DokkaContextConfiguration

fun interface DokkaContextConfiguration

DokkaJavaPlugin

abstract class DokkaJavaPlugin : DokkaPlugin

abstract class DokkaPlugin

DokkaPluginApiPreview

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.FIELD])

annotation class DokkaPluginApiPreview

class ExtendingDSL(pluginClass: String, extensionName: String)

class Extension<T : Any, Ordering : OrderingKind, Override : OverrideKind>

ExtensionBuilder

data class ExtensionBuilder<T : Any>

ExtensionBuilderStart

class ExtensionBuilderStart

data class ExtensionPoint<T : Any>

annotation class ExtensionsDsl

sealed class OrderingKind

sealed class OverrideKind

PluginApiPreviewAcknowledgement

object PluginApiPreviewAcknowledgement

Acknowledgement for empty methods that inform users about DokkaPluginApiPreview Also, it allows to not propagates the annotation in IDE by default when a user autogenerate methods.

ProvidedExtension

class ProvidedExtension<T : Any>

WithUnsafeExtensionSuppression

interface WithUnsafeExtensionSuppression

Functions

inline fun <T : DokkaPlugin, R : ConfigurableBlock> configuration(context: DokkaContext): R?

inline fun <T : DokkaPlugin> DokkaContext.plugin(): T

inline fun <P : DokkaPlugin, E : Any> P.query(extension: P.() -> ExtensionPoint<E>): List<E>

inline fun <P : DokkaPlugin, E : Any> P.querySingle(extension: P.() -> ExtensionPoint<E>): E

throwIllegalQuery

fun throwIllegalQuery(): Nothing