Package org.jetbrains.dokka.model

Types

ActualTypealias

data class ActualTypealias(underlyingType: SourceSetDependent<Bound>) : ExtraProperty<DClasslike>

AdditionalModifiers

class AdditionalModifiers(content: SourceSetDependent<Set<ExtraModifiers>>) : ExtraProperty<Documentable>

AnnotationParameterValue

sealed class AnnotationParameterValue

Annotations

data class Annotations(myContent: SourceSetDependent<List<Annotations.Annotation>>) : ExtraProperty<AnnotationTarget>

AnnotationTarget

interface AnnotationTarget

AnnotationValue

data class AnnotationValue(annotation: Annotations.Annotation) : AnnotationParameterValue

ArrayValue

data class ArrayValue(value: List<AnnotationParameterValue>) : AnnotationParameterValue

BooleanValue

data class BooleanValue(value: Boolean) : LiteralValue

Bound

sealed class Bound : Projection, AnnotationTarget

Callable

interface Callable : WithVisibility, WithType, WithAbstraction, WithSources, WithIsExpectActual

ClassKind

interface ClassKind

ClassValue

data class ClassValue(className: String, classDRI: DRI) : AnnotationParameterValue

CompositeSourceSetID

data class CompositeSourceSetID(children: Set<DokkaSourceSetID>)

ConstructorValues

data class ConstructorValues(values: SourceSetDependent<List<String>>) : ExtraProperty<DEnumEntry>

Contravariance

data class Contravariance<out T : Bound>(inner: T) : Variance<T>

Covariance

data class Covariance<out T : Bound>(inner: T) : Variance<T>

DAnnotation

data class DAnnotation(name: String, dri: DRI, documentation: SourceSetDependent<DocumentationNode>, expectPresentInSet: DokkaConfiguration.DokkaSourceSet?, sources: SourceSetDependent<DocumentableSource>, functions: List<DFunction>, properties: List<DProperty>, classlikes: List<DClasslike>, visibility: SourceSetDependent<Visibility>, companion: DObject?, constructors: List<DFunction>, generics: List<DTypeParameter>, sourceSets: Set<DokkaConfiguration.DokkaSourceSet>, isExpectActual: Boolean, extra: PropertyContainer<DAnnotation>) : DClasslike, WithCompanion, WithConstructors, WithExtraProperties<DAnnotation> , WithGenerics

DClass

data class DClass(dri: DRI, name: String, constructors: List<DFunction>, functions: List<DFunction>, properties: List<DProperty>, classlikes: List<DClasslike>, sources: SourceSetDependent<DocumentableSource>, visibility: SourceSetDependent<Visibility>, companion: DObject?, generics: List<DTypeParameter>, supertypes: SourceSetDependent<List<TypeConstructorWithKind>>, documentation: SourceSetDependent<DocumentationNode>, expectPresentInSet: DokkaConfiguration.DokkaSourceSet?, modifier: SourceSetDependent<Modifier>, sourceSets: Set<DokkaConfiguration.DokkaSourceSet>, isExpectActual: Boolean, extra: PropertyContainer<DClass>) : DClasslike, WithAbstraction, WithCompanion, WithConstructors, WithGenerics, WithSupertypes, WithExtraProperties<DClass>

DClasslike

sealed class DClasslike : Documentable, WithScope, WithVisibility, WithSources, WithIsExpectActual

DefaultValue

class DefaultValue(value: String) : ExtraProperty<Documentable>

DEnum

data class DEnum(dri: DRI, name: String, entries: List<DEnumEntry>, documentation: SourceSetDependent<DocumentationNode>, expectPresentInSet: DokkaConfiguration.DokkaSourceSet?, sources: SourceSetDependent<DocumentableSource>, functions: List<DFunction>, properties: List<DProperty>, classlikes: List<DClasslike>, visibility: SourceSetDependent<Visibility>, companion: DObject?, constructors: List<DFunction>, supertypes: SourceSetDependent<List<TypeConstructorWithKind>>, sourceSets: Set<DokkaConfiguration.DokkaSourceSet>, isExpectActual: Boolean, extra: PropertyContainer<DEnum>) : DClasslike, WithCompanion, WithConstructors, WithSupertypes, WithExtraProperties<DEnum>

DEnumEntry

data class DEnumEntry(dri: DRI, name: String, documentation: SourceSetDependent<DocumentationNode>, expectPresentInSet: DokkaConfiguration.DokkaSourceSet?, functions: List<DFunction>, properties: List<DProperty>, classlikes: List<DClasslike>, sourceSets: Set<DokkaConfiguration.DokkaSourceSet>, extra: PropertyContainer<DEnumEntry>) : Documentable, WithScope, WithExtraProperties<DEnumEntry>

DFunction

data class DFunction(dri: DRI, name: String, isConstructor: Boolean, parameters: List<DParameter>, documentation: SourceSetDependent<DocumentationNode>, expectPresentInSet: DokkaConfiguration.DokkaSourceSet?, sources: SourceSetDependent<DocumentableSource>, visibility: SourceSetDependent<Visibility>, type: Bound, generics: List<DTypeParameter>, receiver: DParameter?, modifier: SourceSetDependent<Modifier>, sourceSets: Set<DokkaConfiguration.DokkaSourceSet>, isExpectActual: Boolean, extra: PropertyContainer<DFunction>) : Documentable, Callable, WithGenerics, WithExtraProperties<DFunction>

DInterface

data class DInterface(dri: DRI, name: String, documentation: SourceSetDependent<DocumentationNode>, expectPresentInSet: DokkaConfiguration.DokkaSourceSet?, sources: SourceSetDependent<DocumentableSource>, functions: List<DFunction>, properties: List<DProperty>, classlikes: List<DClasslike>, visibility: SourceSetDependent<Visibility>, companion: DObject?, generics: List<DTypeParameter>, supertypes: SourceSetDependent<List<TypeConstructorWithKind>>, sourceSets: Set<DokkaConfiguration.DokkaSourceSet>, isExpectActual: Boolean, extra: PropertyContainer<DInterface>) : DClasslike, WithCompanion, WithGenerics, WithSupertypes, WithExtraProperties<DInterface>

DisplaySourceSet

data class DisplaySourceSet(sourceSetIDs: CompositeSourceSetID, name: String, platform: Platform) : SelfRepresentingSingletonSet<DisplaySourceSet>

DModule

data class DModule(name: String, packages: List<DPackage>, documentation: SourceSetDependent<DocumentationNode>, expectPresentInSet: DokkaConfiguration.DokkaSourceSet?, sourceSets: Set<DokkaConfiguration.DokkaSourceSet>, extra: PropertyContainer<DModule>) : Documentable, WithExtraProperties<DModule>

DObject

data class DObject(name: String?, dri: DRI, documentation: SourceSetDependent<DocumentationNode>, expectPresentInSet: DokkaConfiguration.DokkaSourceSet?, sources: SourceSetDependent<DocumentableSource>, functions: List<DFunction>, properties: List<DProperty>, classlikes: List<DClasslike>, visibility: SourceSetDependent<Visibility>, supertypes: SourceSetDependent<List<TypeConstructorWithKind>>, sourceSets: Set<DokkaConfiguration.DokkaSourceSet>, isExpectActual: Boolean, extra: PropertyContainer<DObject>) : DClasslike, WithSupertypes, WithExtraProperties<DObject>

Documentable

abstract class Documentable : WithChildren<Documentable> , AnnotationTarget

DocumentableSource

interface DocumentableSource

DoubleValue

data class DoubleValue(value: Double) : LiteralValue

DPackage

data class DPackage(dri: DRI, functions: List<DFunction>, properties: List<DProperty>, classlikes: List<DClasslike>, typealiases: List<DTypeAlias>, documentation: SourceSetDependent<DocumentationNode>, expectPresentInSet: DokkaConfiguration.DokkaSourceSet?, sourceSets: Set<DokkaConfiguration.DokkaSourceSet>, extra: PropertyContainer<DPackage>) : Documentable, WithScope, WithExtraProperties<DPackage>

DParameter

data class DParameter(dri: DRI, name: String?, documentation: SourceSetDependent<DocumentationNode>, expectPresentInSet: DokkaConfiguration.DokkaSourceSet?, type: Bound, sourceSets: Set<DokkaConfiguration.DokkaSourceSet>, extra: PropertyContainer<DParameter>) : Documentable, WithExtraProperties<DParameter> , WithType

DProperty

data class DProperty(dri: DRI, name: String, documentation: SourceSetDependent<DocumentationNode>, expectPresentInSet: DokkaConfiguration.DokkaSourceSet?, sources: SourceSetDependent<DocumentableSource>, visibility: SourceSetDependent<Visibility>, type: Bound, receiver: DParameter?, setter: DFunction?, getter: DFunction?, modifier: SourceSetDependent<Modifier>, sourceSets: Set<DokkaConfiguration.DokkaSourceSet>, generics: List<DTypeParameter>, isExpectActual: Boolean, extra: PropertyContainer<DProperty>) : Documentable, Callable, WithExtraProperties<DProperty> , WithGenerics

DTypeAlias

data class DTypeAlias(dri: DRI, name: String, type: Bound, underlyingType: SourceSetDependent<Bound>, visibility: SourceSetDependent<Visibility>, documentation: SourceSetDependent<DocumentationNode>, expectPresentInSet: DokkaConfiguration.DokkaSourceSet?, sourceSets: Set<DokkaConfiguration.DokkaSourceSet>, generics: List<DTypeParameter>, extra: PropertyContainer<DTypeAlias>) : Documentable, WithType, WithVisibility, WithExtraProperties<DTypeAlias> , WithGenerics

DTypeParameter

data class DTypeParameter(variantTypeParameter: Variance<TypeParameter>, documentation: SourceSetDependent<DocumentationNode>, expectPresentInSet: DokkaConfiguration.DokkaSourceSet?, bounds: List<Bound>, sourceSets: Set<DokkaConfiguration.DokkaSourceSet>, extra: PropertyContainer<DTypeParameter>) : Documentable, WithExtraProperties<DTypeParameter>

Dynamic

object Dynamic : Bound

EnumValue

data class EnumValue(enumName: String, enumDri: DRI) : AnnotationParameterValue

ExceptionInSupertypes

data class ExceptionInSupertypes(exceptions: SourceSetDependent<List<TypeConstructor>>) : ExtraProperty<Documentable>

ExtraModifiers

sealed class ExtraModifiers

FloatValue

data class FloatValue(value: Float) : LiteralValue

FunctionalTypeConstructor

data class FunctionalTypeConstructor(dri: DRI, projections: List<Projection>, isExtensionFunction: Boolean, isSuspendable: Boolean, presentableName: String?, extra: PropertyContainer<FunctionalTypeConstructor>) : TypeConstructor, WithExtraProperties<FunctionalTypeConstructor>

GenericTypeConstructor

data class GenericTypeConstructor(dri: DRI, projections: List<Projection>, presentableName: String?, extra: PropertyContainer<GenericTypeConstructor>) : TypeConstructor, WithExtraProperties<GenericTypeConstructor>

ImplementedInterfaces

data class ImplementedInterfaces(interfaces: SourceSetDependent<List<TypeConstructor>>) : ExtraProperty<Documentable>

InheritedMember

data class InheritedMember(inheritedFrom: SourceSetDependent<DRI?>) : ExtraProperty<Documentable>

IntValue

data class IntValue(value: Int) : LiteralValue

Invariance

data class Invariance<out T : Bound>(inner: T) : Variance<T>

JavaClassKindTypes

enum JavaClassKindTypes : Enum<JavaClassKindTypes> , ClassKind

JavaModifier

sealed class JavaModifier : Modifier

JavaObject

data class JavaObject(extra: PropertyContainer<JavaObject>) : Bound, WithExtraProperties<JavaObject>

JavaVisibility

sealed class JavaVisibility : Visibility

KotlinClassKindTypes

enum KotlinClassKindTypes : Enum<KotlinClassKindTypes> , ClassKind

KotlinModifier

sealed class KotlinModifier : Modifier

KotlinVisibility

sealed class KotlinVisibility : Visibility

LiteralValue

abstract class LiteralValue : AnnotationParameterValue

LongValue

data class LongValue(value: Long) : LiteralValue

Modifier

sealed class Modifier

Nullable

data class Nullable(inner: Bound) : Bound

NullValue

object NullValue : LiteralValue

ObviousMember

object ObviousMember : ExtraProperty<Documentable> , ExtraProperty.Key<Documentable, ObviousMember>

PrimaryConstructorExtra

object PrimaryConstructorExtra : ExtraProperty<DFunction> , ExtraProperty.Key<DFunction, PrimaryConstructorExtra>

PrimitiveJavaType

data class PrimitiveJavaType(name: String) : Bound

Projection

sealed class Projection

SourceSetDependent

typealias SourceSetDependent<T> = Map<DokkaConfiguration.DokkaSourceSet, T>

Star

object Star : Projection

StringValue

data class StringValue(value: String) : LiteralValue

TypeAliased

data class TypeAliased(typeAlias: Bound, inner: Bound) : Bound

TypeConstructor

sealed class TypeConstructor : Bound

TypeConstructorWithKind

data class TypeConstructorWithKind(typeConstructor: TypeConstructor, kind: ClassKind)

TypeParameter

data class TypeParameter(dri: DRI, name: String, presentableName: String?, extra: PropertyContainer<TypeParameter>) : Bound, WithExtraProperties<TypeParameter>

UnresolvedBound

data class UnresolvedBound(name: String) : Bound

Variance

sealed class Variance<out T : Bound> : Projection

Visibility

sealed class Visibility

Void

object Void : Bound

WithAbstraction

interface WithAbstraction

WithChildren

interface WithChildren<out T>

WithCompanion

interface WithCompanion

WithConstructors

interface WithConstructors

WithGenerics

interface WithGenerics

WithIsExpectActual

interface WithIsExpectActual

WithScope

interface WithScope

WithSources

interface WithSources

WithSupertypes

interface WithSupertypes

WithType

interface WithType

WithVisibility

interface WithVisibility

Functions

asPrintableTree

fun <T : WithChildren<T>> T.asPrintableTree(nodeNameBuilder: Appendable.(T) -> Unit = { append(it.toString()) }): String

childrenOfType

inline fun <T> WithChildren<*>.childrenOfType(): List<T>

dfs

fun <T : WithChildren<T>> T.dfs(predicate: (T) -> Boolean): T?

fun Documentable.dfs(predicate: (Documentable) -> Boolean): Documentable?

filter

fun DTypeParameter.filter(filteredSet: Set<DokkaConfiguration.DokkaSourceSet>): DTypeParameter?

filtered

fun <T> SourceSetDependent<T>.filtered(sourceSets: Set<DokkaConfiguration.DokkaSourceSet>): Map<DokkaConfiguration.DokkaSourceSet, T>

fun DokkaConfiguration.DokkaSourceSet?.filtered(sourceSets: Set<DokkaConfiguration.DokkaSourceSet>): DokkaConfiguration.DokkaSourceSet?

firstChildOfType

inline fun <T> WithChildren<*>.firstChildOfType(): T

inline fun <T> WithChildren<*>.firstChildOfType(predicate: (T) -> Boolean): T

firstChildOfTypeOrNull

inline fun <T> WithChildren<*>.firstChildOfTypeOrNull(): T?

inline fun <T> WithChildren<*>.firstChildOfTypeOrNull(predicate: (T) -> Boolean): T?

firstMemberOfType

inline fun <T : WithChildren<*>> WithChildren<WithChildren<*>>.firstMemberOfType(): T

inline fun <T : WithChildren<*>> WithChildren<WithChildren<*>>.firstMemberOfType(predicate: (T) -> Boolean): T

firstMemberOfTypeOrNull

inline fun <T : WithChildren<*>> WithChildren<WithChildren<*>>.firstMemberOfTypeOrNull(): T?

isJvmName

fun DRI.isJvmName(): Boolean

fun Annotations.Annotation.isJvmName(): Boolean

orEmpty

fun <T> SourceSetDependent<T>?.orEmpty(): SourceSetDependent<T>

plus

operator fun DokkaSourceSetID.plus(other: DokkaSourceSetID): CompositeSourceSetID

toAdditionalModifiers

fun SourceSetDependent<Set<ExtraModifiers>>.toAdditionalModifiers(): AdditionalModifiers

toAnnotations

fun SourceSetDependent<List<Annotations.Annotation>>.toAnnotations(): Annotations

toDisplaySourceSet

fun DokkaConfiguration.DokkaSourceSet.toDisplaySourceSet(): DisplaySourceSet

toDisplaySourceSets

fun Iterable<DokkaConfiguration.DokkaSourceSet>.toDisplaySourceSets(): Set<DisplaySourceSet>

withDescendants

fun <T : WithChildren<T>> T.withDescendants(): Sequence<T>

@JvmName(name = withDescendantsProjection)

fun WithChildren<*>.withDescendants(): Sequence<Any?>

@JvmName(name = withDescendantsAny)

fun WithChildren<Any>.withDescendants(): Sequence<Any>

withDri

fun Variance<TypeParameter>.withDri(dri: DRI): Variance<TypeParameter>

Properties

sourceSetIDs

val Iterable<DisplaySourceSet>.sourceSetIDs: List<DokkaSourceSetID>