javadoc/org.jetbrains.dokka.javadoc.pages

Package-level declarations

Types

AllClassesPage

class AllClassesPage(val classes: List<JavadocClasslikePageNode>) : JavadocPageNode

AllClassesPageInstaller

object AllClassesPageInstaller : PageTransformer

AnchorableJavadocNode

sealed class AnchorableJavadocNode : NavigableJavadocNode

DeprecatedNode

class DeprecatedNode(val name: String, val address: DRI, val description: List<ContentNode>)

DeprecatedPage

class DeprecatedPage(val elements: Map<DeprecatedPageSection, Set<DeprecatedNode>>, sourceSet: Set<DisplaySourceSet>) : JavadocPageNode

DeprecatedPageCreator

object DeprecatedPageCreator : PageTransformer

DeprecatedPageSection

enum DeprecatedPageSection : Enum<DeprecatedPageSection>

EmptyNode

data class EmptyNode(val dri: DRI, val kind: Kind, val sourceSets: Set<DisplaySourceSet>, val extra: PropertyContainer<ContentNode> = PropertyContainer.empty()) : ContentNode

IndexGenerator

object IndexGenerator : PageTransformer

IndexPage

class IndexPage(val id: Int, val elements: List<NavigableJavadocNode>, val keys: List<Char>, sourceSet: Set<DisplaySourceSet>) : JavadocPageNode

JavaContentGroupBuilder

class JavaContentGroupBuilder(val sourceSets: Set<DisplaySourceSet>)

JavadocClasslikePageNode

class JavadocClasslikePageNode(val name: String, val content: JavadocContentNode, val dri: Set<DRI>, val signature: JavadocSignatureContentNode, val description: List<ContentNode>, val constructors: List<JavadocFunctionNode>, val methods: List<JavadocFunctionNode>, val entries: List<JavadocEntryNode>, val classlikes: List<JavadocClasslikePageNode>, val properties: List<JavadocPropertyNode>, val brief: List<ContentNode>, val documentables: List<Documentable> = emptyList(), val children: List<PageNode> = emptyList(), val embeddedResources: List<String> = listOf(), val extra: PropertyContainer<DClasslike> = PropertyContainer.empty()) : JavadocPageNode, WithJavadocExtra<DClasslike> , NavigableJavadocNode, WithNavigable, WithBrief, ClasslikePage

JavadocContentGroup

data class JavadocContentGroup(val dri: Set<DRI>, val kind: Kind, val sourceSets: Set<DisplaySourceSet>, val children: List<JavadocContentNode>) : JavadocContentNode

JavadocContentKind

enum JavadocContentKind : Enum<JavadocContentKind> , Kind

JavadocContentNode

abstract class JavadocContentNode(dri: Set<DRI>, kind: Kind, val sourceSets: Set<DisplaySourceSet>) : ContentNode

JavadocEntryNode

data class JavadocEntryNode(val dri: DRI, val name: String, val signature: JavadocSignatureContentNode, val brief: List<ContentNode>, val extra: PropertyContainer<DEnumEntry> = PropertyContainer.empty()) : AnchorableJavadocNode, WithJavadocExtra<DEnumEntry> , WithBrief

JavadocFunctionNode

data class JavadocFunctionNode(val signature: JavadocSignatureContentNode, val brief: List<ContentNode>, val description: List<ContentNode>, val parameters: List<JavadocParameterNode>, val name: String, val dri: DRI, val extra: PropertyContainer<DFunction> = PropertyContainer.empty()) : AnchorableJavadocNode, WithJavadocExtra<DFunction> , WithBrief

JavadocIndexExtra

data class JavadocIndexExtra(val index: List<ContentNode>) : ExtraProperty<Documentable>

JavadocList

interface JavadocList

JavadocListEntry

interface JavadocListEntry

JavadocModulePageNode

class JavadocModulePageNode(val name: String, val content: JavadocContentNode, val children: List<PageNode>, val dri: Set<DRI>, val extra: PropertyContainer<DModule> = PropertyContainer.empty()) : RootPageNode, WithJavadocExtra<DModule> , NavigableJavadocNode, JavadocPageNode, ModulePage

JavadocPackagePageNode

class JavadocPackagePageNode(val name: String, val content: JavadocContentNode, val dri: Set<DRI>, val documentables: List<Documentable> = emptyList(), val children: List<PageNode> = emptyList(), val embeddedResources: List<String> = listOf()) : JavadocPageNode, WithNavigable, NavigableJavadocNode, PackagePage

JavadocPageNode

interface JavadocPageNode : ContentPage, WithDocumentables

JavadocParameterNode

data class JavadocParameterNode(val dri: DRI, val name: String, val type: ContentNode, val description: List<ContentNode>, val typeBound: Bound, val extra: PropertyContainer<DParameter> = PropertyContainer.empty()) : AnchorableJavadocNode, WithJavadocExtra<DParameter>

JavadocPropertyNode

data class JavadocPropertyNode(val dri: DRI, val name: String, val signature: JavadocSignatureContentNode, val brief: List<ContentNode>, val extra: PropertyContainer<DProperty> = PropertyContainer.empty()) : AnchorableJavadocNode, WithJavadocExtra<DProperty> , WithBrief

JavadocSignatureContentNode

data class JavadocSignatureContentNode(val dri: DRI, val kind: Kind = ContentKind.Symbol, val annotations: ContentNode?, val modifiers: ContentNode?, val signatureWithoutModifiers: ContentNode, val supertypes: ContentNode?) : JavadocContentNode

LeafListNode

data class LeafListNode(val tabTitle: String, val colTitle: String, val entries: List<JavadocListEntry>, val dri: Set<DRI>, val kind: Kind, val sourceSets: Set<DisplaySourceSet>) : JavadocContentNode

LinkJavadocListEntry

class LinkJavadocListEntry(val name: String, val dri: Set<DRI>, val kind: Kind = ContentKind.Symbol, val sourceSets: Set<DisplaySourceSet>) : JavadocListEntry

NavigableJavadocNode

interface NavigableJavadocNode

ResourcesInstaller

object ResourcesInstaller : PageTransformer

RootListNode

data class RootListNode(val entries: List<LeafListNode>, val dri: Set<DRI>, val kind: Kind, val sourceSets: Set<DisplaySourceSet>) : JavadocContentNode

RowJavadocListEntry

data class RowJavadocListEntry(val link: LinkJavadocListEntry, val doc: List<ContentNode>) : JavadocListEntry

TitleNode

data class TitleNode(val title: String, val subtitle: List<ContentNode>, val version: String?, val parent: String?, val dri: Set<DRI>, val kind: Kind, val sourceSets: Set<DisplaySourceSet>) : JavadocContentNode

TreeViewInstaller

object TreeViewInstaller : PageTransformer

TreeViewPage

class TreeViewPage(val name: String, val packages: List<JavadocPackagePageNode>?, val classes: List<JavadocClasslikePageNode>?, val dri: Set<DRI>, val documentables: List<Documentable> = emptyList(), val root: PageNode) : JavadocPageNode

WithBrief

interface WithBrief

WithJavadocExtra

interface WithJavadocExtra<T : Documentable> : WithExtraProperties<T>

WithNavigable

fun interface WithNavigable

Functions

JavadocList

fun JavadocList(tabTitle: String, colTitle: String, children: List<JavadocListEntry>): JavadocList

leafList

fun JavaContentGroupBuilder.leafList(dri: Set<DRI>, kind: Kind, leafList: JavadocList)

rootList

fun JavaContentGroupBuilder.rootList(dri: Set<DRI>, kind: Kind, rootList: List<JavadocList>)

title

fun JavaContentGroupBuilder.title(title: String, subtitle: List<ContentNode>, version: String? = null, parent: String? = null, dri: Set<DRI>, kind: Kind)