Package org.jetbrains.dokka.model

Types

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

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

data class AncestryNode( val typeConstructor: TypeConstructor, val superclass: AncestryNode?, val interfaces: List<AncestryNode>)

AnnotationParameterValue

sealed class AnnotationParameterValue

Annotations

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

AnnotationTarget

interface AnnotationTarget

AnnotationValue

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

ArrayValue

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

BooleanConstant

data class BooleanConstant(val value: Boolean) : Expression

BooleanValue

data class BooleanValue(val value: Boolean) : LiteralValue

Bound

sealed class Bound : Projection

Callable

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

CheckedExceptions

data class CheckedExceptions(val exceptions: SourceSetDependent<List<DRI>>) : ExtraProperty<Documentable> , ExtraProperty.Key<Documentable, ObviousMember>

ClassKind

interface ClassKind

ClassValue

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

ComplexExpression

data class ComplexExpression(val value: String) : Expression

CompositeSourceSetID

data class CompositeSourceSetID(children: Set<DokkaSourceSetID>)

Contravariance

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

Covariance

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

DAnnotation

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

DClass

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

DClasslike

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

DefaultValue

class DefaultValue(val expression: SourceSetDependent<Expression>) : ExtraProperty<Documentable>

DefinitelyNonNullable

data class DefinitelyNonNullable(val inner: Bound) : Bound

It introduces definitely non-nullable types

DEnum

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

DEnumEntry

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

DFunction

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

DInterface

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

DisplaySourceSet

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

DModule

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

DObject

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

Documentable

abstract class Documentable : WithChildren<Documentable> , AnnotationTarget

DocumentableSource

interface DocumentableSource

DoubleConstant

data class DoubleConstant(val value: Double) : Expression

DoubleValue

data class DoubleValue(val value: Double) : LiteralValue

DPackage

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

DParameter

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

DProperty

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

DTypeAlias

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

DTypeParameter

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

Dynamic

object Dynamic : Bound

EnumValue

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

ExceptionInSupertypes

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

Expression

interface Expression

ExtraModifiers

sealed class ExtraModifiers

FloatConstant

data class FloatConstant(val value: Float) : Expression

FloatValue

data class FloatValue(val value: Float) : LiteralValue

FunctionalTypeConstructor

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

GenericTypeConstructor

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

ImplementedInterfaces

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

InheritedMember

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

IntegerConstant

data class IntegerConstant(val value: Long) : Expression

IntValue

data class IntValue(val value: Int) : LiteralValue

Invariance

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

IsVar

object IsVar : ExtraProperty<DProperty> , ExtraProperty.Key<DProperty, IsVar>

Whether this DProperty is var or val, should be present both in Kotlin and in Java properties

JavaClassKindTypes

enum JavaClassKindTypes : Enum<JavaClassKindTypes> , ClassKind

JavaModifier

sealed class JavaModifier : Modifier

JavaObject

data class JavaObject(val extra: PropertyContainer<JavaObject> = PropertyContainer.empty()) : Bound, AnnotationTarget, 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(val value: Long) : LiteralValue

Modifier

sealed class Modifier

Nullable

data class Nullable(val 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(val name: String, val extra: PropertyContainer<PrimitiveJavaType> = PropertyContainer.empty()) : Bound, AnnotationTarget, WithExtraProperties<PrimitiveJavaType>

Projection

sealed class Projection

SourceSetDependent

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

Star

object Star : Projection

StringConstant

data class StringConstant(val value: String) : Expression

StringValue

data class StringValue(val value: String) : LiteralValue

TypeAliased

data class TypeAliased( val typeAlias: Bound, val inner: Bound, val extra: PropertyContainer<TypeAliased> = PropertyContainer.empty()) : Bound, AnnotationTarget, WithExtraProperties<TypeAliased>

TypeConstructor

sealed class TypeConstructor : Bound, AnnotationTarget

TypeConstructorWithKind

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

TypeParameter

data class TypeParameter( val dri: DRI, val name: String, val presentableName: String? = null, val extra: PropertyContainer<TypeParameter> = PropertyContainer.empty()) : Bound, AnnotationTarget, WithExtraProperties<TypeParameter>

UnresolvedBound

data class UnresolvedBound(val name: String, val extra: PropertyContainer<UnresolvedBound> = PropertyContainer.empty()) : Bound, AnnotationTarget, WithExtraProperties<UnresolvedBound>

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?

isJvmField

fun DRI.isJvmField(): Boolean

fun Annotations.Annotation.isJvmField(): Boolean

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

JVM_FIELD_CLASS_NAMES

const val JVM_FIELD_CLASS_NAMES: String

JVM_FIELD_PACKAGE_NAME

const val JVM_FIELD_PACKAGE_NAME: String

sourceSetIDs

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